From 40340d957469f3965b2e70a221da8abbd63dd211 Mon Sep 17 00:00:00 2001 From: Doug Beatty Date: Sun, 16 Jul 2023 21:06:16 -0600 Subject: [PATCH 1/2] Instructions for the release process --- RELEASE.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 RELEASE.md diff --git a/RELEASE.md b/RELEASE.md new file mode 100644 index 0000000..f230fdb --- /dev/null +++ b/RELEASE.md @@ -0,0 +1,22 @@ +# dbt-codegen releases + +## When do we release? +There's a few scenarios that might prompt a release: + +| Scenario | Release type | +|--------------------------------------------|--------------| +| Breaking changes to existing macros | major | +| New functionality¹ | minor | +| Fixes to existing macros | patch | + +## Release process + +1. Begin a new release by clicking [here](https://github.com/dbt-labs/dbt-codegen/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) From 3e2b60edca099263704e4f5693be6e8d51a2502d Mon Sep 17 00:00:00 2001 From: Doug Beatty Date: Sun, 16 Jul 2023 21:06:16 -0600 Subject: [PATCH 2/2] Breaking changes are minor releases since still below version 1.0 --- RELEASE.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/RELEASE.md b/RELEASE.md index f230fdb..4594fb5 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -5,8 +5,8 @@ There's a few scenarios that might prompt a release: | Scenario | Release type | |--------------------------------------------|--------------| -| Breaking changes to existing macros | major | -| New functionality¹ | minor | +| Breaking changes to existing macros | minor | +| New functionality | minor | | Fixes to existing macros | patch | ## Release process