Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Update releasing notes to reflect that main branch is now protected #3562

Merged
merged 2 commits into from
Aug 31, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 32 additions & 13 deletions RELEASING.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

hatch env prune

2. Make certain your branch is in sync with head:
2. Make certain your branch is in sync with head. If you work on a fork, replace `origin` with `upstream`:

git pull origin main

Expand All @@ -17,48 +17,67 @@
Navigate to http://localhost:8000 and ensure it looks OK (particularly
do a visual scan of the gallery thumbnails).

4. Update version to, e.g. 5.0.0:
4. Create a new release branch:

git switch -c version_5.0.0

5. Update version to, e.g. 5.0.0:

- in ``altair/__init__.py``
- in ``doc/conf.py``

5. Commit change and push to main:
6. Commit changes and push:

git add . -u
git commit -m "chore: Bump version to 5.0.0"
git push origin main
git push

7. Merge release branch into main, make sure that all required checks pass

6. Tag the release:
8. Tag the release:

git tag -a v5.0.0 -m "version 5.0.0 release"
git push origin v5.0.0

7. Build source & wheel distributions:
9. On main, build source & wheel distributions. If you work on a fork, replace `origin` with `upstream`:

git switch main
git pull origin main
hatch clean # clean old builds & distributions
hatch build # create a source distribution and universal wheel

8. publish to PyPI (Requires correct PyPI owner permissions):
10. publish to PyPI (Requires correct PyPI owner permissions):

hatch publish

9. build and publish docs (Requires write-access to altair-viz/altair-viz.github.io):
11. build and publish docs (Requires write-access to altair-viz/altair-viz.github.io):

hatch run doc:publish-clean-build

10. update version to, e.g. 5.1.0dev:
12. On main, tag the release. If you work on a fork, replace `origin` with `upstream`:

git tag -a v5.0.0 -m "Version 5.0.0 release"
git push origin v5.0.0

13. Create a new branch:

git switch -c maint_5.1.0dev

14. Update version and add 'dev' suffix, e.g. 5.1.0dev:

- in ``altair/__init__.py``
- in ``doc/conf.py``

11. Commit change and push to main:
15. Commit changes and push:

git add . -u
git commit -m "chore: Bump version to 5.1.0dev"
git push origin main
git push

16. Merge maintenance branch into main

12. Double-check that a conda-forge pull request is generated from the updated
17. Double-check that a conda-forge pull request is generated from the updated
pip package by the conda-forge bot (may take up to several hours):
https://github.com/conda-forge/altair-feedstock/pulls

13. Publish a new release in https://github.com/vega/altair/releases/
18. Publish a new release in https://github.com/vega/altair/releases/