Usage

hopic

hopic [OPTIONS] COMMAND [ARGS]...

Options

--color <color>

Default:auto Options:always | auto | never

--config <config>

Default:${WORKSPACE}/hopic-ci-config.yaml

--workspace <workspace>

Default:git work tree of config file or current working directory

--version

Show the version and exit.

-v, --verbosity <LVL>

Either CRITICAL, ERROR, WARNING, INFO or DEBUG

--git-verbosity <LVL>

Either CRITICAL, ERROR, WARNING, INFO or DEBUG

Environment variables

HOPIC_VERBOSITY

Provide a default for --verbosity

GIT_VERBOSITY

Provide a default for --git-verbosity

build

Build for the specified commit.

This defaults to building all variants for all phases. It’s possible to limit building to either all variants for a single phase, all phases for a single variant or a single variant for a single phase.

hopic build [OPTIONS]

Options

-p, --phase <phase>

Build phase to execute

-v, --variant <variant>

Configuration variant to build

-n, --dry-run

Print commands from the configured phases and variants, but do not execute them

checkout-source-tree

Checks out a source tree of the specified remote’s ref to the workspace.

hopic checkout-source-tree [OPTIONS]

Options

--target-remote <url>

--target-ref <ref>

--target-commit <commit>

--clean, --no-clean

Clean workspace of non-tracked files

--ignore-initial-submodule-checkout-failure, --no-ignore-initial-submodule-checkout-failure

Ignore git submodule errors during initial checkout

getinfo

Display meta-data associated with each (or the specified) variant in each (or the specified) phase.

The output is JSON encoded.

If a phase or variant filter is specified the name of that will not be present in the output. Otherwise this is a nested dictionary of phases and variants.

hopic getinfo [OPTIONS]

Options

-p, --phase <phase>

Build phase

-v, --variant <variant>

Configuration variant

-m, --modality <modality>

Display only meta-data for the specified modality.

--post-submit

Display only post-submit meta-data.

install-extensions

hopic install-extensions [OPTIONS]

Options

--constraints <constraints>

Apply the provided constraints file to pip operations

--upgrade

Request for already installed packages to be upgraded to newer versions, can’t be combined with “constraints” option

may-publish

Check if the target branch name is allowed to be published, according to publish-from-branch in the config file.

hopic may-publish [OPTIONS]

prepare-source-tree

Prepares the source tree for building a change performed by a subcommand.

hopic prepare-source-tree [OPTIONS] COMMAND [ARGS]...

Options

--author-name <name>

Name of change-request’s author

--author-email <email>

E-mail address of change-request’s author

--author-date <date>

Time of last update to the change-request

--commit-date <date>

Time of starting to build this change-request

--bundle <file>

--constraints <file>

Apply the provided constraints file to pip operations

apply-modality-change

Applies the changes specific to the specified modality.

hopic prepare-source-tree apply-modality-change [OPTIONS] MODALITY

Arguments

MODALITY

Required argument

bump-version

Bump the version based on the configuration.

hopic prepare-source-tree bump-version [OPTIONS]

merge-change-request

Merges the change request from the specified branch.

hopic prepare-source-tree merge-change-request [OPTIONS]

Options

--source-remote <url>

<source> remote to merge into <target>

--source-ref <ref>

ref of <source> remote to merge into <target>

--change-request <identifier>

Identifier of change-request to use in merge commit message

--title <title>

Change request title to incorporate in merge commit’s subject line

--description <description>

Change request description to incorporate in merge commit message’s body

--approved-by <approver>

Name of approving reviewer (can be provided multiple times).

show-config

Diagnostic helper command to display the configuration after processing.

hopic show-config [OPTIONS]

show-env

Diagnostic helper command to display the execution environment.

hopic show-env [OPTIONS]

submit

Submit the changes created by prepare-source-tree to the target remote.

hopic submit [OPTIONS]

Options

--target-remote <url>

The remote to push to, if not specified this will default to the checkout remote.

unbundle

Unbundle the specified git bundle and setup all included refs for pushing.

hopic unbundle [OPTIONS] BUNDLE

Arguments

BUNDLE

Required argument

unbundle-worktrees

Unbundle a git bundle and fast-forward all the configured worktrees that are included in it.

hopic unbundle-worktrees [OPTIONS]

Options

--bundle <file>

Git bundle to use