Skip to content

Latest commit

 

History

History
24 lines (22 loc) · 1.86 KB

release.md

File metadata and controls

24 lines (22 loc) · 1.86 KB
Raw

How to make a release

  1. Change version number and doc dropdown options. E.g. 46104c8
    1. Change the version number from 0.0.X dev to 0.0.X in mne-nirs/mne_nirs/_version.py
    2. Add new version to mne-nirs/doc/conf.py by changing html_context, versions_dropdown. Remove the stable tag from previous version and add this version as 'v0.0.X': 'v0.0.X (stable)',
    3. Modify the changelog.md and rename the -dev from most recent changes
  2. Push change and wait for PR checks to go green.
  3. Merge PR and wait for checks to go green.
  4. Clone main branch locally. git clone git@github.com:mne-tools/mne-nirs.git
  5. Create release locally by
    1. pip install twine
    2. rm -rf dist
    3. python setup.py sdist
    4. twine upload dist/*
  6. Create a release in GitHub interface which also creates a git tag
  7. Bump version to dev naming and regenerate docs (e.g. 6393b6dfc6).
    1. Change the version number from 0.0.X to 0.0.X+1 dev in mne-nirs/mne_nirs/_version.py
    2. Set docs to build all versions in conf.py by setting smv_tag_whitelist = r'^v\d+\.\d+.\d+$'
  8. Commit which rebuild all docs
  9. Set docs to build current version only in conf.py by setting smv_tag_whitelist = None
  10. Commit

Done!