infrastructure/gitlab-ci
2
0
Fork 0
Code Issues 17 Pull Requests 1 Actions Projects Releases 21 Wiki Activity

docs(gitlab_release): Updated docs with new instructions on version incrementing

Browse Source 
BREAKING CHANGE: !2
This commit is contained in:
Jon Lockwood
2021-08-07 14:56:51 +09:30
parent f76cabeeb0
commit 5f273ce23a
1 changed files with 14 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
gitlab_release/README.md
View File

@ -1,5 +1,17 @@
# Gitlab Release # Gitlab Release
This job bumps the version, updates the changelog, creates a git tag and creates a gitlab release. The git tag and release title use [semantic versioning](https://semver.org/). for this job to function correctly a `.cz.yaml` is required in the root of the repository. this file contains the [commitizen](https://github.com/commitizen-tools/commitizen) config and the version details. This job runs on successful completion of previous jobs and only on `development` and `master` branches. This job bumps the version, updates the changelog, creates a git tag and creates a gitlab release. The git tag and release title use [semantic versioning](https://semver.org/). for this job to function correctly a `.cz.yaml` is required in the root of the repository. this file contains the [commitizen](https://github.com/commitizen-tools/commitizen) config and the version details.
This job has the following workflow:
- `master` Branch
> Automatically increment the version
- `development` Branch
> Manual CI job made available to increment the version. (release-candidate increment only)
| :octagonal_sign: Danger |
|:----|
| *If prior to merging to the master branch you do a version increment, and there are no commits prior to merging. the job will not increment the version and the job will fail. it is recommended that you only do a version increment on the `development` branch if you are going to commit further changes to the `development` branch* |
This job provides the following badge: This job provides the following badge:
@ -8,7 +20,7 @@ This job provides the following badge:
## Dependencies ## Dependencies
- This job will only run if all previous jobs run. - None
## your .gitlab-ci.yml changes ## your .gitlab-ci.yml changes
To use this job add the following to your `.gitlab-ci.yml` file To use this job add the following to your `.gitlab-ci.yml` file
@ -54,15 +66,3 @@ This CI job's workflow is:
## License ## License
To view the license for this folder and any sub-folders, refer [here](https://gitlab.com/nofusscomputing/projects/gitlab-ci) To view the license for this folder and any sub-folders, refer [here](https://gitlab.com/nofusscomputing/projects/gitlab-ci)