Skip to content

Add commit step before tagging to internal.md. #334

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
yujiahu415 merged 1 commit into from
Jan 9, 2026
Merged

Add commit step before tagging to internal.md. #334

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 18 additions & 5 deletions docs/contributing/internal.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,20 @@ environment](./setup.md) set up properly. Then, follow these instructions.
4. Update the changelog in `docs/changelog.md`. After updating the changelog,
run `nox -s docs` to ensure that the docs are built properly.

5. Create a tag for the new version.
5. Commit changes.

Commit like
```console
$ git add <args>
$ git commit -m "Bump version to 2.4.0 and update changelog"
```
Note it's important to commit before tagging, because a git tag is a
fixed pointer to a specific commit in history. It you run
"git tag v2.4.0" without first commiting changes, then the tag will
point to the previous commit; it will refer to the state of the repo
before bumping the version and updating the changelog.

6. Create a tag for the new version.

Note that the Git tag DOES contain the leading "v". For example, if the new
version is `2.4.0`, then run:
Expand All @@ -66,17 +79,17 @@ environment](./setup.md) set up properly. Then, follow these instructions.
$ git tag v2.4.0
```

6. Push the branch and the new tag to GitHub.
7. Push the branch and the new tag to GitHub.

```console
$ git push -u origin release-v2.4.0
$ git push origin v2.4.0
```

7. Open a Pull Request for the new release branch, then wait for the test suite
8. Open a Pull Request for the new release branch, then wait for the test suite
to pass. Do not merge the PR yet.

8. Go to the LabGym homepage, then click "Releases", then click "Draft a new
9. Go to the LabGym homepage, then click "Releases", then click "Draft a new
release".

Under "Choose a tag", select the tag that you pushed. Then, click
Expand All @@ -87,7 +100,7 @@ environment](./setup.md) set up properly. Then, follow these instructions.
Package Index (PyPI). For more information, see [CI/CD
Pipeline](#ci-cd-pipeline).

9. After verifying that the deployment is successful, merge the release PR
10. After verifying that the deployment is successful, merge the release PR
into `master`.

## CI/CD Pipeline
Expand Down