From 8cee76231d104c129e9c7f356584761f0ab6249e Mon Sep 17 00:00:00 2001 From: Doug Beatty <44704949+dbeatty10@users.noreply.github.com> Date: Wed, 2 Aug 2023 09:31:47 -0600 Subject: [PATCH] Instructions for the release process (#137) * Instructions for the release process * Breaking changes are minor releases since still below version 1.0 --- 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..4594fb5 --- /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 | 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-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)