Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jenkinsci/git-automerger-plugin
Tool for auto-merging releases branches into master.
https://github.com/jenkinsci/git-automerger-plugin
git jenkins merger
Last synced: 5 days ago
JSON representation
Tool for auto-merging releases branches into master.
- Host: GitHub
- URL: https://github.com/jenkinsci/git-automerger-plugin
- Owner: jenkinsci
- License: mit
- Created: 2019-05-29T16:02:07.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-06-27T22:15:25.000Z (over 1 year ago)
- Last Synced: 2025-01-30T04:31:43.655Z (11 days ago)
- Topics: git, jenkins, merger
- Language: Kotlin
- Homepage: https://plugins.jenkins.io/git-automerger/
- Size: 116 KB
- Stars: 4
- Watchers: 3
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://ci.jenkins.io/job/Plugins/job/git-automerger-plugin/job/master/)
The main purpose of this plugin is to ensure that all newer versions include all the changes from older versions.
### Requirements
The plugin is merging only the branches with the following structure:
```
* master
|
| * release/2.0
|/
|
| * release/1.5
|/
|
| * release/1.0
|/
```
The naming of release branches is flexible, but the branch name must contain a version number.
Versions are ordered using [Apache's ComparableVersion](https://github.com/apache/maven/blob/master/maven-artifact/src/main/java/org/apache/maven/artifact/versioning/ComparableVersion.java).
**Warning:** Do not use the plugin if your version system differs from `ComparableVersion`.
The plugin can merge newer package into older.
If you are using a different branch strategy, please fill a feature request.
### Conflicts
In many cases merge conflicts can be solved automatically.
You could define one of available conflict resolution per file.
For example you have conflict:
release/1.0
release/1.1
Foo
Bar
According to selected resolution, one of outcome could be:
KEEP_OLDER
KEEP_NEWER
MERGE_NEWER_TOP
MERGE_OLDER_TOP
Foo
Bar
Bar
Foo
Foo
Bar
For example, for `CHANGELOG.md` you would probably prefer to use `MERGE_NEWER_TOP`
### Example:
```groovy
gitAutomerger logLevel: 'INFO',
mergeRules: [
[path: 'CHANGELOG.md', resolution: 'MERGE_NEWER_TOP'],
[path: 'version', resolution: 'KEEP_NEWER'],
],
releaseBranchPattern: 'release/%',
checkoutFromRemote: true,
remoteName: 'origin',
detailConflictReport: true
```
### Testing
Run server (http://localhost:8080):
```
./gradlew server
```
### License
```
MIT License
Copyright (c) 2019 Vinted UAB
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
```