CI/CD

Use Kosli in CI Systems like GitHub Actions, GitLab CI, and more.

This section provides how-to guides showing you how to use Kosli to report changes from different CI systems.

Note that all CLI command flags can be set as environment variables by adding the the KOSLI_ prefix and capitalizing them.

Defaulted Kosli command flags from CI variables

The following flags are defaulted (which means you don’t need to provide the flags, they’ll be automatically set to values listed below) as follows in the CI systems below:

GitHub

View defaulted Kosli command flags in Github Actions.

Flag	Default
—build-url	<GITHUB_SERVER_URL>/<GITHUB_REPOSITORY>/actions/runs/<GITHUB_RUN_ID>
—commit-url	<GITHUB_SERVER_URL>/<GITHUB_REPOSITORY>/commit/<GITHUB_SHA>
—commit	<GITHUB_SHA>
—git-commit	<GITHUB_SHA>
—repository	<GITHUB_REPOSITORY>
—github-org	<GITHUB_REPOSITORY_OWNER>

Where <PLACEHOLDERS> are Github Actions predefined variables. See here for more details.

Use Kosli in Github Actions

To use Kosli in Github Actions workflows, you can use the kosli CLI setup action to install the CLI on your Github Actions Runner. Then, you can use all the CLI commands in your workflows.

GitHub Secrets

Keep in mind that secrets in Github actions are not automatically exported as environment variables. You need to add required secrets to your GITHUB environment explicitly. E.g. to make kosli_api_token secret available for all cli commands as an environment variable use following:

env:
  KOSLI_API_TOKEN: ${{ secrets.kosli_api_token }}

Example

Here is an example Github Actions workflow snippet using kosli-dev/setup-cli-action running kosli create flow command:

jobs:
  example:
    runs-on: ubuntu-latest
    env:
      KOSLI_API_TOKEN: ${{ secrets.MY_KOSLI_API_TOKEN }}
      KOSLI_ORG: my-org
    steps:
      - name: setup kosli
        uses: kosli-dev/setup-cli-action@v2
      - name: create flow
        run: kosli create flow my-flow --template pull-request,artifact,test

For a complete example of a Github workflow using Kosli, please check the Kosli CLI’s own workflow.

GitLab

Flag	Default
—build-url	<CI_JOB_URL>
—commit-url	<CI_PROJECT_URL>/-/commit/<CI_COMMIT_SHA>
—commit	<CI_COMMIT_SHA>
—git-commit	<CI_COMMIT_SHA>
—repository	<CI_PROJECT_NAME>
—gitlab-org	<CI_PROJECT_NAMESPACE>

Where <PLACEHOLDERS> are GitLab predefined variables. See here for more details.

Use Kosli in Gitlab pipelines

For a complete example of a Gitlab pipeline using Kosli, please check this cyber-dojo pipeline.

Azure DevOps

View defaulted Kosli command flags in Azure DevOps.

Flag	Default
—build-url	<System.CollectionUri>/<System.TeamProject>/_build/results?buildId=<Build.BuildId>
—commit-url	<System.CollectionUri>/<System.TeamProject>/_git/<Build.Repository.Name>/commit/<Build.SourceVersion>
—commit	<Build.SourceVersion>
—git-commit	<Build.SourceVersion>
—repository	<Build.Repository.Name>
—project	<System.TeamProject>
—azure-org-url	<System.CollectionUri>

Where <PLACEHOLDERS> are Azure DevOps predefined variables. See here for more details.

Bitbucket Cloud

View defaulted Kosli command flags in Bitbucket Cloud.

Flag	Default
—build-url	https://bitbucket.org/<BITBUCKET_WORKSPACE>/<BITBUCKET_REPO_SLUG>/addon/pipelines/home#!/results/<BITBUCKET_BUILD_NUMBER>
—commit-url	https://bitbucket.org/<BITBUCKET_WORKSPACE>/<BITBUCKET_REPO_SLUG>/commits/<BITBUCKET_COMMIT>
—commit	<BITBUCKET_COMMIT>
—git-commit	<BITBUCKET_COMMIT>
—repository	<BITBUCKET_REPO_SLUG>
—bitbucket-workspace	<BITBUCKET_WORKSPACE>

Where <PLACEHOLDERS> are Bitbucket Cloud predefined variables. See here for more details.

AWS CodeBuild

View defaulted Kosli command flags in AWS CodeBuild.

Flag	Default
—build-url	<CODEBUILD_BUILD_URL>
—commit-url	<CODEBUILD_SOURCE_REPO_URL>/commit(s)/<CODEBUILD_RESOLVED_SOURCE_VERSION>
—commit	<CODEBUILD_RESOLVED_SOURCE_VERSION>
—git-commit	<CODEBUILD_RESOLVED_SOURCE_VERSION>

Where <PLACEHOLDERS> are AWS CodeBuild predefined variables. See here for more details.

CircleCI

View defaulted Kosli command flags in CircleCI.

Flag	Default
—build-url	<CIRCLE_BUILD_URL>
—commit-url	<CIRCLE_REPOSITORY_URL>(converted to https url)/commit(s)/<CIRCLE_SHA1>
—git-commit	<CIRCLE_SHA1>

Where <PLACEHOLDERS> are CircleCI predefined variables. See here for more details.

Teamcity

View defaulted Kosli command flags in Teamcity.

Flag	Default
—git-commit	<BUILD_VCS_NUMBER>

Where <PLACEHOLDERS> are Teamcity predefined variables. See here for more details.