CICD Lib

Under development and subject to fast changes

This library and CLI consists of a couple of functions and commands that helps working with CICD.

For now mainly focused on GitLab.

Create or update variable for version handling in GitLab

If you want to use semantic versioning on a branch in GitLab you can use the command cicd-lib update-gitlab-version-variable-from-labels in your .gitlab-ci.yml file.

First you will have to create the labels:

• major
• minor
• revision

Then you add the following job to your .gitlab-ci.yml file:

# <root of project>/.gitlab-ci.yml

# other jobs...
# ---
update-version:
  stage: update_version_number
  only:
    - master
  script:
    - npm i -g @wentools/cicd-lib
    - cicd-lib update-gitlab-version-variable-from-labels
# ---

On the next merge request to the branch/branches in only will be able to control the versioning via the created lables. You can find your version number in the project variables in GitLab and use them for an example a package.json file.

Options

--token, -t:

Token for GitLab API. Either save token in a variable named GITLAB_API_TOKEN or provide it here.

cicd-lib update-gitlab-version-variable-from-labels --token <your token>

--variablesuffix, -v:

The name of the variable in GitLab will be the target branch + the suffix. Default is _VERSION_NUMBER, which would result in <branch name>_VERSION_NUMBER

cicd-lib update-gitlab-version-variable-from-labels --variablesuffix <wanted variable name suffix>

--host, -h:

Name of GitLab API host. Usually found in the environmental variable "CI_API_V4_URL". If not provided it is assumed your repo is on the official GitLab repo.

cicd-lib update-gitlab-version-variable-from-labels --host <my privately hosted GitLab>

Write version to package.json

If you want to update the version in a package.json you can use cicd-lib write-version-to-package in your .gitlab-ci.yml file.

# <root of project>/.gitlab-ci.yml

# other jobs...
# ---
build:
  stage: build
  only:
    - master
  script:
    - npm i -g @wentools/cicd-lib
    - cicd-lib write-version-to-package
# ---

Options

--version, -v:

The version you want to write to package.json. If not provided it will use the branch name + the default suffix to find the correct version variable to write to file.

cicd-lib write-version-to-package --version <your version number>

Contact

Created by Dennis Wenger. Hit me up on: [email protected]