Files
SCM-Manager/docs/v2/release-process.md

100 lines
2.2 KiB
Markdown
Raw Normal View History

2020-03-09 08:01:43 +01:00
# How to release SCM-Manager v2 core
2020-03-13 15:44:35 +01:00
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`):
2020-03-09 08:01:43 +01:00
## Check out default branch
2020-03-13 15:44:35 +01:00
Make sure you have no changes you want to keep!
2020-03-09 08:01:43 +01:00
2020-03-13 15:44:35 +01:00
```
2020-03-26 16:12:12 +01:00
git fetch && git checkout develop && git reset --hard origin/develop
2020-03-13 15:44:35 +01:00
```
2020-03-09 08:01:43 +01:00
## Modify Changelog
Change "Unreleased" header in `CHANGELOG.md` to `<version> - <current date>`
2020-04-09 19:45:24 +02:00
## Create release branch
2020-03-09 08:01:43 +01:00
2020-03-13 15:44:35 +01:00
`git checkout -b release/<version>`
2020-03-09 08:01:43 +01:00
2020-03-13 15:44:35 +01:00
## Commit version changes
2020-03-09 08:01:43 +01:00
```
2020-03-13 15:44:35 +01:00
git add CHANGELOG.md
git commit -m "Adjust changelog for release <version>"
2020-03-09 08:01:43 +01:00
```
2020-03-13 15:44:35 +01:00
## Push release branch
2020-03-09 08:01:43 +01:00
2020-03-13 15:44:35 +01:00
`git push origin release/<version>`
2020-03-09 08:01:43 +01:00
2020-03-13 15:44:35 +01:00
## Wait for Jenkins build
2020-03-09 08:01:43 +01:00
2020-03-13 15:44:35 +01:00
Jenkins will
2020-03-09 08:01:43 +01:00
2020-03-13 15:44:35 +01:00
- update `pom.xml` and `package.json`
- merge with master branch
- build and deploy everything
- set the new development version for the develop branch
2020-04-09 19:45:24 +02:00
- delete the release branch
2020-03-09 08:01:43 +01:00
## 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`):
2020-04-09 19:45:24 +02:00
## Check out default branch
2020-03-13 15:30:52 +01:00
2020-03-13 15:44:35 +01:00
Make sure you have no changes you want to keep!
2020-03-13 15:30:52 +01:00
```
2020-03-13 15:44:35 +01:00
git fetch && git checkout develop && git reset --hard origin/develop
2020-03-13 15:30:52 +01:00
```
2020-03-09 08:01:43 +01:00
## Modify Changelog
Change "Unreleased" header in `CHANGELOG.md` to `<version> - <current date>`
## Remove old dependencies
`rm -rf node_modules yarn.lock`
## Build
`mvn clean install`
2020-04-09 19:45:24 +02:00
## Create release branch
2020-03-09 08:01:43 +01:00
```
2020-04-09 19:45:24 +02:00
git checkout -b release/<version>
2020-03-09 08:01:43 +01:00
```
2020-04-09 19:45:24 +02:00
## Commit and push release
2020-03-13 15:30:52 +01:00
2020-03-09 08:01:43 +01:00
```
2020-04-09 19:45:24 +02:00
git commit -am "Release version <version>"
2020-03-09 08:01:43 +01:00
```
2020-04-09 19:45:24 +02:00
## Push release branch
2020-03-09 08:01:43 +01:00
```
2020-04-09 19:45:24 +02:00
git push origin release/<version>
2020-03-09 08:01:43 +01:00
```
2020-04-09 19:45:24 +02:00
## Wait for Jenkins build
2020-03-09 08:01:43 +01:00
2020-04-09 19:45:24 +02:00
Jenkins will
2020-03-09 08:01:43 +01:00
2020-04-09 19:45:24 +02:00
- 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
2020-03-09 08:01:43 +01:00
2020-03-31 18:29:36 +02:00
## 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