Skip to main content

Contribute

We are happy to receive contributions to CI Tools. If you want to contribute, please follow the instructions below.

Usage

Fork the repository to your own GitLab account under the name ci-tools. The name is important because the templates are included by name.
Set your project to use the public instance runners or own runners.
Option: Set the GITLAB_TOKEN environment variable with API read access.
Clone the repository to your local machine and make your changes.

git clone <my-fork-url> my-fork
cd my-fork

Run a pipeline to test, but apply the token claim reset first.

export GITLAB_TOKEN=<your_token>
export PROJECT_ID=$(glab repo view -F json | jq '.id')

curl --request PUT \
  --header "PRIVATE-TOKEN: ${GITLAB_TOKEN}" \
  --header "Content-Type: application/json" \
  --data '{"ci_id_token_sub_claim_components": ["project_id", "ref_type", "ref"]}' \
  "https://gitlab.com/api/v4/projects/${PROJECT_ID}"

Reconfigure your projects runners to use the instance runners, if needed.
Develop and test your changes with your fork and a new test project.
Send in a merge request to the main repository with your changes.

Usage