Skip to content

Commit

Permalink
Update configuration file reference in CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
daneah committed Oct 28, 2024
1 parent 4e6b67f commit de0d908
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,8 +60,8 @@ To participate in the release process, you'll need the following:

### Preparing a release

1. Once all changes for a release are approved and incorporated into `dev`, update the `setup.cfg` file to a new semantic version. Update `CHANGELOG.md` to reflect the new version and make sure all changes are reflected (see link in `CHANGELOG.md` for formatting).
1. Once all changes for a release are approved and incorporated into `dev`, update the `pyproject.toml` file to a new semantic version. Update `CHANGELOG.md` to reflect the new version and make sure all changes are reflected (see link in `CHANGELOG.md` for formatting).
1. Open a pull request titled something like "v3.X.X release prep" and merge to `dev`
1. Tag the head of `dev` as a new GitHub release matching the version in `setup.cfg`, using the body of the version's changes from `CHANGELOG.md` as the release description
1. Tag the head of `dev` as a new GitHub release matching the version in `pyproject.toml`, using the body of the version's changes from `CHANGELOG.md` as the release description
1. Monitor the resulting [actions](https://github.com/ithaka/apiron/actions) to make sure the build artifacts are uploaded to PyPI and the GitHub release
1. Smoke check the documentation build on Read the Docs

0 comments on commit de0d908

Please sign in to comment.