Skip to content

Latest commit

 

History

History
241 lines (160 loc) · 8.8 KB

commands.md

File metadata and controls

241 lines (160 loc) · 8.8 KB
Raw

Commands

ci:meta

Usage: gitlab-ci-helper ci:meta [options]

  Dump meta information about ci into a ci.json file

Options:

  -file               Target file (default: ci.json)
  -verbose            Add verbose information to the output

ci:revision

Usage: gitlab-ci-helper ci:revision [options]

  Dump a REVISION file with the current sha1

Options:
  -file               Target file (default: REVISION)
  -ref                The sha1 (default: env var CI_BUILD_REF)
  -verbose            Add verbose information to the output

Env Variables:

  CI_BUILD_REF        Get the revision from this variable

flowdock:message

Usage: gitlab-ci-helper flowdock:message [options] organisation flow message

  Build a flowdock thread from the current build. Information are retrieved from
  environment variables.

Arguments:
  organisation        The organisation name
  flow                The flow reference
  message             The message to send

Options:
  -token              The flow's token (default: env var FLOWDOCK_SOURCE_TOKEN)
  -verbose            Add verbose information to the output


Configuration:

  Please note, the command use the new Flowdock API.

  1. Go to https://www.flowdock.com/oauth/applications
  2. Create a new Application
  3. Enter name, description and make sure "Short application" is selected.
  4. Once validated, Go to "Tools for testing" and create a new source.
  5. Press "Generate Source" and store the generated token for later use
     as the FLOWDOCK_SOURCE_TOKEN

flowdock:status

Usage: gitlab-ci-helper flowdock:message [options] organisation flow

  Build a flowdock thread from the current build. Information are retrieved from
  environment variables.

  The external thread id is: gitlab:sha1

  You can use the -last option to indicate that the current job is the last one.

Arguments:
  organisation        The organisation name
  flow                The flow reference

Options:
  -ref                The commit related to the build (default:
                        9.x: CI_COMMIT_SHA or 8.x: CI_BUILD_REF)
  -project            The project related to the build (default: env var CI_PROJECT_ID)
  -name               The build's name (default:
                        9.x: CI_JOB_NAME or 8.x: CI_BUILD_NAME)
  -ref-name           The reference name (default:
                        9.x: CI_COMMIT_REF_NAME or 8.x: CI_BUILD_REF_NAME)
  -last               Indicate if the current build is the last one
  -token              The flow's token (default: env var FLOWDOCK_SOURCE_TOKEN)
  -verbose            Add verbose information to the output


Configuration:

  Please note, the command use the new Flowdock API.

  1. Go to https://www.flowdock.com/oauth/applications
  2. Create a new Application
  3. Enter name, description and make sure "Short application" is selected.
  4. Once validated, Go to "Tools for testing" and create a new source.
  5. Press "Generate Source" and store the generated token for later use
     as the FLOWDOCK_SOURCE_TOKEN


Gitlab's credentials are retrieved from environment:

  GITLAB_HOST         The gitlab host
  GITLAB_TOKEN        The user's token
  GITLAB_API_PATH     (optional) the api path, default to: "/api/v3"

hipchat:message

Usage: gitlab-ci-helper ci:notify:hipchat [options] room message

  Send a message to one HipChat's room

Arguments:
  room                The room reference
  message             The message to send

Options:
  -color              The message color (default: gray, values: yellow, green, red, purple, gray, random)
  -notify             Whether this message should trigger a user notification (default: false)
  -token              The room's token (default: env var HIPCHAT_TOKEN)
  -server             The hipchat server, default to env var HIPCHAT_SERVER, then https://api.hipchat.com
  -verbose            Add verbose information to the output

project:builds

Usage: gitlab-ci-helper project:builds:list [options] project

  List all builds available for the provide project

Arguments:

  project             Can be an id or a string: namespace/name

Options:

  -verbose            Add verbose information to the output

