Skip to content

Commit

Permalink
Document how to release and add changelog entries
Browse files Browse the repository at this point in the history
Fixes #732
  • Loading branch information
asmacdo committed Feb 15, 2024
1 parent 0e92ac3 commit 9530dd7
Showing 1 changed file with 23 additions and 1 deletion.
24 changes: 23 additions & 1 deletion CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -51,11 +51,33 @@ If you are unsure what that means, here is a set-up workflow you may wish to fol

git push -u origin topic_of_your_contribution


(If any of the above seems overwhelming, you can look up the `Git documentation
<http://git-scm.com/documentation>`_ on the web.)


Releases and Changelog
----------------------

Heudiconv uses the `auto <https://intuit.github.io/auto/>`_ tool to generate the changelog and automatically release the project.

`auto` is used in the heudiconv github actions, which monitors the labels on the pull request.
Heudiconv automation can add entries to the changelog, cut releases, and
push new images to `dockerhub <https://hub.docker.com/r/nipy/heudiconv>`_.

The following pull request labels are respected:

* major: Increment the major version when merged
* minot: Increment the minot version when merged
* patch: Increment the patch version when merged
* skip-release: Preserve the current version when merged
* release: Create a release when this pr is merged
* internal: Changes only affect the internal API
* documentation: Changes only affect the documentation
* tests: Add or improve existing tests
* dependencies: Update one or more dependencies version
* performance: Improve performance of an existing feature


Development environment
-----------------------

Expand Down

0 comments on commit 9530dd7

Please sign in to comment.