Add release process guide. (#123)

This PR adds some docs for the release process. --------- Co-authored-by: jakirkham <[email protected]>
rapidsai · Jan 28, 2025 · cab3ad1 · cab3ad1
1 parent 3011cce
commit cab3ad1
Showing 1 changed file with 23 additions and 0 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -49,5 +49,28 @@ contributing to. Start with _Step 3_ from above, commenting on the issue to let
 others know you are working on it. If you have any questions related to the
 implementation of the issue, ask them in the issue instead of the PR.
 
+## Releases
+
+The release process for pynvjitlink involves the following steps:
+
+- Open a PR to update `pynvjitlink/VERSION` to the desired version.
+- Generate a short changelog with `git log v<PREVIOUS_VERSION>..HEAD --oneline --pretty=format:"- %s"`
+- Put the changelog in the version update PR description.
+- Once `main` is updated, tag the release:
+```
+git checkout main && git pull
+git tag -a v<VERSION>
+```
+- For the tag annotation, paste the same changelog as above, like this:
+```
+v<VERSION>
+
+- ... (bullet points on release items)
+```
+- Push the tag:
+```
+git push [email protected]:rapidsai/pynvjitlink.git v<VERSION>
+```
+
 ## Attribution
 Portions adopted from https://github.com/pytorch/pytorch/blob/master/CONTRIBUTING.md