mirror of
https://github.com/scm-manager/scm-manager.git
synced 2025-10-26 08:06:09 +01:00
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:
@@ -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 ->
|
||||||
|
|||||||
@@ -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>"
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|||||||
2
gradle/changelog/new_changelog_process.yaml
Normal file
2
gradle/changelog/new_changelog_process.yaml
Normal file
@@ -0,0 +1,2 @@
|
|||||||
|
- type: changed
|
||||||
|
description: Implement new changelog process ([#1517](https://github.com/scm-manager/scm-manager/issues/1517))
|
||||||
Reference in New Issue
Block a user