-
Notifications
You must be signed in to change notification settings - Fork 36
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #246 from SebSept/fix_release_notes
fix release notes - fix #174
- Loading branch information
Showing
1 changed file
with
9 additions
and
28 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 |