From 125aaece75de8973a8bb867d07c0e5c3684c288d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=A9bastien=20Monterisi?= Date: Fri, 6 May 2022 21:21:17 +0200 Subject: [PATCH] fix release notes - fix #174 --- docs/RELEASE.md | 37 +++++++++---------------------------- 1 file changed, 9 insertions(+), 28 deletions(-) diff --git a/docs/RELEASE.md b/docs/RELEASE.md index d2ad515e..959f2f44 100644 --- a/docs/RELEASE.md +++ b/docs/RELEASE.md @@ -1,28 +1,9 @@ -Release process rely on 2 pieces. - -The first, .github/workflows/release_module.yml : -- creates a zipfile ready to deploy -- creates a new tag -- creates a release -- add the created zipfile to the newly created tag -- there is just poor contents in the release file. - -if the workflows runs and the tags already exists, it fails. - -The second, .github/workflows/release-drafter.yml : -- create a release __draft__ with merged pull requests since last release. So a nice release text. - -## Not to do - -Edit the release draft made by release drafter and publish the release. -Doing this creates a release and a tag, then the first workflows runs and fails : no zip added to the release - -## Todo - -- update the version in the module file. -- Edit the release draft : copy the generated content, arrange it a bit if needed : __do NOT publish the release__. -- create a tag -> the first worflow runs : a release with the zip is created. -- Edit the release and past the contents copied at step 1. - -We should write a better release action, that do not rely on `marvinpinto/action-automatic-releases@latest` - +Releasing is easy. + +- on the `dev` branch, upgrade the `version` value of the module. +- make a pull request, this will open discussion with other to ensure we are ready to do it. +- when done, on github, go to [release page](https://github.com/friends-of-presta/fop_console/releases) : click on the pen on the current Draft. +- add a release title (the release number at the moment) +- cleanup the release contents +- click on 'publish release' +- done