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
78
79
80
81
82
83
|
1. Create a new virtual environment following the instructions in `CONTRIBUTING.md`.
Make sure to also install all dependencies for the documentation including `altair_saver`
and uninstall `vl-convert-python` (this is not needed for normal contributions to the repo, see `CONTRIBUTING.md` for details).
2. Make certain your branch is in sync with head:
git pull upstream master
3. Do a clean doc build:
hatch run doc:clean-all
hatch run doc:build-html
hatch run doc:serve
Navigate to http://localhost:8000 and ensure it looks OK (particularly
do a visual scan of the gallery thumbnails).
4. Make sure changes.rst is up to date for the release: compare against PRs
merged since the last release & update top heading with release date.
5. Update version to, e.g. 5.0.0:
- in ``altair/__init__.py``
- in ``doc/conf.py`` (two places)
6. Double-check that all vega-lite/vega/vega-embed versions are up-to-date:
- URLs in ``doc/conf.py``
- versions in ``altair/vegalite/v5/display.py``
7. Commit change and push to master:
git add . -u
git commit -m "MAINT: bump version to 5.0.0"
git push upstream master
8. Tag the release:
git tag -a v5.0.0 -m "version 5.0.0 release"
git push upstream v5.0.0
9. Build source & wheel distributions:
hatch clean # clean old builds & distributions
hatch build # create a source distribution and universal wheel
10. publish to PyPI (Requires correct PyPI owner permissions):
hatch publish
11. build and publish docs (Requires write-access to altair-viz/altair-viz.github.io):
hatch run doc:publish-clean-build
12. update version to, e.g. 5.1.0dev:
- in ``altair/__init__.py``
- in ``doc/conf.py`` (two places)
13. add a new changelog entry for the unreleased version:
Version 5.1.0 (unreleased)
--------------------------
Enhancements
~~~~~~~~~~~~
Bug Fixes
~~~~~~~~~
Backward-Incompatible Changes
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
14. Commit change and push to master:
git add . -u
git commit -m "MAINT: bump version to 5.1.0dev"
git push upstream master
15. Double-check that a conda-forge pull request is generated from the updated
pip package by the conda-forge bot (may take up to ~an hour):
https://github.com/conda-forge/altair-feedstock/pulls
16. Copy changes.rst section into release notes within
https://github.com/altair-viz/altair/releases/, and publish the release.
|
