Fix the labels configuration docs

canonical · Sep 18, 2024 · 8f6b30a · 8f6b30a
1 parent d6c89c9
commit 8f6b30a
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 7 deletions.
diff --git a/config.yaml b/config.yaml
@@ -69,9 +69,9 @@ options:
     default: ""
     description: >-
       Additional comma separated labels to attach to self-hosted runners. By default, the labels
-      "self-hosted", application name (default: "github-runner"),
-      architecture (i.e. "x64", "arm64"), os (i.e. "linux"), os-flavor (i.e. "jammy") are set.
-      Any labels provided via this configuration will be appended to the default values.
+      "self-hosted", architecture (i.e. "x64", "arm64"), os (i.e. "linux"), os-flavor (i.e. 
+      "jammy") are set. Any labels provided via this configuration will be appended to the default 
+      values.
   path:
     type: string
     default: ""

diff --git a/docs/tutorial/quick-start.md b/docs/tutorial/quick-start.md
@@ -60,9 +60,7 @@ The charm will spawn new runners on a schedule. During this time, the charm will
 
 Once the self-hosted runner is available on GitHub, it can be used to run GitHub Actions jobs similar to runners provided by GitHub. The only difference being the label specified in the `runs-on` of a job.
 
-The self-hosted runner managed by the charm will have the following labels: `self-hosted`, `linux`, the application name, and labels from the [`labels` charm configuration](https://charmhub.io/github-runner/configurations#labels).
-
-In the above deployment, the application name was not specified, hence the default value of `github-runner` was used. As such, `github-runner` will be a label for the self-hosted runner managed by the application instance.
+In addition to the labels added by the GitHub runner application by default, the charm will include labels from the [`labels` charm configuration](https://charmhub.io/github-runner/configurations#labels).
 
 To test out the self-hosted runner, create the following file under the path `.github/workflows/runner_test.yaml` in the repository with the following content:
 
@@ -74,7 +72,7 @@ on:
 
 jobs:
   hello-world-test:
-    runs-on: [self-hosted, github-runner]
+    runs-on: [self-hosted]
     steps:
         - run: echo "hello world"
 ```