Skip to content

Commit 885dd39

Browse files
Update release process notes (scikit-image#7402)
* Update release process notes * Update RELEASE.txt
1 parent 9b91d3a commit 885dd39

1 file changed

Lines changed: 30 additions & 19 deletions

File tree

RELEASE.txt

Lines changed: 30 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -126,29 +126,40 @@ Example `version number`
126126
git commit -m 'Bump version'
127127
git push origin main
128128

129-
----
130-
131-
- Once the release is completed you should update the release docs:
132-
- Edit ``doc/source/_static/docversions.js`` and commit
133-
- On the release branch, build a clean version of the docs. In the
134-
root directory, run ``pip install .``.
135-
- In the ``doc/`` directory:
136-
- Build using
137-
``make clean; make html; make gh-pages``.
138-
- Check (since this a new feature) that binder links in gallery examples
139-
point to the release branch, e.g. `0.16.x`.
140-
- In the ``gh-pages/`` directory:
141-
- Update the symlink to ``stable`` and commit.
142-
- Upload the docs: ``git push origin gh-pages`` in ``doc/gh-pages``.
129+
- Update documentation on the web:
130+
The documentation is kept in a separate repo: scikit-image/docs
131+
132+
- Wait for the CI service to deploy to GitHub Pages
133+
- Sync your branch with the remote repo: ``git pull``.
134+
- Update the docs
135+
136+
git switch gh-pages
137+
git branch -C gh-pages gh-pages-backup
138+
cp -a dev ../.
139+
git reset --hard <commit from last release>
140+
git rm -rf dev
141+
cp -a ../dev .
142+
git add dev
143+
cp -a ../dev <release name, e.g., 0.23.x>
144+
git add <release name, e.g., 0.23.x>
145+
rm stable
146+
ln -s <release name, e.g., 0.23.x> stable
147+
git add stable
148+
git commit -m "Add <release name, e.g., 0.23.x>"
149+
git push -f origin gh-pages # force push---be careful!
143150

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

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

148-
- Add release date to ``index.rst`` under "News".
149-
- Add previous stable version documentation path to disallowed paths
150-
in `robots.txt`
151-
- Commit and push (this will also build and update the website).
156+
git pull
157+
# Edit the ``News`` section of ``index.rst``
158+
git add index.rst
159+
git commit -m "Highlight ${VERSION} release"
160+
git push
161+
162+
----
152163

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

0 commit comments

Comments
 (0)