-
-
Notifications
You must be signed in to change notification settings - Fork 159
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #2123 from martinholmer/releasing-docs
Add RELEASING.md documentation
- Loading branch information
Showing
1 changed file
with
66 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,66 @@ | ||
RELEASING TAX-CALCULATOR CONDA PACKAGES | ||
======================================= | ||
|
||
``` | ||
... on branch X-Y-Z, edit RELEASES.md to finalize X.Y.Z info | ||
... merge master branch into X-Y-Z branch | ||
... edit "version = 'X.Y.Z'" in read-the-docs/source/conf.py | ||
... run `make pytest-all` [or `pytest -m pre_release -n4` in taxcalc] | ||
... run `make package` [so that tc CLI is available] | ||
... cd docs/cookbook ; python test_recipes.py ; .fix. ; python make_cookbook.py | ||
... cd .. ; ./index_results.sh ; .fix. | ||
... edit "What's New" section of index.htmx ; python make_index.py | ||
... cd .. ; make clean [to remove local taxcalc package] | ||
... commit X-Y-Z branch and push to origin | ||
... merge X-Y-Z branch into master branch on GitHub | ||
... on local master branch, ./gitsync | ||
... create release X.Y.Z on GitHub using master branch | ||
... create packages using `pbrelease Tax-Calculator taxcalc X.Y.Z` command | ||
... email policybrain-modelers list about the new release and packages | ||
``` | ||
|
||
LATER: create new X-Y-Z branch that will hold RELEASES.md info for next release | ||
|
||
|
||
|
||
CREATING NEW BRANCH TO FIX BUG IN OLD RELEASE | ||
============================================= | ||
|
||
Useful when tip of master branch includes major changes since old release. | ||
|
||
EXAMPLE: fix bug in release 1.4.0 and then release 1.4.1 | ||
|
||
``` | ||
$ cd ~/work/PSL/Tax-Calculator | ||
$ git checkout master | ||
$ git checkout -b 1-4-1 1.4.0 | ||
... fix bug on branch 1-4-1, test, commit bug fix | ||
$ git push upstream 1-4-1 | ||
... create release 1.4.1 using GitHub releases GUI citing branch 1-4-1 | ||
... then in order to merge bug-fix into master branch and future releases | ||
beginning with 1.5.0, do the following: | ||
$ git checkout master | ||
$ git merge 1-4-1 | ||
``` |