Skip to content

An action for setting CI statuses based on commissions.

License

Notifications You must be signed in to change notification settings

enso-org/ci-status-control

Repository files navigation

CI Status Control

This action allows you to trigger different CI statuses based on the changed files or commands in commit messages. It can be configured to either output the status, or trigger the status itself.

Inputs

run-id

The workflow run identifier.

  • Optional: false

github-token

A GitHub authentication token.

  • Optional: false

excluded-paths

A list of paths that should be excluded from CI.

  • Optional: true
  • Default: []

stop-internally

Whether or not the action should stop the workflow itself.

  • Optional: true
  • Default: true

skip-ci-message

The string in the commit message used to skip the CI run.

  • Optional: true
  • Default: [skip ci]

Outputs

stop-code

The result of executing the action. It can be one of:

  • continue: When the check wants to let the workflow continue.
  • cancel: When the check thinks the workflow should be cancelled.
  • skip: When the check thinks the workflow should be skipped.
  • neutral: When the check thinks the workflow should have a neutral status.
  • fail: When the check thinks the workflow should fail.

Example Usage

name: Conditionally Skip CI
uses: luna/skip-ci-action@0.1
with:
    run-id: ${{ github.run_id }}
    github-token: ${{ github.token }}
    excluded-paths:
    - /doc/*
    - README.md
    stop-internally: true
    skip-ci-message: true