Skip to content

Commit 188e79d

Browse files
sbarzowskisparkprime
authored andcommitted
Add updating documentation to the release checklist
1 parent f5d89ed commit 188e79d

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

release_checklist.md

+5-3
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# Checklist for building Jsonnet releases
2-
2+
33
## Are jsonnet & go-jsonnet in sync?
44
1) Check out master from both
55
1) Check go-jsonnet/cpp-jsonnet submodule is HEAD of jsonnet tree, if not:
@@ -22,6 +22,8 @@
2222
find test_cmd -name '*.cpp' -o -name '*.golang' -o -name '*.stdout' -o -name '*.stderr' -o -name 'stdout' -o -name 'stderr' | \
2323
xargs sed -i 's/ v0[.][0-9.]*/ NEW_VERSION_GOES_HERE/g'
2424
```
25+
1) Check if any changes to the documentation are necessary by checking commits since previous release (especially stdlib additions).
26+
1) In stdlib documentation replace any "Available in upcoming release." with "Available since NEW_VERSION_GOES_HERE".
2527
1) `python setup.py build sdist`
2628
1) `twine upload dist/whatever.tar.gz` (Needs credentials on pypi)
2729
1) ON ANOTHER MACHINE AND CHECK THAT THE VERSION IS CORRECT AND IT ACTUALLY IS BUILDING THINGS IN THE LOG: `sudo pip install jsonnet --pre --upgrade`
@@ -36,10 +38,10 @@ find test_cmd -name '*.cpp' -o -name '*.golang' -o -name '*.stdout' -o -name '*.
3638
1) Remove -pre from version in `include/libjsonnet.h`
3739
1) Update version in `CMakeLists.txt`
3840
1) Update `test_cmd` golden file version numbers
39-
1) run test again!
41+
1) run test again!
4042
1) commit and push
4143
1) Make release in github, write release notes by checking commits since previous release
4244
1) `python setup.py build sdist`
4345
1) `twine upload dist/whatever.tar.gz` (the version without the -pre)
4446
1) Post to Jsonnet Google Group
45-
47+
1) Update the live version of the website

0 commit comments

Comments
 (0)