Skip to content

Commit

Permalink
Update release process notes (#7402)
Browse files Browse the repository at this point in the history
* Update release process notes

* Update RELEASE.txt
  • Loading branch information
jarrodmillman committed Apr 22, 2024
1 parent 9b91d3a commit 885dd39
Showing 1 changed file with 30 additions and 19 deletions.
49 changes: 30 additions & 19 deletions RELEASE.txt
Original file line number Diff line number Diff line change
Expand Up @@ -126,29 +126,40 @@ Example `version number`
git commit -m 'Bump version'
git push origin main

----

- Once the release is completed you should update the release docs:
- Edit ``doc/source/_static/docversions.js`` and commit
- On the release branch, build a clean version of the docs. In the
root directory, run ``pip install .``.
- In the ``doc/`` directory:
- Build using
``make clean; make html; make gh-pages``.
- Check (since this a new feature) that binder links in gallery examples
point to the release branch, e.g. `0.16.x`.
- In the ``gh-pages/`` directory:
- Update the symlink to ``stable`` and commit.
- Upload the docs: ``git push origin gh-pages`` in ``doc/gh-pages``.
- Update documentation on the web:
The documentation is kept in a separate repo: scikit-image/docs

- Wait for the CI service to deploy to GitHub Pages
- Sync your branch with the remote repo: ``git pull``.
- Update the docs

git switch gh-pages
git branch -C gh-pages gh-pages-backup
cp -a dev ../.
git reset --hard <commit from last release>
git rm -rf dev
cp -a ../dev .
git add dev
cp -a ../dev <release name, e.g., 0.23.x>
git add <release name, e.g., 0.23.x>
rm stable
ln -s <release name, e.g., 0.23.x> stable
git add stable
git commit -m "Add <release name, e.g., 0.23.x>"
git push -f origin gh-pages # force push---be careful!

- Update the web frontpage:
The webpage is kept in a separate repo: scikit-image/skimage-web

The webpage source is kept in a separate repo: `scikit-image-web`.
- Highlight new release in the news section

- Add release date to ``index.rst`` under "News".
- Add previous stable version documentation path to disallowed paths
in `robots.txt`
- Commit and push (this will also build and update the website).
git pull
# Edit the ``News`` section of ``index.rst``
git add index.rst
git commit -m "Highlight ${VERSION} release"
git push

----

- Post release notes on user & dev forums, blog, Twitter, etc.

Expand Down

0 comments on commit 885dd39

Please sign in to comment.