The CLI Client

.github/workflows/CLI-Client.yaml → .github/workflows/_CLI-Client.yaml

@@ -18,6 +18,6 @@ jobs:
         with:
           go-version: 1.22
       - name: Test
+        working-directory: src/cli-client
         run: |
-          cd src/cli-client
           go test ./...

README.md

@@ -70,7 +70,8 @@ Pull Requests 🚀.
 
 ### As a **Maintainer** ⛏ 🪨
 
-There are two ways to use the OCI Factory to build the images.
+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
 
@@ -93,11 +94,13 @@ multiple images;
 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 to trigger
-the first build of your image:
+Here's what you should do and know before you use the CLI Client:
 
-1. you are onboard as a Maintainer, and have received your token to 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

src/cli-client/README.md

@@ -18,10 +18,35 @@ The user will be asked to input the GitHub Personal Access Token upon triggering
 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.
 
-### Installation
+### 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
+```
+
+Now install the CLI client
 ```bash
-git clone https://github.com/canonical/oci-factory.git
-cd oci-factory/src/cli-client
 go install github.com/canonical/oci-factory/src/cli-client/cmd/oci-factory
 ```
 

src/cli-client/snap/snapcraft.yaml

@@ -13,15 +13,9 @@ parts:
   oci-factory:
     plugin: go
     build-snaps: [go/latest/stable]
-    source: https://github.com/canonical/oci-factory
-    source-type: git
-    source-subdir: src/cli-client/cmd/oci-factory
+    source: .
     stage-packages:
       - git
-    # TODO remove this override-pull when the branch is merged
-    override-pull: |
-      snapcraftctl pull
-      git checkout ROCKS-1216-cli-client
 
 apps:
   oci-factory: