From cab3ad1078fe592ebf6b948caf3c8101c0959fa1 Mon Sep 17 00:00:00 2001 From: Bradley Dice Date: Tue, 28 Jan 2025 09:51:41 -0600 Subject: [PATCH] Add release process guide. (#123) This PR adds some docs for the release process. --------- Co-authored-by: jakirkham --- CONTRIBUTING.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 97a3982d..212e95cd 100644 --- 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..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 +``` +- For the tag annotation, paste the same changelog as above, like this: +``` +v + +- ... (bullet points on release items) +``` +- Push the tag: +``` +git push git@github.com:rapidsai/pynvjitlink.git v +``` + ## Attribution Portions adopted from https://github.com/pytorch/pytorch/blob/master/CONTRIBUTING.md