-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
81 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,46 @@ | ||
# Contributing to ESC SDK | ||
|
||
## Building from source | ||
|
||
### Prerequisites | ||
|
||
* [OpenAPI Generator](https://openapi-generator.tech/docs/installation/) | ||
|
||
### Building | ||
|
||
ESC SDK uses OpenAPI Generator to auto-generate the raw API clients from the `swagger.yaml` definition. | ||
|
||
To build the autogenerated API clients, run: | ||
|
||
```shell | ||
make generate_sdks | ||
``` | ||
|
||
Additionally, ESC SDK provides wrapper clients for TypeScript/JavaScript, Python, and Go. To build these packages, run: | ||
|
||
```shell | ||
make build_typescript | ||
make build_python | ||
make build_go | ||
``` | ||
|
||
## Submitting a Pull Request | ||
|
||
For contributors we use the [standard fork based workflow](https://gist.github.com/Chaser324/ce0505fbed06b947d962): Fork this repository, create a topic branch, and when ready, open a pull request from your fork. | ||
|
||
## Creating a Release | ||
|
||
This section is for Pulumi employees only. | ||
|
||
To release a new version of the provider, follow steps below: | ||
- Create a release commit by updating `.version` and running `make generate_sdks` ([example](https://github.com/pulumi/esc-sdk/pull/61)) | ||
- Run release commands, replacing `X.XX.XX` with your new version. | ||
``` | ||
git checkout main | ||
git pull | ||
git tag sdk/vX.XX.XX | ||
git tag vX.XX.XX | ||
git push origin vX.XX.XX | ||
git push origin sdk/vX.XX.XX | ||
``` | ||
- Github Actions will automatically build, test and then publish the new release to all the various package managers |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters