Skip to content

Commit

Permalink
Update docs on releasing (#124)
Browse files Browse the repository at this point in the history
  • Loading branch information
tomvothecoder authored Oct 7, 2021
1 parent afd2339 commit 21dad38
Showing 1 changed file with 6 additions and 5 deletions.
11 changes: 6 additions & 5 deletions docs/project_maintenance.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,24 +9,25 @@ This page covers tips for project maintenance.
Releasing a New Version
-----------------------

1. Add updates to HISTORY.rst
2. Checkout the latest ``main`` branch.
3. Checkout a branch with the name of the version.
1. Checkout the latest ``main`` branch.
2. Checkout a branch with the name of the version.

::

# Prepend "v" to <version>
# For release candidates, append "rc" to <version>
git checkout -b v<version> -t origin/<version>
git checkout -b v<version>
git push --set-upstream origin v<version>

4. Bump version using tbump.
3. Bump version using tbump.

::

# Exclude "v" and <version> should match step 2
# --no-tag is required since tagging is handled in step 5.
tbump <version> --no-tag

4. Add updates to ``HISTORY.rst``
5. Create a pull request to the main repo and merge it.
6. Create a GitHub release.
7. Open a PR to the xcdat conda-forge feedstock with the latest changes.
Expand Down

0 comments on commit 21dad38

Please sign in to comment.