ci-studio-common

README

Common CI / Habitat Studio Functionality

This repository houses some scripts / files that are used across various Chef projects. These are designed and intended to be used by Chef Developers who are working on some specific projects. We are keeping it public as to simplify the download process for our developers.

• Announcing the 2.0 release
• CI Services (Travis, Buildkite, etc)
  • Installation
  • Commands
    • did-modify
    • file-mod
    • vault-util
• FAQ
  • How do you determine a CI environment vs a non-CI environment?

Announcing the 2.0 release

The focus of the 2.0 release is to optimize ci-studio-common for use with multiple Buildkite platform. As such, we have made the breaking following changes:

• Utilities are now being written in Go to ensure consistency and availability across supported platforms.
• Some deprecated utilities have been removed, or are in the process of being removed.
• We no longer ship the CI binaries as part of the Chef Habitat Package

CI Services (Travis, Buildkite, etc)

Installation

You can install each component individually or the entirety of ci-studio-common grouped per OS and Arch at https://github.com/chef/ci-studio-common/releases

Currently available for:

OS	ARCH
Darwin	x86-64
Linux	x86-64
Windows	x86-64

Commands

did-modify

Prints "true" to STDOUT if any files matching GLOBS were modified between HEAD and GITREF. Otherwise, prints "false".

Usage:
  did-modify [flags]

Flags:
      --git-ref string   A valid Git reference (e.g. HEAD, master, origin/master, etc). (default "HEAD~1")
      --globs strings    Comma-separated list of glob patterns to inspect to determine if there are changes. (default [*])
  -h, --help             help for did-modify

file-mod

Command line utility to modify files.

Usage:
  file-mod [command]

Available Commands:
  append-if-missing Append STRING to FILE if not already there.
  find-and-replace  Replace REGEX_STR with STRING in FILE. Supports multiline replace.
  help              Help about any command

Flags:
  -h, --help   help for file-mod

Use "file-mod [command] --help" for more information about a command.

vault-util

Utility to access secrets and account information stored in Hashicorp Vault from CI.

Usage:
  vault-util [command]

Available Commands:
  configure-accounts    Configure the accounts specified in the VAULT_UTIL_ACCOUNTS environment variable.
  fetch-secret-env      Fetch the secrets specified in the VAULT_UTIL_SECRETS environment variable from Vault.
  help                  Help about any command
  print-git-credentials Utility that will print credentials for a GitHub App from Vault in git-credential-helper format.

Flags:
  -h, --help   help for vault-util

Use "vault-util [command] --help" for more information about a command.

FAQ

How do you determine a CI environment vs a non-CI environment?

ci-studio-common determines whether it is operating in a CI environment by the presence of a CI environment variable.