66 lines
1.6 KiB
Markdown
66 lines
1.6 KiB
Markdown
# 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 provides the following badge:
|
|
|
|
- None
|
|
|
|
## Dependencies
|
|
|
|
- None
|
|
|
|
## your .gitlab-ci.yml changes
|
|
To use this job add the following to your `.gitlab-ci.yml` file
|
|
|
|
``` yaml
|
|
stages:
|
|
- release
|
|
|
|
include:
|
|
- remote: https://gitlab.com/nofusscomputing/projects/gitlab-ci/-/raw/development/gitlab_release/.gitlab-ci.yml
|
|
|
|
Gitlab Release:
|
|
extends:
|
|
- .gitlab_release
|
|
```
|
|
> if you wish to run any commands you can safely override `script` with your own commands. if these commands create any output that is not excluded in `.gitignore` they will be commited to the repository.
|
|
|
|
## CI/CD Variables required
|
|
|
|
| var name | Description |
|
|
|:----:|:----|
|
|
| GIT_COMMIT_TOKEN | *this must be a personal token that has write access to the repository* |
|
|
|
|
|
|
## Job Workflow
|
|
|
|
This CI job's workflow is:
|
|
|
|
1. updates the changelog from the commits
|
|
1. commit the changelog to git
|
|
1. adds a `git tag` to the changelog commit.
|
|
1. pushes the change back to the repo
|
|
1. creates a git release from the `git tag`
|
|
|
|
|
|
## Artifacts
|
|
|
|
- None
|
|
|
|
## License
|
|
To view the license for this folder and any sub-folders, refer [here](https://gitlab.com/nofusscomputing/projects/gitlab-ci)
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|