You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* update RELEASING.md:
- Remove redundant tag step
- Explicitly checkout main and check working tree
- Normalize indentation of CLI commands
* Add expression docstring links to expr class docstring so sphinx finds them
* Add raw_enabled for :raw-html: directive
* Add Generic link
* format
* update user guide with link
* fix raw-html render
* bump version to 5.5.0
* expand urls
* Fix _continuous uniform probability distribution URL
Copy file name to clipboardExpand all lines: RELEASING.md
+28-31Lines changed: 28 additions & 31 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,24 +2,26 @@
2
2
Remove any existing environments managed by `hatch` so that it will create new ones
3
3
with the latest dependencies when executing the commands further below:
4
4
5
-
hatch env prune
5
+
hatch env prune
6
6
7
-
2. Make certain your branch is in sync with head. If you work on a fork, replace `origin` with `upstream`:
7
+
2. 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`:
8
8
9
-
git pull origin main
9
+
git checkout main
10
+
git pull origin main
11
+
git status # Should show "nothing to commit, working tree clean"
10
12
11
13
3. Do a clean doc build:
12
14
13
-
hatch run doc:clean-all
14
-
hatch run doc:build-html
15
-
hatch run doc:serve
15
+
hatch run doc:clean-all
16
+
hatch run doc:build-html
17
+
hatch run doc:serve
16
18
17
19
Navigate to http://localhost:8000 and ensure it looks OK (particularly
18
20
do a visual scan of the gallery thumbnails).
19
21
20
22
4. Create a new release branch:
21
23
22
-
git switch -c version_5.0.0
24
+
git switch -c version_5.0.0
23
25
24
26
5. Update version to, e.g. 5.0.0:
25
27
@@ -28,56 +30,51 @@
28
30
29
31
6. Commit changes and push:
30
32
31
-
git add . -u
32
-
git commit -m "chore: Bump version to 5.0.0"
33
-
git push
33
+
git add . -u
34
+
git commit -m "chore: Bump version to 5.0.0"
35
+
git push
34
36
35
37
7. Merge release branch into main, make sure that all required checks pass
36
38
37
-
8. Tag the release:
38
-
39
-
git tag -a v5.0.0 -m "version 5.0.0 release"
40
-
git push origin v5.0.0
41
-
42
-
9. On main, build source & wheel distributions. If you work on a fork, replace `origin` with `upstream`:
39
+
8. On main, build source & wheel distributions. If you work on a fork, replace `origin` with `upstream`:
43
40
44
-
git switch main
45
-
git pull origin main
46
-
hatch clean # clean old builds & distributions
47
-
hatch build # create a source distribution and universal wheel
41
+
git switch main
42
+
git pull origin main
43
+
hatch clean # clean old builds & distributions
44
+
hatch build # create a source distribution and universal wheel
48
45
49
-
10. publish to PyPI (Requires correct PyPI owner permissions):
46
+
9. publish to PyPI (Requires correct PyPI owner permissions):
50
47
51
48
hatch publish
52
49
53
-
11. build and publish docs (Requires write-access to altair-viz/altair-viz.github.io):
50
+
10. build and publish docs (Requires write-access to altair-viz/altair-viz.github.io):
54
51
55
52
hatch run doc:publish-clean-build
56
53
57
-
12. On main, tag the release. If you work on a fork, replace `origin` with `upstream`:
54
+
11. On main, tag the release. If you work on a fork, replace `origin` with `upstream`:
58
55
59
-
git tag -a v5.0.0 -m "Version 5.0.0 release"
60
-
git push origin v5.0.0
56
+
git tag -a v5.0.0 -m "Version 5.0.0 release"
57
+
git push origin v5.0.0
61
58
62
-
13. Create a new branch:
59
+
12. Create a new branch:
63
60
64
61
git switch -c maint_5.1.0dev
65
62
66
-
14. Update version and add 'dev' suffix, e.g. 5.1.0dev:
63
+
13. Update version and add 'dev' suffix, e.g. 5.1.0dev:
67
64
68
65
- in ``altair/__init__.py``
69
66
- in ``doc/conf.py``
70
67
71
-
15. Commit changes and push:
68
+
14. Commit changes and push:
72
69
73
70
git add . -u
74
71
git commit -m "chore: Bump version to 5.1.0dev"
75
72
git push
76
73
77
-
16. Merge maintenance branch into main
74
+
15. Merge maintenance branch into main
78
75
79
-
17. Double-check that a conda-forge pull request is generated from the updated
76
+
16. Double-check that a conda-forge pull request is generated from the updated
80
77
pip package by the conda-forge bot (may take up to several hours):
0 commit comments