Implement new changelog process (#1517)

Adopt the new changelog process, which should avoid CHANGELOG.md merge conflicts.
This change integrates the new changelog gradle plugin to update the
CHANGELOG.md during a release and updates the release documentation.
This commit is contained in:
Sebastian Sdorra
2021-02-02 11:02:31 +01:00
committed by GitHub
parent 4966a389a3
commit bad426c9d8
3 changed files with 32 additions and 5 deletions

View File

@@ -26,6 +26,11 @@ plugins {
id 'java-platform' id 'java-platform'
id 'maven-publish' id 'maven-publish'
id "org.sonarqube" version "3.0" id "org.sonarqube" version "3.0"
id "org.scm-manager.changelog" version "0.1.4"
}
changelog {
versionUrlPattern = "https://www.scm-manager.org/download/{0}"
} }
subprojects { s -> subprojects { s ->

View File

@@ -19,18 +19,38 @@ Check whether there is an integration branch for the previous release or bugfixe
git merge origin/support/<support branch> git merge origin/support/<support branch>
``` ```
## Modify Changelog ## Update Changelog
Change "Unreleased" header in `CHANGELOG.md` to `<version> - <current date>` The changelog must be updated to reflect the changes for the new release.
All unreleased changes are stored in the `gradle/changelog` directory.
The changelog can be updated with the `updateChangelog` gradle task.
```bash
./gradlew updateChangelog --release=<version>
```
Now we should manually check if the changelog looks good.
```bash
git diff CHANGELOG.md
```
If everything looks fine, we can remove the changelog directory.
```bash
rm -rf gradle/changelog
```
## Create release branch ## Create release branch
`git checkout -b release/<version>` ```bash
git checkout -b release/<version>
```
## Commit version changes ## Commit version changes
``` ```bash
git add CHANGELOG.md git add CHANGELOG.md gradle/changelog
git commit -m "Adjust changelog for release <version>" git commit -m "Adjust changelog for release <version>"
``` ```

View File

@@ -0,0 +1,2 @@
- type: changed
description: Implement new changelog process ([#1517](https://github.com/scm-manager/scm-manager/issues/1517))