Skip to content

Commit c8174a4

Browse files
committed
Update release instructions
1 parent cc022ee commit c8174a4

File tree

1 file changed

+18
-11
lines changed

1 file changed

+18
-11
lines changed

RELEASE.md

Lines changed: 18 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,31 @@
11
### Release Procedure
22

3+
1. [Bump version](#bump-version)
4+
1. [PyPI](#pypi)
5+
1. [GitHub](#github)
6+
37
#### Bump version
48

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

2330
#### PyPI
2431

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

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

0 commit comments

Comments
 (0)