Skip to content

Commit

Permalink
Merge pull request #95 from thewtex/release-docs
Browse files Browse the repository at this point in the history
DOC: Add Create a release docs
  • Loading branch information
thewtex authored Nov 5, 2024
2 parents 8451edb + 315481c commit b5535e9
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -188,6 +188,24 @@ which is available in the web3.storage web page interface.

We use the standard [GitHub flow].

### Create a release

This section is relevant only for maintainers.

1. Pull `git`'s `main` branch.
2. `pixi install -a`
3. `pixi run pre-commit-install`
4. `pixi run -e test test`
5. `pixi shell`
6. `hatch version <new-version>`
7. `git add .`
8. `git commit -m "ENH: Bump version to <version>"`
9. `hatch build`
10. `hatch publish`
11. `git push upstream main`
12. Create a new tag and Release via the GitHub UI. Auto-generate release notes
and add additional notes as needed.

[spatial-image]: https://github.com/spatial-image/spatial-image
[Xarray]: https://xarray.pydata.org/en/stable/
[OME-NGFF]: https://ngff.openmicroscopy.org/
Expand Down

0 comments on commit b5535e9

Please sign in to comment.