@s-ui/ci v1.27.0

sui-ci

CLI with some useful commands for CI environments

It provides:

• A way to update a GitHub Commit Status from a CI environment.

Requirements

Right now, it relies on some environment variables:

• GH_TOKEN: GitHub Personal Access Token of the user that will create the status of the commit.
• SUI_CI_TOPIC: Optional but useful environment variable to tell the CI which topic the commit is about.

@s-ui/ci right now expects it's using Travis to execute CI, so the next environment variables are expected: TRAVIS_BUILD_WEB_URL, TRAVIS_COMMIT, TRAVIS_PULL_REQUEST_SHA, TRAVIS_REPO_SLUG.

Usage

Usage: sui-ci update-commit-status [options]

Options:
  -s, --state <stateKey>  State of the commit. Accepted values:"OK", "KO", "RUN" (default: "KO")
  -u, --url <targetUrl>   Url where the details link navigates to (default: <travis-build-url>)
  -t, --topic <ciTopic>   Topic telling what is the commit about (default: process.env.SUI_CI_TOPIC)
  -h, --help              display help for command

For example, you could use the CLI directly by using npx with that.

$ npx @s-ui/ci update-commit-status --state OK --topic build 

In Action