Skip to content

Commit

Permalink
Update release-procedure to reflect changes from GH grackle-project#181.
Browse files Browse the repository at this point in the history
  • Loading branch information
mabruzzo committed May 17, 2024
1 parent 5e00187 commit a3a92f2
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions doc/source/Contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -32,15 +32,17 @@ To create a new release:
(i) Commit A (the first commit) is the final commit included in the release. It should:

- update the changelog
- update the version number of the c-library. This is currently tracked in with `src/clib/Make.config.assemble` **AND** (for documentation purposes) in `doc/source/conf.py`
- update the version number of the c-library. This is currently tracked within the ``VERSION`` file (that can be found at the root level of the repository)
- update the version number of the python module (stored internally in `src/python/setup.py`)

(ii) Commit B (the second commit) is the first commit for the next version.
It should just update the version number of the c-library to specify the next development version

- like before, this must be updated in `src/clib/Make.config.assemble` **and** `doc/source/conf.py`
- like before, this must be updated in the ``VERSION`` file (that can be found at the root level of the repository)
- do **NOT** touch anything else (even the python version number)



3. After the PR is merged, perform the release on GitHub.
Make sure to associate the release (and the new tag) with Commit A (not with Commit B).

Expand Down

0 comments on commit a3a92f2

Please sign in to comment.