Files
SCM-Manager/docs/v2/release-process.md
René Pfeuffer a4b3454601 Fix process
2020-04-14 15:37:18 +02:00

109 lines
2.5 KiB
Markdown

# How to release SCM-Manager v2 core
To release a new version of SCM-Manager v2 you have to do the following steps (replace placeholders `<version>` accordingly, eg. with `2.1.0`):
## Check out default branch
Make sure you have no changes you want to keep!
```
git fetch && git checkout develop && git reset --hard origin/develop
```
## Modify Changelog
Change "Unreleased" header in `CHANGELOG.md` to `<version> - <current date>`
## Create release branch
`git checkout -b release/<version>`
## Commit version changes
```
git add CHANGELOG.md
git commit -m "Adjust changelog for release <version>"
```
## Push release branch
`git push origin release/<version>`
## Wait for Jenkins build
Jenkins will
- update `pom.xml` and `package.json`
- merge with master branch
- build and deploy everything
- set the new development version for the develop branch
- delete the release branch
## Make a party
# How to release SCM-Manager v2 plugins
To release a new version of a Plugin for SCM-Manager v2 you have to do the following steps (replace placeholder `<version>` accordingly, eg. with `2.1.0`):
## Check out default branch
Make sure you have no changes you want to keep!
```
git fetch && git checkout develop && git reset --hard origin/develop
```
## Update SCM parent if necessary
If you need to update the parent of the plugin to a new release of SCM-Manager, change it now:
- `pom.xml`: `parent.version`
- `package.json`: `dependencies.ui-plugins`
```
rm -rf node_modules yarn.lock
mvn clean install
git add yarn.lock pom.xml package.json
git commit -m "Update to new version of SCM-Manager"
git push
```
Wait for Jenkins to be green.
## Create release branch
```
git checkout -b release/<version>
```
## Modify Changelog
Change "Unreleased" header in `CHANGELOG.md` to `<version> - <current date>`
## Commit and push release
```
git commit -am "Prepare release of <version>"
```
## Push release branch
```
git push origin release/<version>
```
## Wait for Jenkins build
Jenkins will
- update versions in pom.xml and package.json
- merge with master branch
- build and deploy everything
- set the new development version for the develop branch
- delete the release branch
## Attention: Creating new plugins
If you are creating a new plugin which doesn't exist in the SCM-Manager Plugin-Center yet, your plugin will not be shown after the release. First you have to create a `index.md` in the Plugin-Center Repository.
Example: https://github.com/scm-manager/plugin-center/blob/master/src/plugins/scm-teamscale-plugin/index.md