From 9ee9d76bb28658cb51e71c3dd4b0bcbb2b5bfee3 Mon Sep 17 00:00:00 2001 From: Jake Coffman Date: Wed, 3 Jan 2024 09:40:01 -0600 Subject: [PATCH] add documentation on how to make a release --- docs/maintainers.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 docs/maintainers.md diff --git a/docs/maintainers.md b/docs/maintainers.md new file mode 100644 index 0000000..7140d1a --- /dev/null +++ b/docs/maintainers.md @@ -0,0 +1,19 @@ +## Maintainer docs + +This documentation is targeting maintainers of the Dependabot CLI. + +### Creating a release + +- Go to https://github.com/dependabot/cli/releases +- Click `Draft a new release` +- Click `Choose a tag` +- In the input, type `v1..` choosing the next minor or patch + - It really doesn't matter much which one you bump, but if it's a fix to the previous release patch makes sense. + - Don't bump the major version unless there were large breaking changes. +- Click `Generate release notes` + - If you want, you can delete lines that are minor like changes to workflows, README typo fixes, etc. +- Click `Publish release` +- Monitor the [Release binary builder](https://github.com/dependabot/cli/actions/workflows/release.yml)https://github.com/dependabot/cli/actions/workflows/release.yml, it sometimes fails and needs to re-run + + If anything goes wrong, like you've typed in something non-sensical as the version number by mistake, just delete the release/tag and create a new one. +