Skip to content

Commit

Permalink
docs: reviewer and maintainer responsibilities with automated release…
Browse files Browse the repository at this point in the history
…s and PRs
  • Loading branch information
aryarm authored Jan 7, 2024
1 parent c921fe4 commit 7762d87
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 3 deletions.
7 changes: 4 additions & 3 deletions PUBLISHING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,10 @@ Publishing Steps

To publish a new version of trtools:

1. First, locate the most recent PR prefixed "chore(main)" created by our Github actions bot
2. List a maintainer of our repository (@gymrek-lab/trtools) as a reviewer of the PR and ask them to merge it
3. The bot will automatically create a new version on PyPI and tag a release on Github
1. First, locate the most recent *release PR* prefixed "chore(main)" created by our Github actions bot
2. List a maintainer of our repository (@gymrek-lab/trtools) as a reviewer of the PR
3. The maintainer may edit the auto-generated text-body of the PR release to incorporate additional details from the underlying PRs, if needed
4. Once merged, the bot will automatically create a new version on PyPI and tag a release on Github

Lastly, the change needs to be published to bioconda.

Expand Down
2 changes: 2 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -172,6 +172,8 @@ We appreciate contributions to TRTools. If you would like to contribute a fix or
#. Submit a pull request (PR) **to the master branch** of the central repository with a description of what changes you have made. Title the PR according to the `conventional commits spec <https://www.conventionalcommits.org>`_.
A member of the TRTools team will reply and continue the contribution process from there, possibly asking for additional information/effort on your part.

* If you are reviewing a pull request, please double-check that the PR addresses each item in `our PR checklist <https://github.com/gymrek-lab/TRTools/blob/master/.github/pull_request_template.md>`_

Publishing
----------
If you are a TRTools maintainer and wish to publish changes and distribute them to PyPI and bioconda, please see PUBLISHING.rst in the root of the git repo.
Expand Down

0 comments on commit 7762d87

Please sign in to comment.