Skip to content

Commit

Permalink
Add release process guide.
Browse files Browse the repository at this point in the history
  • Loading branch information
bdice committed Jan 27, 2025
1 parent 3011cce commit 041a3fd
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 rapidsai v<VERSION>
```

## Attribution
Portions adopted from https://github.com/pytorch/pytorch/blob/master/CONTRIBUTING.md

0 comments on commit 041a3fd

Please sign in to comment.