Merge pull request #526 from axonivy/doc-drafter-changes

Document current approach to introduce a new release-drafter template

README.md

@@ -14,38 +14,73 @@ Maven plugin for the automated building of Axon Ivy Projects.
 #### Preparation
 
 - Update the default engine version in:
-	- [AbstractEngineMojo](src/main/java/ch/ivyteam/ivy/maven/AbstractEngineMojo.java#L42)
-	- [pom.xml](pom.xml#L483)
+  - [AbstractEngineMojo](src/main/java/ch/ivyteam/ivy/maven/AbstractEngineMojo.java#L42)
+  - [pom.xml](pom.xml#L483)
 - Raise the minimal engine version needs to be updated at least if you introduce a new minor or major version:
-	- [AbstractEngineMojo](src/main/java/ch/ivyteam/ivy/maven/AbstractEngineMojo.java#L41)
+  - [AbstractEngineMojo](src/main/java/ch/ivyteam/ivy/maven/AbstractEngineMojo.java#L41)
 
 #### Release
 
 Since 9.4: Releasing is only possible on a release branch.
 
 - Create a release branch if it does not exist yet (e.g. release/10.0)
+
 - Run the [release build](build/release/Jenkinsfile) on the release branch
+
 - Merge the Pull Request for next development iteration
-- If you have created a new release branch, then manually raise the version on the master branch to the next major or minor version by executing the following command in the root of this project and make the steps in 'preperation' on the master branch :
 
-```bash
-mvn versions:set -DnewVersion=10.0.0-SNAPSHOT -DprocessAllModules -DgenerateBackupPoms=false
-```
+- If you have created a new release branch: 
+
+  - on `master` manually raise the version to the next major or minor version by executing the following command in the root of this project and make the steps in 'preperation' on the master branch :
+
+    ```bash
+    mvn versions:set -DnewVersion=10.0.0-SNAPSHOT -DprocessAllModules -DgenerateBackupPoms=false
+    ```
+
 - If the master reflects a new release-cycle; reflect it in the `versionPrefix` query parameter on the badges below.
 
 #### Post-Release
 
 Wait until the maven central release is available: this may take several hours until it's fully distributed.
 
 - Publish the latest [draft release](https://github.com/axonivy/project-build-plugin/releases) do preserve the current changelog.
-    - Select the tag which was created for this release by the release-pipeline
-	- Verify that the title is correct
-	- Set the release as 'latest release'
-	- Publish it
+  
+  - Select the tag which was created for this release by the release-pipeline
+  - Verify that the title is correct
+  - Set the release as 'latest release'
+  - Publish it
+
+- Release-Drafter changes, if a new-release train was introduced:
+  
+  - on `master` branch: 
+    
+    - add a new release-drafter template for this new release by duplicating the existing and adding a release postfix e.g.`.github/release-drafter-lts14.yml`
+    
+    - adjust the content of the duplicated file: 
+      
+      ```yaml
+      filter-by-commitish: true
+      commitish: release/14.0
+      ```
+  
+  - on the release branch: 
+    
+    - change the `.github/workflow/release-drafter.yml` to listen only for changes  from ~~master~~ to `release/XYZ` and refer the new template from master by name in the [config-name](.github/workflow/release-drafter.yml#32) part (e.g. `release-drafter-lts14.yml` )
+  
+  - on github UI (PR View): 
+    
+    - flag the latest PR which was only merged to master with the label `major` 
+  
+  - ... now release-drafter action runs should create new draft PRs for the new release; without overwriting the existing master drafts.
+
 - Raise project-build-plugin in other repos by triggering this [build](https://jenkins.ivyteam.io/view/jobs/job/github-repo-manager_raise-build-plugin-version/job/master/)
-	- Merge the generated PRs on GitHub
+  
+  - Merge the generated PRs on GitHub
+
 - If you prepared for a new release train: update the default engine version in the [AbstractEngineMojo](src/main/java/ch/ivyteam/ivy/maven/AbstractEngineMojo.java#L42)
+
 - Inform team-wawa @Teams to update to update Portal onto the latest project-build-plugin version!
+
 - Raise ch.ivyteam.ivy.library.IvyProjectBuildPlugin.DEFAULT_VERSION in ivy core
 
 ## License