Skip to content

Commit

Permalink
reinstate original authors list and clarify tagging
Browse files Browse the repository at this point in the history
  • Loading branch information
aryarm committed Nov 8, 2023
1 parent d82ed73 commit 2362461
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 13 deletions.
12 changes: 6 additions & 6 deletions PUBLISHING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -31,29 +31,29 @@ If you've added dependencies to trtools or its tests, those dependencies should
Publishing Steps
----------------

Once changes have been made to develop that are ready to be published, first choose the new version number. Then set up the environment you're going to publish TRTools from:
Once changes have been made to develop that are ready to be published, first choose the new version number according to `semantic versioning <https://semver.org>`_. Then set up the environment you're going to publish TRTools from:

#. Create a clean environment.
#. Install setuptools with version >= 40.8.0
#. Additionally, install ``pytest``, ``wheel`` and ``twine``
#. Clone the `trtools repo <https://github.com/gymreklab/TRTools>`_
#. Additionally, install ``pytest``, ``wheel``, ``build``, and ``twine``
#. Clone the `trtools repo <https://github.com/gymrek-lab/TRTools>`_
#. Check out the develop branch
#. Run :code:`pip install --upgrade pip && pip install -e .`

Then go through the steps of merging the changes into the master branch:

#. Run :code:`pytest` and make sure all the tests pass. Then run :code:`./test/cmdline_tests.sh` and make sure those tests pass.
#. Change the 'Unreleased Changes' section of :code:`RELEASE_NOTES.rst` to the new version number.
#. Check if any changes have been made that have not yet been documented in the release notes. If so, document them.
#. Run :code:`pytest` and make sure all the tests pass. Then run :code:`./test/cmdline_tests.sh` and make sure those tests pass.
#. Submit a pull request from develop into master on the github webiste.
#. If the code review checks pass, merge the pull request.
#. Tag the merge commit with the package version in vX.Y.Z format. (For more details on tagging, see `below`)

Then go through the steps of publishing the changed code to PyPI:

1. :code:`cd` into the root of your clone of the trtools repo, checkout master and pull the latest change.
1. :code:`cd` into the root of your clone of the trtools repo, checkout master and pull the latest change. Note that the most recent commit *must* be tagged.
2. Run :code:`rm -rf build dist *.egg-info` to make sure all previous build artifacts are removed
3. Run :code:`python -m build` to build the package with the version number you just tagged. (Note: you might need to run :code:`pip install build` to install ``build`` first.)
3. Run :code:`python -m build` to build the package with the version number you just tagged. (Note: you might need to install ``build`` first.)
5. Run :code:`twine upload dist/*` to upload the distribution to PyPI

Lastly, the change needs to be published to bioconda.
Expand Down
8 changes: 1 addition & 7 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,6 @@ build-backend = "setuptools.build_meta"
name = "trtools"
authors = [
{name = "Melissa Gymrek", email = "[email protected]"},
{name = "Nima Mousavi"},
{name = "Jonathan Margoliash"},
{name = "Aarushi Sehgal"},
{name = "Andrew Shen"},
{name = "Neha Pusarla"},
{name = "Shubham Saini"},
{name = "Richard Yanicky"},
]
description = "Toolkit for genome-wide analysis of STRs"
readme = "README.rst"
Expand Down Expand Up @@ -44,6 +37,7 @@ script-files = ["trtools/testsupport/test_trtools.sh", "scripts/trtools_prep_bea
license-files = ["LICENSE.txt"]

[tool.setuptools_scm]
# generated automatically by setuptools when running pip install -e or python -m build
version_file = "trtools/version.py"

[project.scripts]
Expand Down

0 comments on commit 2362461

Please sign in to comment.