-
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
mkrause
committed
Nov 29, 2024
1 parent
3e5911d
commit 94fcc2c
Showing
1 changed file
with
28 additions
and
0 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,28 @@ | ||
|
||
# Contributing | ||
|
||
## Code of Conduct | ||
|
||
Please see `./CODE_OF_CONDUCT.md`. | ||
|
||
|
||
## Release workflow | ||
|
||
To create a new release: | ||
|
||
- Submit a release PR targeting the `master` branch: | ||
- Bumps the version in `package.json`. | ||
- Run `npm install` to update the `package-lock.json`. | ||
- The commit message should be of the form "Release vx.y.z" | ||
- The title of the release PR should be of the form "Release vx.y.z" | ||
|
||
- Once the PR is merged, create a new release: | ||
- Go the GitHub repo, and navigate to ["Releases"](https://github.com/fortanix/openapi-to-effect/releases). | ||
- Click ["Draft a new release"](https://github.com/fortanix/openapi-to-effect/releases/new). | ||
- Under "Choose a new tag", create a new tag of the form `vx.y.z`. | ||
- The name of the release should be of the form `vx.y.z`. | ||
- Write the release notes. | ||
- If the version is a pre-release, mark it as such. | ||
- Hit "Publish the release". | ||
|
||
- Once the release has been created, a GitHub Actions workflow will automatically run to publish this release to npm. |