

Status Checks

GitHub or Bitbucket status checks are an excellent way to track and control the CI/CD status of your projects.

By default, Semaphore reports these statuses for your initial .semaphore/semaphore.yml pipelines. Optionally, you can configure status checks for multiple pipelines, or even blocks.

The name of the status is derived from the name of your pipeline or block.

Configuring pipeline-level status checks

By default, Semaphore reports a status for your initial .semaphore/semaphore.yml pipeline.

To change the pipeline for which you want to create a status check, edit your project's configuration as shown below:

sem edit project <project-name>

apiVersion: v1alpha
kind: Project
metadata:
  name: example

spec:
  repository:
    url: "git@{github|bitbucket}.com:renderedtext/example.git"
    run: true
    run_on:
      - branches
      - tags
    pipeline_file: ".semaphore/semaphore.yml"

    status:
      pipeline_files:
        - path: ".semaphore/scheduled-runs.yml"
          level: "pipeline"

Adjust the status property to modify your status check configuration. In the above YAML, status checks will be sent only for the .semaphore/scheduled-runs.yml pipeline.

Configuring pipeline-level status checks for multiple pipelines

To set up status checks for multiple pipelines in your projects, edit your project's configuration as shown below:

sem edit project <project-name>

apiVersion: v1alpha
kind: Project
metadata:
  name: example

spec:
  repository:
    url: "git@{github|bitbucket}.com:renderedtext/example.git"
    run: true
    run_on:
      - branches
      - tags
    pipeline_file: ".semaphore/semaphore.yml"

    status:
      pipeline_files:
        - path: ".semaphore/semaphore.yml"
          level: "pipeline"

        - path: ".semaphore/scheduled-runs.yml"
          level: "pipeline"

Adjust the status property to modify your status check configuration. In the above YAML, status checks will be sent for both the .semaphore/semaphore.yml and .semaphore/scheduled-runs.yml pipelines.

Configuring block-level status checks

By default, Semaphore creates status checks for your pipelines. However, you can adjust this configuration and create status checks for blocks in the pipeline.

To sends block-level statuses, instead of pipeline-level statuses, edit your project configuration as shown below:

sem edit project <project-name>

apiVersion: v1alpha
kind: Project
metadata:
  name: example
spec:
  repository:
    url: "git@{github|bitbucket}.com:renderedtext/goDemo.git"
    run: true
    run_on:
      - branches
      - tags
    pipeline_file: ".semaphore/semaphore.yml"

    status:
      pipeline_files:
        - path: ".semaphore/semaphore.yml"
          level: "block"

Adjust the status > level property to send block instead of pipeline status checks.