Skip to content

Commit

Permalink
docs: update release instructions (#10)
Browse files Browse the repository at this point in the history
  • Loading branch information
fernandobrito authored May 2, 2022
1 parent 9b5de7e commit 3042899
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -237,6 +237,17 @@ $ cat target/manifest.json | jq > $PROJECT_ROOT/tests/_fixtures/manifest.json
We are open and would love to have contributions, both in Pull Requests but also in ideas and feedback. Don't hesitate
to create an Issue on this repository if you are trying this project in your organization or have anything to share.

## Release

There is a GitHub Action that will trigger a release of this package on PyPI based on releases created on GitHub.
Steps:

* Loosely follow [semantic versioning](https://semver.org/)
* Remember to pretend the tag name with `v`
* Use the tag name as the release title on GitHub
* Use the auto-generated release notes from GitHub
* Append a link at the end of the release notes to the released version on PyPI

## License

This project is licensed under the Apache License, Version 2.0: http://www.apache.org/licenses/LICENSE-2.0.

0 comments on commit 3042899

Please sign in to comment.