-
Notifications
You must be signed in to change notification settings - Fork 42
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Instructions for the release process (#80)
* Instructions for the release process * Breaking changes are minor releases since still below version 1.0
- Loading branch information
Showing
1 changed file
with
22 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
# dbt-audit-helper releases | ||
|
||
## When do we release? | ||
There's a few scenarios that might prompt a release: | ||
|
||
| Scenario | Release type | | ||
|--------------------------------------------|--------------| | ||
| Breaking changes to existing macros | minor | | ||
| New functionality | minor | | ||
| Fixes to existing macros | patch | | ||
|
||
## Release process | ||
|
||
1. Begin a new release by clicking [here](https://github.com/dbt-labs/dbt-audit-helper/releases/new) | ||
1. Click "Choose a tag", then paste your version number (with no "v" in the name), then click "Create new tag: x.y.z. on publish" | ||
- The “Release title” will be identical to the tag name | ||
1. Click the "Generate release notes" button | ||
1. Copy and paste the generated release notes into `CHANGELOG.md`, commit, and merge into the `main` branch | ||
1. Click the "Publish release" button | ||
- This will automatically create an "Assets" section containing: | ||
- Source code (zip) | ||
- Source code (tar.gz) |