From b5b6017d81f93123b374a62fc8f9f9bd68bc699f Mon Sep 17 00:00:00 2001 From: Oliver Date: Thu, 20 Mar 2025 22:22:57 +0100 Subject: [PATCH] docs: add release workflow page --- docs/src/blog/why-monorepo.md | 1 - .../release-workflow.md | 26 +++++++++++++++++++ 2 files changed, 26 insertions(+), 1 deletion(-) create mode 100644 docs/src/development-guidelines/release-workflow.md diff --git a/docs/src/blog/why-monorepo.md b/docs/src/blog/why-monorepo.md index e3396f61..9bc7c0ed 100644 --- a/docs/src/blog/why-monorepo.md +++ b/docs/src/blog/why-monorepo.md @@ -1,5 +1,4 @@ --- -visibility: hidden authors: - name: Oliver Schlüter email: oliver@fancyplugins.de diff --git a/docs/src/development-guidelines/release-workflow.md b/docs/src/development-guidelines/release-workflow.md new file mode 100644 index 00000000..24cc7c85 --- /dev/null +++ b/docs/src/development-guidelines/release-workflow.md @@ -0,0 +1,26 @@ +# Release Workflow + +This document describes the steps to be taken when releasing a new version of a plugin. + +## Before the release + +1. Make sure that all relevant changes are noted in the `CHANGELOG.md` file +2. Manually test all changes and make sure that all existing features are still working as expected +3. Update all dependencies to the latest version +4. Optional: give out a pre-release version to the community for testing + +## Release + +1. Update the version number in the `VERSION` file +2. Update the supported versions in the deployment config files, if necessary +3. Commit and push the changes +4. Create a new tag with the version number +5. Copy the changelog to the changelog page on the documentation website +6. Run the deployment workflow +7. Confirm that the deployment was successful +8. Send out a message to the community that a new version is available + +## After the release + +1. Clear the `CHANGELOG.md` file, so that it is ready for the next release +2. Wait for feedback from the community \ No newline at end of file