-
Notifications
You must be signed in to change notification settings - Fork 56
Add releasing notes #181
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.
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
Add releasing notes #181
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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,22 @@ | ||
| # Releasing | ||
|
|
||
| 1. Determine the next version. | ||
| We follow [semantic versioning](https://semver.org/). | ||
| 2. Create a release branch named `release/vX.Y.Z`, where `X.Y.Z` is the next version. | ||
| 3. Update [version.py](pystac_client/version.py) with the new version. | ||
| 4. Update [CHANGELOG.md](CHANGELOG.md). | ||
| 1. Add a new header under "Unreleased" with the new version and the date, e.g. `## [vX.Y.Z] - YYYY-MM-DD`. | ||
| 2. Audit the changelog section to ensure all changes are captured. | ||
| 3. Add a new link reference at the bottom of the changelog with the new version. | ||
| Follow the format from the previous version links. | ||
| 4. Update the "Unreleased" link to reference your new version. | ||
| 5. (optional) Build the package locally and inspect its contents: `pip install build && python -m build` | ||
| 6. Open a pull request for your `release/vX.Y.Z` branch against the appropriate branch (either `main` or a version branch, e.g. `v0.3`). | ||
| Include a section in the pull request description with the CHANGELOG contents for this version. | ||
| 7. After pull request merge, create an annotated tag for your version, e.g. `git tag -a vX.Y.Z`. | ||
| The contents of the annotated tag should be the contents of the changelog for this version. | ||
| Make sure to remove any leading `#` characters, as they will be considered comments in the git tag body. | ||
| 8. Push the tag. | ||
| This will trigger [the Github release workflow](.github/workflows/release.yml) and publish to PyPI. | ||
| 9. [Create a new release on Github](https://github.com/stac-utils/pystac-client/releases/new) pointing to the new tag. | ||
| Include the CHANGELOG notes from this version. | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.