From 923a37bb59e7a1e99a049995fb16255d6c1c341a Mon Sep 17 00:00:00 2001 From: Romain Failliot Date: Sun, 3 Apr 2022 21:12:52 -0400 Subject: [PATCH 1/3] docs: document release process steps --- docs/release-process.md | 56 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 56 insertions(+) create mode 100644 docs/release-process.md diff --git a/docs/release-process.md b/docs/release-process.md new file mode 100644 index 0000000..b9a01f0 --- /dev/null +++ b/docs/release-process.md @@ -0,0 +1,56 @@ +# Release process + +I'd wish the release process to be more automated, but for now it's still a +few manual steps. + +## Prepare the PR for the new release + +1. Find the next version, using semantic versioning, depending on the changes + in the changelog +2. Find and replace the old version with the new version in some files: + - meson.build + - data/usr/share/gnome/help/diffuse/*/diffuse.xml + - data/usr/share/omf/diffuse/diffuse-*.omf + - utils/book2manual.xsl + - windows-installer/build.py + - windows-installer/diffuse.iss + - windows-installer/diffuse.new.iss +3. Update the date for the new release date in these files: + - data/usr/share/gnome/help/diffuse/*/diffuse.xml + - data/usr/share/omf/diffuse/diffuse-*.omf + - utils/book2manual.xsl +3. Update CHANGELOG.md + - Add new line under `## Unreleased` following this syntax: `## x.y.z - YYYY-MM-DD` + - Copy the content of the changes for this release +4. Update AppData release notes in data/io.github.mightycreak.Diffuse.appdata.xml.in: + - Create a new `` tag under ``, fill the `version` and + `date` attributes + - Create a new `` tag under the new `` tag + - Add one paragraph to sum the release in one sentence (e.g. highlights, ...) + - Paste the changes from the changelog and adapt it to HTML +5. Create new branch and PR + +## Create new release on GitHub + +1. When everything's green: merge the PR +2. Create a new release on GitHub's [new release page](https://github.com/MightyCreak/diffuse/releases/new): + - Choose a tag: `v` followed with the new version (e.g. `v1.2.3`) + - Release title: the tag (e.g. `v1.2.3`) + - Description: + - For the first paragraph, paste the first paragraph from the release notes + - For the second paragraph, got to [CHANGELOG.md](https://github.com/MightyCreak/diffuse/blob/master/CHANGELOG.md) + and copy the URL anchor to the new release, then add this sentence + (adapt the changelog link): + > For a more detailed list of changes, see the + > [changelog](https://github.com/MightyCreak/diffuse/blob/master/CHANGELOG.md#xyz---yyyy-mm-dd). +3. Publish release + +## Create new release on Flatpak + +1. Clone the Flathub repository: https://github.com/flathub/io.github.mightycreak.Diffuse +2. Copy the contents of Diffuse's `io.github.mightycreak.Diffuse.yml` to Flathub's +3. Keep Flathub's `config-opts` and `sources` sections +4. In `sources` section, change the `commit` and `tag` +5. Create commit with changes and push to `master` +6. Check the build on Flathub: https://flathub.org/builds/ +7. When it's done and successful, publish the build From 5007221a4987ed2c6a6d05a68f77ae2b56036aa8 Mon Sep 17 00:00:00 2001 From: Romain Failliot Date: Sun, 3 Apr 2022 21:14:08 -0400 Subject: [PATCH 2/3] Update CHANGELOG.md --- CHANGELOG.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 5ac026f..37fbb11 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,6 +6,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ## Unreleased +### Added +- Documentation: added release process instructions + ## 0.7.4 - 2022-04-03 ### Added From 36788fa605402b109808fd0ff56bcdb5077c8bcd Mon Sep 17 00:00:00 2001 From: Romain Failliot Date: Mon, 4 Apr 2022 09:55:13 -0400 Subject: [PATCH 3/3] Include the release process in documentation tree --- docs/README.md | 4 +++- docs/{developers.md => developers/developers-setup.md} | 2 +- docs/{ => developers}/release-process.md | 0 3 files changed, 4 insertions(+), 2 deletions(-) rename docs/{developers.md => developers/developers-setup.md} (99%) rename docs/{ => developers}/release-process.md (100%) diff --git a/docs/README.md b/docs/README.md index b484bec..2abf7ab 100644 --- a/docs/README.md +++ b/docs/README.md @@ -6,4 +6,6 @@ Here are the main sections: 1. [Users](users.md) 2. [Translators](translators.md) -3. [Developers](developers.md) +3. Developers + 1. [Developers setup](developers/developers-setup.md) + 2. [Release process](developers/release-process.md) diff --git a/docs/developers.md b/docs/developers/developers-setup.md similarity index 99% rename from docs/developers.md rename to docs/developers/developers-setup.md index 464a175..ea26865 100644 --- a/docs/developers.md +++ b/docs/developers/developers-setup.md @@ -1,4 +1,4 @@ -# Developers documentation +# Developers setup ## Requirements diff --git a/docs/release-process.md b/docs/developers/release-process.md similarity index 100% rename from docs/release-process.md rename to docs/developers/release-process.md