Skip to content

Commit d9507db

Browse files
committed
fix: update installation instructions
1 parent c42026e commit d9507db

File tree

1 file changed

+14
-20
lines changed

1 file changed

+14
-20
lines changed

README.md

Lines changed: 14 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,8 @@
22

33
This Helm chart deploys [GARM (GitHub/Gitea Actions Runner Manager)](https://github.com/cloudbase/garm) on a Kubernetes cluster.
44

5-
> **Note:** This is an unofficial Helm chart and is not affiliated with the GARM project. Please do not open issues regarding this chart in the official GARM repository.
5+
> [!NOTE]
6+
> This is an unofficial Helm chart and is not affiliated with the GARM project. Please do not open issues regarding this chart in the official GARM repository.
67
78
## Chart Status & Expectations
89

@@ -18,17 +19,10 @@ This chart uses an operator-like pattern, launching two pods:
1819

1920
## Installation
2021

21-
> This chart is not yet available on a public chart repository like Artifact Hub.
22-
23-
1. Clone this repository:
24-
```bash
25-
git clone <repository-url>
26-
cd garm-helm-chart
27-
```
28-
2. Create a copy of `values.yaml` (e.g., `my-values.yaml`) and customize it for your environment.
29-
3. Install the chart:
22+
1. Create a copy of `values.yaml` (e.g., `my-values.yaml`) and customize it for your environment.
23+
2. Install the chart:
3024
```bash
31-
helm install -f my-values.yaml my-garm .
25+
helm install -f my-values.yaml my-garm oci://ghcr.io/igrikus/garm
3226
```
3327

3428
## Configuration
@@ -60,14 +54,14 @@ When you create a pull request, please make sure your commit messages are struct
6054
6155
**Common commit types:**
6256
63-
* **feat**: A new feature. (Triggers a `minor` version release)
64-
* **fix**: A bug fix. (Triggers a `patch` version release)
65-
* **docs**: Documentation only changes. (No release)
66-
* **style**: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc). (No release)
67-
* **refactor**: A code change that neither fixes a bug nor adds a feature. (No release)
68-
* **perf**: A code change that improves performance. (No release)
69-
* **test**: Adding missing tests or correcting existing tests. (No release)
70-
* **chore**: Changes to the build process or auxiliary tools and libraries such as documentation generation. (No release)
57+
- **feat**: A new feature. (Triggers a `minor` version release)
58+
- **fix**: A bug fix. (Triggers a `patch` version release)
59+
- **docs**: Documentation only changes. (No release)
60+
- **style**: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc). (No release)
61+
- **refactor**: A code change that neither fixes a bug nor adds a feature. (No release)
62+
- **perf**: A code change that improves performance. (No release)
63+
- **test**: Adding missing tests or correcting existing tests. (No release)
64+
- **chore**: Changes to the build process or auxiliary tools and libraries such as documentation generation. (No release)
7165
7266
To indicate a **breaking change** (which triggers a `major` version release), add a `!` after the type (e.g., `feat!:`) or include `BREAKING CHANGE:` in the commit message footer.
7367
@@ -77,4 +71,4 @@ To indicate a **breaking change** (which triggers a `major` version release), ad
7771
feat: Add option to configure runner liveness probe
7872
```
7973
80-
Following this convention is crucial as it directly controls the versioning and release notes for the chart.
74+
Following this convention is crucial as it directly controls the versioning and release notes for the chart.

0 commit comments

Comments
 (0)