-
Notifications
You must be signed in to change notification settings - Fork 796
/
Copy pathRELEASING.md
77 lines (46 loc) · 2.52 KB
/
RELEASING.md
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
1. Check all [Vega project](https://github.com/orgs/vega/repositories?type=source) versions are up-to-date. See [NOTES_FOR_MAINTAINERS.md](NOTES_FOR_MAINTAINERS.md)
2. Make sure to have [set up your environment](CONTRIBUTING.md#setting-up-your-environment).
Update your environment with the latest dependencies:
uv sync --all-extras
3. Make certain your branch is in sync with head, and that you have no uncommitted modifications. If you work on a fork, replace `origin` with `upstream`:
git checkout main
git pull origin main
git status # Should show "nothing to commit, working tree clean"
4. Do a [clean doc build](CONTRIBUTING.md#building-the-documentation-locally):
Navigate to http://localhost:8000 and ensure it looks OK (particularly
do a visual scan of the gallery thumbnails).
5. Create a new release branch:
git switch -c version_5.0.0
6. Update version to, e.g. 5.0.0:
- in ``altair/__init__.py``
- in ``doc/conf.py``
7. Commit changes and push:
git add . -u
git commit -m "chore: Bump version to 5.0.0"
git push
8. Merge release branch into main, make sure that all required checks pass
9. Switch to main, If you work on a fork, replace `origin` with `upstream`:
git switch main
git pull origin main
10. Build a source distribution and universal wheel,
publish to PyPI (Requires correct PyPI owner permissions and [UV_PUBLISH_TOKEN](https://docs.astral.sh/uv/configuration/environment/#uv_publish_token)):
uv run task publish
11. Build and publish docs (Requires write-access to [altair-viz/altair-viz.github.io](https://github.com/altair-viz/altair-viz.github.io)):
uv run task doc-publish-clean-build
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``
15. Commit changes and push:
git add . -u
git commit -m "chore: Bump version to 5.1.0dev"
git push
16. Merge maintenance branch into main
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
18. Publish a new release in https://github.com/vega/altair/releases/