Skip to content

Commit 206c50d

Browse files
authored
updated readme to include packaging + publishing notes (#204)
* removed test template * updated readme to include packaging + publishing
1 parent 9c82345 commit 206c50d

5 files changed

Lines changed: 26 additions & 12 deletions

File tree

README.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -120,6 +120,32 @@ Always build connection strings using the naming helpers from `_helpers.tpl` rat
120120

121121
---
122122

123+
## Packaging and Publishing
124+
125+
Each template version is packaged as a Helm chart and published to the GitHub Container Registry (GHCR) as an OCI artifact. Published packages are visible in the **Packages** tab of this repository, and each one can be referenced directly when installing via the Control Plane CLI — no need to clone the repo.
126+
127+
### Automatic publishing
128+
129+
A GitHub Actions workflow (`.github/workflows/publish-charts.yml`) runs on every push to `main`. It detects which `Chart.yaml` files changed in that commit and packages and pushes only those template versions to:
130+
131+
```
132+
oci://ghcr.io/controlplane-com/templates
133+
```
134+
135+
This means **adding a new template version to `main` is all that is needed** — it will be packaged automatically and immediately available via OCI.
136+
137+
### Manual publishing (migration)
138+
139+
The workflow can also be triggered manually via **Actions → Publish Helm Charts → Run workflow** with the **"Package all charts (migration mode)"** option enabled. This packages and pushes **every version of every template** and is intended only for bulk migration of existing templates — not for re-publishing a single changed version.
140+
141+
> **Important:** If a template version that was already published needs to be corrected, do **not** use migration mode (it would re-push all templates). Instead, package and push that specific chart manually using `helm package` and `helm push`, then ensure the resulting package is set to **public** and attached to this repository in the Packages tab.
142+
143+
### Installing a template via OCI
144+
145+
Each published template version is available in the **Packages** tab of this repository and can be installed directly via the Control Plane CLI without cloning the repo. For detailed installation instructions, see the [CLI install guide](https://docs.controlplane.com/template-catalog/install-manage/cli).
146+
147+
---
148+
123149
## Checklist for Creating a New Template
124150

125151
- [ ] `icon.png` — square, transparent background

test/icon.png

-22.9 KB
Binary file not shown.

test/versions/1.0.0/Chart.yaml

Lines changed: 0 additions & 12 deletions
This file was deleted.

test/versions/1.0.0/README.md

Whitespace-only changes.

test/versions/1.0.0/values.yaml

Whitespace-only changes.

0 commit comments

Comments
 (0)