Status

About

Fetches github repos and deploys them on the Delphi server.

Including this one :)

Usage

Flags

The following flags exist:

• --package <file>

  Deploy a local zip or tar file. Not compatible with any other flags. Doesn't touch the database or GitHub at all.

• --repo <owner/repo>

  Deploy a specific GitHub repo. When used without the --database flag, the given repo is deployed unconditionally. When used with the --database flag, this acts as a filter such that among all stale repos in the database, only the given repo will be deployed. In either case, the database will be updated with the result.

• --database

  False by default. When present (i.e. true), get a list of stale repos from the database and either: deploy them all, without the --repo flag; or deploy just the stale repo given by the --repo flag. In either case, the database will be updated with the result.

• --branch <name>

  Use branch "master" by default. For --repo and --database deployments, condition the repo selection logic on this particular branch (e.g. staleness checks, database status reporting). Prior to deployment, the given branch will be checked out. This is useful, for example, for deploying a particular branch in a particular environment.

Examples

• Deploy a local tarball:

  python3 -m delphi.github_deploy_repo.github_deploy_repo \
    --package foo.tar

• Deploy the dev branch of the cmu-delphi/www-epicast repo:

  python3 -m delphi.github_deploy_repo.github_deploy_repo \
    --repo cmu-delphi/www-epicast --branch dev

• Deploy the master branch of all stale repos in the database:

  python3 -m delphi.github_deploy_repo.github_deploy_repo \
    --database

• Deploy the campus branch of the cmu-delphi/operations repo, but only if it's stale in the database:

  python3 -m delphi.github_deploy_repo.github_deploy_repo \
    --database --repo cmu-delphi/operations --branch campus

Deployment Language

Deployment instructions are defined in a JSON file. By default, this file is named "deploy.json" and lives in the root of the git repository. Most fields should be self-explanatory, but the various commands (aka "actions") are described below. See this repo's deploy.json for an example.

copy

Copies a file. Note that the source file must reside with the repository (e.g. it will refuse to copy /etc/passwd). The destination file, however, can be anywhere in the filesystem (well, anywhere the user has write access). Existing files will be overwritten.

Additional fields:

• src (required)

  The source file.

• dst (required)

  The destination file.

• match (optional)

  A regular expression. The action is applied to all files whose basename matches the regex. If this field is present, src and dst are interpreted as directories instead of files.

• add-header-comment (optional)

  Whether to include a header comment (containing a warning not to edit the file and a pointer to the repository) at the top of the destination file.

• replace-keywords (optional)

  Replace template strings in source file with values found in the list of template files. Each file is a JSON object containing a list of (key, value) pairs to be replaced.

• recursive (optional)

  If set to true (false by default), src and dst are treated as directories. match must be specified, and all matching files are copied, including subdirectories.

move

Identical to the copy command, except the source file is deleted.

compile-coffee

Transpiles a CoffeeScript file to a JavaScript file.

Additional fields:

• src (required)

  The input file.

• dst (optional)

  The output file. Default is src with extension replaced with "js", unless otherwise specified.

minimize-js

Minimize a JavaScript file.

Additional fields:

• src (required)

  The input file.

• dst (optional)

  The output file. Defaults to src unless otherwise specified.

py3test

Runs unit and coverage tests for python using py3tester. Any test errors or failures will cause the deployment to fail, even if it was otherwise successful.

Additional fields:

• dir (optional)

  The directory, relative to the repo root, containing unit tests. Defaults to "tests" (e.g. "repo_name/tests").