From 058f31d2d4743c9cd01317c0cf82799b7f3b4dc1 Mon Sep 17 00:00:00 2001 From: Anbraten Date: Mon, 4 Nov 2024 08:58:55 +0100 Subject: [PATCH 1/2] Add a release workflow --- docs/docs/92-development/10-releases.md | 35 +++++++++++++++++++++++++ 1 file changed, 35 insertions(+) create mode 100644 docs/docs/92-development/10-releases.md diff --git a/docs/docs/92-development/10-releases.md b/docs/docs/92-development/10-releases.md new file mode 100644 index 00000000000..640eaaaa398 --- /dev/null +++ b/docs/docs/92-development/10-releases.md @@ -0,0 +1,35 @@ +# Releasing a New Version + +Following semantic versioning (semver) guidelines, breaking changes will trigger a major version update. + +## Release Process + +### Pre-Release + +1. Update the version section in `CHANGELOG.md`. +2. Check `docs/src/pages/migrations.md`: + - It has to contain all necessary migration steps and suggested actions for users and instance admins. + - Check if steps link to the related pull requests or issues. + - Ensure steps are clear and describe the actions needed to migrate. + - Good: "Rename your `branch` config option to `when.branch`. (PR#123)" + - Bad: "Removed `branch` config option in favour of `when.branch`." + - Provide background if necessary to allow users to understand the change. +2. Add the new version to the versions list in `docs/src/pages/versions.md`. +3. For major releases, create a new blog post in `docs/blog/`, highlighting key changes with a link to the release notes. +4. Ask other maintainers in the chat for any outstanding blockers. +5. Schedule the release with at least 48 hours' notice in the maintainers chat. + +### Release + +1. Test the latest container images to ensure they work as expected. +2. Update `ci.woodpecker.org` to the latest `next` version and verify it works as expected. +3. Publish the new release on GitHub. + +### Post-Release + +1. Announce the new release in relevant chats and on social media platforms: + - [ ] Mastodon (verify if already posted by the release pipeline) + - [ ] Discord + - [ ] Matrix + - [ ] Twitter + From c60ee55cdd4ac19ae8e717342d1c0d37a13f127d Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Mon, 4 Nov 2024 08:00:07 +0000 Subject: [PATCH 2/2] [pre-commit.ci] auto fixes from pre-commit.com hooks [CI SKIP] for more information, see https://pre-commit.ci --- docs/docs/92-development/10-releases.md | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/docs/92-development/10-releases.md b/docs/docs/92-development/10-releases.md index 640eaaaa398..e9b775a281b 100644 --- a/docs/docs/92-development/10-releases.md +++ b/docs/docs/92-development/10-releases.md @@ -32,4 +32,3 @@ Following semantic versioning (semver) guidelines, breaking changes will trigger - [ ] Discord - [ ] Matrix - [ ] Twitter -