fix: final adjustments and docs

canonical · Feb 6, 2025 · f07a1de · f07a1de
1 parent bb6a168
commit f07a1de
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 3 deletions.
diff --git a/.github/workflows/Build-Rock.yaml b/.github/workflows/Build-Rock.yaml
@@ -39,9 +39,9 @@ on:
     secrets:
       # authentication parameters
       host-github-token:
-        description: "Github token for operating in private repositories"
+        description: "Github token for operating in a private repository."
       source-github-token:
-        description: "Github token for pulling from private repositories"
+        description: "Github token for pulling from private repositories."
 env:
   ROCK_REPO_DIR: rock-repo  # path where the image repo is cloned into
   ROCK_CI_FOLDER: ci-rocks  # path of uploaded/downloaded artifacts

diff --git a/.github/workflows/Test-Rock.yaml b/.github/workflows/Test-Rock.yaml
@@ -48,7 +48,7 @@ on:
     secrets:
       # authentication parameters
       host-github-token:
-        description: "Github token for operating in private repositories"
+        description: "Github token for operating in a private repository."
 
 env:
   VULNERABILITY_REPORT_SUFFIX: ".vulnerability-report.json"  # TODO: inherit string from caller

diff --git a/README.md b/README.md
@@ -418,6 +418,12 @@ supported through Launchpad build services.
 | `arch-map` | False | JSON str | JSON string mapping target architecture to runners. |
 | `lpci-fallback` | False | bool | Enable fallback to Launchpad build when runners for target arch are not available. |
 
+**Workflow Secrets:**
+| Property | Required | Description |
+|---|---|---|
+| `source-github-token` | False | Github token for pulling from private repositories.|
+| `host-github-token` | False | Github token for operating in a private repository. |
+
 ### Test-Rock Workflow
 
 The [Test-Rock workflow](.github/workflows/Test-Rock.yaml)
@@ -458,3 +464,8 @@ needed.
 |`test-vulnerabilities`| False | bool | Enable Trivy vulnerability test. Enabled by default. |
 |`trivyignore-path`| False | str | Optional path to `.trivyignore` file used in vulnerability scan. |
 |`test-malware`| False | bool | Enable ClamAV malware test. Enabled by default. |
+
+**Workflow Secrets:**
+| Property | Required | Description |
+|---|---|---|
+| `host-github-token` | False  | Github token for operating in a private repository.|