Credentials are retrieved from environment:

  GITLAB_HOST         The gitlab host
  GITLAB_TOKEN        The user's token
  GITLAB_API_PATH     (optional) the api path, default to: "/api/v3"

project:builds:artifacts

Usage: gitlab-ci-helper project:builds:artifacts [options]

  Download an artifacts and extract it if the 'path' option is provided

Options:

  -project=XX         The project reference (default: CI_PROJECT_ID)
  -build=XX           The build number used to retrieved the related artifact
  -job=XX             The job to search the build (must be used with -ref, default: package)
  -ref=XX             The sha1 linked to the build (must be used with -stage,
                       default 9.X: CI_COMMIT_SHA / 8.x: CI_BUILD_REF)
  -file=artifacts.zip The path to the artifact file (default: artifacts.zip)
  -path=./package     The path to extract the command. If not set, the artifact will not
                      be extracted.
  -verbose            Add verbose information to the output

Credentials are retrieved from environment:

  GITLAB_HOST         The gitlab host
  GITLAB_TOKEN        The user's token
  GITLAB_API_PATH     (optional) the api path, default to: "/api/v3"

project:list

Usage: gitlab-ci-helper project:list [options] project

  List all projects available

Options:

  -verbose            Add verbose information to the output

Credentials are retrieved from environment:

  GITLAB_HOST         The gitlab host
  GITLAB_TOKEN        The user's token
  GITLAB_API_PATH     (optional) the api path, default to: "/api/v3"

s3:archive

Usage: gitlab-ci-helper s3:archive

  Send archive to a S3 bucket

Options:

  -include            Path to include (one option per path)
  -exclude            Path to exclude (one option per path)
  -ignore-cvs         Exclude CVS files: .git .svn .bzr .hg
  -verbose            Add verbose information to the output
  -job                The job name (default: 9.x: CI_JOB_NAME and 8.x: CI_BUILD_NAME)
  -ref                The reference (sha1) (default: 9.x: CI_COMMIT_SHA and 8.x: CI_BUILD_REF)
  -ref-name           The reference name (default: 9.x: CI_COMMIT_REF_NAME and 8.x: CI_BUILD_REF_NAME)
  -project            The project reference (default: CI_PROJECT_ID)
  -region             The s3 region (default: AWS_REGION)
  -endpoint           The s3 endpoint (default: AWS_ENDPOINT)
  -profile            The aws credentials name (default: AWS_PROFILE, if not set default)
  -bucket             The s3 bucket name (default: AWS_BUCKET)
  -tag-matcher        The regular expression to match a tag (default: semver)

Credentials are retrieved from environment:

  GITLAB_HOST         The gitlab host
  GITLAB_TOKEN        The user's token
  GITLAB_API_PATH     (optional) the api path, default to: "/api/v3"

s3:extract

Usage: gitlab-ci-helper s3:extract

  Extract archive from a S3 bucket

Options:

  -verbose            Add verbose information to the output
  -job                The job name (default: 9.x: CI_JOB_NAME and 8.x: CI_BUILD_NAME)
  -ref                The reference (sha1) (default: 9.x: CI_COMMIT_SHA and 8.x: CI_BUILD_REF)
  -ref-name           The reference name (default: 9.x: CI_COMMIT_REF_NAME and 8.x: CI_BUILD_REF_NAME)
  -project            The project reference (default: CI_PROJECT_ID)
  -region             The s3 region (default: AWS_REGION)
  -endpoint           The s3 endpoint (default: AWS_ENDPOINT)
  -profile            The aws credentials name (default: AWS_PROFILE, if not set default)
  -bucket             The s3 bucket name (default: AWS_BUCKET)
  -tag-matcher        The regular expression to match a tag (default: semver)

Credentials are retrieved from environment:

  GITLAB_HOST         The gitlab host
  GITLAB_TOKEN        The user's token
  GITLAB_API_PATH     (optional) the api path, default to: "/api/v3"

version

Usage: gitlab-ci-helper version

  Display the version number

Options:

  -e                  Extended version with sha1