The CLI Client

.github/workflows/_CLI-Client.yaml

@@ -0,0 +1,23 @@
+name: CLI-Client
+on:
+  push:
+    paths:
+      - "src/cli-client/**"
+  pull_request:
+    paths:
+      - "src/cli-client/**"
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    name: Test
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Go 1.22
+        uses: actions/setup-go@v2
+        with:
+          go-version: 1.22
+      - name: Test
+        working-directory: src/cli-client
+        run: |
+          go test ./...

.github/workflows/_Test-OCI-Factory.yaml

@@ -8,10 +8,12 @@ on:
       - "!.github/workflows/PR-Validator.yaml"
       - "!.github/workflows/_Auto-updates.yaml"
       - "!.github/workflows/Continuous-Testing.yaml"
+      - "!.github/workflows/CLI-Client.yaml"
       - "examples/**"
       - "oci/mock*"
       - "src/**"
       - "!src/workflow-engine/**"
+      - "!src/cli-client/**"
 
 jobs:
   test-workflows:

README.md

@@ -70,7 +70,12 @@ Pull Requests 🚀.
 
 ### As a **Maintainer** ⛏ 🪨
 
-Maintainers shall use Pull Requests (PRs) as an interface for asking the OCI
+Maintainers can request new image builds and releases by either creating
+Pull Requests (PRs) or via the OCI Factory CLI Client.
+
+#### 1. With Pull Requests
+
+Maintainers can use Pull Requests (PRs) as an interface for asking the OCI
 Factory to build their images. Here's what you should do and know before you
 make your first PR as a Maintainer:
 
@@ -84,6 +89,25 @@ multiple images;
    - that means one PR can only propose changes to
 [Maintainer files](#maintainer-files) within a single `oci` folder.
 
+#### 2. With the CLI Client
+
+Maintainers can use the OCI Factory's CLI Client to interact with the OCI
+Factory. The CLI Client is a Go module at [src/cli-client](src/cli-client).
+
+Here's what you should do and know before you use the CLI Client:
+
+1. you **must** already be an onboarded Maintainer and have had significant
+interactions with the OCI Factory (via PRs). Why is that? To use this client
+you'll be granted write permissions to the repository, and thus you'll have
+escalated rights when compared to a regular Maintainer - with great power
+comes great maintainability,
+2. each use of the CLI Client **must** only target one version of an OCI image,
+i.e. you can ask the OCI Factory to build one version of the image, upload and
+release it to GHCR, Docker Hub, and ECR with different tracks, risks and EOL with
+a single command, but **not** multiple versions of the same image.
+
+Further documentation regarding the CLI Client can be found [here](src/cli-client/README.md).
+
 Refer to the diagram below to understand the oci-factory workflow:
 ![OCI Factory Workflow](assets/img/oci-factory-workflow.png)
 

src/cli-client/README.md

@@ -0,0 +1,68 @@
+
+# The OCI Factory CLI Client
+
+A CLI client that triggers GitHub workflows for building, uploading and releasing images in 
+[OCI Factory](https://github.com/canonical/oci-factory).
+
+## How to use
+
+### New User
+
+See ["How to Contribute as a Maintainer"](https://github.com/canonical/oci-factory?tab=readme-ov-file#as-a-maintainer--).
+
+Upon finishing the onboarding, the user should receive a GitHub Personal Access Token. This token grants you proper
+permissions to trigger the build, upload and release of your rocks. This token should never be shared with 
+third-parties, nor put anywhere that is publicly available.
+
+The user will be asked to input the GitHub Personal Access Token upon triggering a workflow. For a non-interactive
+terminal, 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
+
+```bash
+sudo snap install oci-factory
+```
+
+### Install using Go
+
+#### Dependencies
+
+```bash
+# install git
+sudo apt update && sudo apt install -y git
+```
+
+Golang-go can be installed either with APT or Snap:
+
+```bash
+# install golang-go with apt
+sudo apt update && sudo apt install -y golang-go
+```
+
+```bash
+# install golang-go with snap
+sudo snap install go --classic
+```
+
+#### Install the CLI client
+```bash
+go install github.com/canonical/oci-factory/src/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.
+```bash
+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
+
+```bash
+export LOGGER_DEBUG=1
+```

src/cli-client/cmd/oci-factory/main.go

@@ -0,0 +1,14 @@
+package main
+
+import (
+	"fmt"
+	"os"
+
+	"github.com/canonical/oci-factory/src/cli-client/internals/cli"
+	"github.com/canonical/oci-factory/src/cli-client/internals/logger"
+)
+
+func main() {
+	logger.SetLogger(logger.New(os.Stderr, fmt.Sprintf("[%s] ", "oci-factory")))
+	cli.CliMain()
+}

src/cli-client/go.mod

@@ -0,0 +1,44 @@
+module github.com/canonical/oci-factory/src/cli-client
+
+go 1.22.3
+
+require (
+	dario.cat/mergo v1.0.0 // indirect
+	github.com/Microsoft/go-winio v0.6.1 // indirect
+	github.com/ProtonMail/go-crypto v1.0.0 // indirect
+	github.com/briandowns/spinner v1.23.0 // indirect
+	github.com/canonical/go-flags v0.0.0-20230403090104-105d09a091b8 // indirect
+	github.com/cloudflare/circl v1.3.7 // indirect
+	github.com/cyphar/filepath-securejoin v0.2.4 // indirect
+	github.com/emirpasic/gods v1.18.1 // indirect
+	github.com/fatih/color v1.7.0 // indirect
+	github.com/go-git/gcfg v1.5.1-0.20230307220236-3a3c6141e376 // indirect
+	github.com/go-git/go-billy/v5 v5.5.0 // indirect
+	github.com/go-git/go-git/v5 v5.12.0 // indirect
+	github.com/golang/groupcache v0.0.0-20210331224755-41bb18bfe9da // indirect
+	github.com/jbenet/go-context v0.0.0-20150711004518-d14ea06fba99 // indirect
+	github.com/kevinburke/ssh_config v1.2.0 // indirect
+	github.com/kr/pretty v0.3.1 // indirect
+	github.com/kr/text v0.2.0 // indirect
+	github.com/mattn/go-colorable v0.1.2 // indirect
+	github.com/mattn/go-isatty v0.0.8 // indirect
+	github.com/mitchellh/go-homedir v1.1.0 // indirect
+	github.com/pjbgf/sha1cd v0.3.0 // indirect
+	github.com/rogpeppe/go-internal v1.11.0 // indirect
+	github.com/sergi/go-diff v1.3.2-0.20230802210424-5b0b94c5c0d3 // indirect
+	github.com/skeema/knownhosts v1.2.2 // indirect
+	github.com/src-d/gcfg v1.4.0 // indirect
+	github.com/xanzy/ssh-agent v0.3.3 // indirect
+	golang.org/x/crypto v0.24.0 // indirect
+	golang.org/x/exp v0.0.0-20240613232115-7f521ea00fb8 // indirect
+	golang.org/x/mod v0.18.0 // indirect
+	golang.org/x/net v0.26.0 // indirect
+	golang.org/x/sys v0.21.0 // indirect
+	golang.org/x/term v0.21.0 // indirect
+	golang.org/x/tools v0.22.0 // indirect
+	gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c // indirect
+	gopkg.in/src-d/go-billy.v4 v4.3.2 // indirect
+	gopkg.in/src-d/go-git.v4 v4.13.1 // indirect
+	gopkg.in/warnings.v0 v0.1.2 // indirect
+	gopkg.in/yaml.v3 v3.0.1 // indirect
+)