Skip to content

Update build instructions to include a specific version for oapi-codegen #183

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Sep 12, 2023
Merged

Update build instructions to include a specific version for oapi-codegen #183

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b889859
Update build instructions to include a specific version for oapi-codegen
kim-tsao Sep 12, 2023
58f8216
Address review comments
kim-tsao Sep 12, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,14 @@ Issue tracking repo: https://github.com/devfile/api with label area/registry

## Build

### Prerequisite

The current release relies on [oapi-codegen 1.12.4](https://github.com/deepmap/oapi-codegen/tree/v1.12.4). See the [Index Server README](index/server/README.md) for more information.
Copy link
Member

@michael-valdron michael-valdron Sep 12, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this should refer to source generation.

Suggested change
The current release relies on [oapi-codegen 1.12.4](https://github.com/deepmap/oapi-codegen/tree/v1.12.4). See the [Index Server README](index/server/README.md) for more information.
The current release relies on [oapi-codegen 1.12.4](https://github.com/deepmap/oapi-codegen/tree/v1.12.4) for OpenAPI source generation. See the [Index Server README](index/server/README.md#source-generation) for more information.


To install, run:
`go install github.com/deepmap/oapi-codegen/cmd/[email protected]`

### Instructions
If you want to run the build scripts with Podman, set the environment variable
`export USE_PODMAN=true`

Expand Down