Skip to content

Latest commit

 

History

History
68 lines (48 loc) · 1.92 KB

README.md

File metadata and controls

68 lines (48 loc) · 1.92 KB
Raw

The OCI Factory CLI Client

A CLI client that triggers GitHub workflows for building, uploading and releasing images in OCI Factory.

How to use

New User

See "How to Contribute as a Maintainer".

Upon finishing the onboarding, the user should add their GitHub username to the contacts.yaml file in the maintainers field field of the corresponding rock. This field is a list of GitHub usernames that are allowed to trigger the build, upload, and release workflows. The onboarded user needs to generate a GitHub Personal Access Token to authenticate themselves when using the CLI client.

For a non-interactive terminal of the CLI client, it is possible to assign the token to the environmental variable export GITHUB_TOKEN=<your token>, and pass -y to confirm the triggering by default.

Install using Snap

sudo snap install oci-factory

Install using Go

Dependencies

# install git
sudo apt update && sudo apt install -y git

Golang-go can be installed either with APT or Snap:

# install golang-go with apt
sudo apt update && sudo apt install -y golang-go
# install golang-go with snap
sudo snap install go --classic

Install the CLI client

go install github.com/canonical/oci-factory/tools/cli-client/cmd/oci-factory

Triggering workflows

Note: The workflow can only be triggered for the rocks owned by Canonical, i.e., whose repository belong to the organization Canonical in GitHub.

cd <directory containing rockcraft.yaml>
# Run `oci-factory upload --help` for more help
oci-factory upload --release track=<release track>,risks=<risk1>[,<risk2>...],eol=yyyy-mm-dd

How to debug the CLI client

The debug log can be enabled with the following command

export LOGGER_DEBUG=1