Skip to content

Commit

Permalink
Update release instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
dbeatty10 committed Feb 5, 2023
1 parent cc022ee commit c8174a4
Showing 1 changed file with 18 additions and 11 deletions.
29 changes: 18 additions & 11 deletions RELEASE.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,31 @@
### Release Procedure

1. [Bump version](#bump-version)
1. [PyPI](#pypi)
1. [GitHub](#github)

#### Bump version

1. Open a branch for the release
- `git checkout -b releases/0.19.0rc1`
- `git checkout -b releases/1.5.0`
1. Update [`CHANGELOG.md`](CHANGELOG.md) with the most recent changes
1. Bump the version using [`bump2version`](https://github.com/c4urself/bump2version/#bump2version):
1. Dry run first by running `bumpversion --dry-run --verbose --new-version <desired-version> <part>`. Some examples:
- Release candidates: `--new-version 0.10.2rc1 num`
- Alpha releases: `--new-version 0.10.2a1 num`
- Patch releases: `--new-version 0.10.2.1 patch`
- Minor releases: `--new-version 0.11.0.1 minor`
- Major releases: `--new-version 1.0.0.1 major`
1. Actually modify the files: `bumpversion --no-tag --new-version <desired-version> <part>`
- Release candidates: `--new-version 1.5.0rc1 num`
- Alpha releases: `--new-version 1.5.0a1 num`
- Patch releases: `--new-version 1.5.1 patch`
- Minor releases: `--new-version 1.5.0 minor`
- Major releases: `--new-version 2.0.0 major`
1. Actually modify the files: `bumpversion --no-tag --new-version <desired-version> <part>`. An example:
- Minor releases: `bumpversion --no-tag --new-version 1.5.0 minor`
1. Check the diff with `git diff`
1. Add the files that were changed with `git add --update`
1. Commit with message `Release dbt-mysql v<desired-version>`
1. `git push`
1. Merge back into `{minor-version}.latest` branch
1. If appropriate, merge back into `main` branch
1. Merge back into `main` branch
1. Create `{minor-version}.latest` branch
1. Bump the version in `main` to be the next minor alpha. Example:
- Minor releases: `bumpversion --no-tag --new-version 1.6.0a1 num`

#### PyPI

Expand All @@ -37,9 +44,9 @@ PyPI recognizes [pre-release versioning conventions](https://packaging.python.or

1. Click the [Create a new release](https://github.com/dbeatty10/dbt-mysql/releases/new) link on the project homepage in GitHub
1. Click the "Choose a tag" drop-down
1. Type `v{semantic_version}` (e.g., `v0.18.0rc2`) and click "+ Create a new tag"
1. Type `v{semantic_version}` (e.g., `v1.5.0rc2`) and click "+ Create a new tag"
1. Update the "Target" to be the name of the release branch
1. Type `dbt-mysql {semantic_version}` as the "release title" (e.g. `dbt-mysql 0.18.0rc2`)
1. Type `dbt-mysql {semantic_version}` as the "release title" (e.g. `dbt-mysql 1.5.0rc2`)
1. Leave the description blank
1. For pre-releases:
- Tick the "This is a pre-release" checkbox
Expand Down

0 comments on commit c8174a4

Please sign in to comment.