Skip to content

Commit

Permalink
Update releasing_guide.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ericpre committed Dec 12, 2023
1 parent e553396 commit 50e2194
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions releasing_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,22 +5,19 @@ Cut a Release
Create a PR to the `RELEASE_next_patch` branch and go through the following steps:

**Preparation**
- Bump version in `hyperspy/Release.py`
- Update and check changelog in `CHANGES.rst`: run `towncrier build` (to preview, run `towncrier build --draft`)
- (optional) check conda-forge and wheels build. Pushing a tag to a fork will run the release workflow without uploading to pypi
- Let that PR collect comments for a day to ensure that other maintainers are comfortable with releasing

**Tag and release**
:warning: this is a point of no return point :warning:
- push tag (`vx.y.z`) to the upstream repository and the following will be triggered:
- build of the wheels and their upload to pypi
- creation of a zenodo record and the mining of a DOI
- creation of a Github Release
- build of the wheels and their upload to pypi
- update of the current version on readthedocs to this release

**Post-release action**
- Increment the version and set it back to dev: `vx.y.z.dev0`
- Update version in other branches when necessary
- Merge the PR

Follow-up
Expand All @@ -29,3 +26,8 @@ Follow-up
- Tidy up and close corresponding milestone
- A PR to the conda-forge feedstock will be created by the conda-forge bot

Additional information
======================

The version is defined by ``setuptools_scm`` at build time when packaging HyperSpy. In an editable installation (when using ``pip install -e .``), the version is defined from the
git repository.

0 comments on commit 50e2194

Please sign in to comment.