search

karmada-io / karmada

Open, Multi-Cloud, Multi-Cluster Kubernetes Orchestration
https://karmada.io
Apache License 2.0
4.4k stars 869 forks source link

Automated Release of Helm Chart to GitHub Pages #4670

Open a7i opened 6 months ago

a7i commented 6 months ago

What would you like to be added: Automated release of helm charts

I created it for GitHub pages in my fork: https://a7i.github.io/karmada

GitHub Actions

Why is this needed: We typically have to create a follow-up PR after each release to update the chart

XiShanYongYe-Chang commented 6 months ago

In favor of #4671 /assign @a7i

a7i commented 6 months ago

@XiShanYongYe-Chang who is a GitHub admin with permissions to do the following first:

You may choose a custom domain, if you wish.

a7i commented 6 months ago

Also outlined here: https://github.com/helm/chart-releaser-action?tab=readme-ov-file#pre-requisites

XiShanYongYe-Chang commented 6 months ago

/cc @RainbowMango

RainbowMango commented 6 months ago

Let me try to understand this work. Now the charts are released to master branch as documented at Remote installation.

The pain is that we have to manually release each chart, just like we did at #4671.

The helm/chart-releaser can help to release the chart automatically, but it can only release to another branch(it is the gh-pages) instead of master, and that's why we need to create a new branch, am I right?

And I also have some questions:

In addition, we also got suggestions about release charts to https://artifacthub.io/, (guidelines see here). @a7i Since you are the expert on the Helm chart, I'd like to hear your opinions about this approach.

liangyuanpeng commented 6 months ago

In addition, we also got suggestions about release charts to https://artifacthub.io/,

Artifacthub just show something, it do not storage the helm charts, so we need to release helm chart to ghpage or oci registry.

We're already relaese helm chart to oci registry (dockerhub), see https://hub.docker.com/r/karmada/karmada/tags ,This workflow is working for it: https://github.com/karmada-io/karmada/blob/master/.github/workflows/dockerhub-released-chart.yml.

And we still need to release this to gh page?

a7i commented 6 months ago

chart-releaser supports a flag to specify a branch, but I would be hesitant to have CI automatically push to the main branch.

I did not realize that karmada publishes the chart to dockerhub, that will satisfy my use-case. thank you!

Feel free to close this PR, if you see fit.

RainbowMango commented 6 months ago

@liangyuanpeng Do you think we need to update the documents about the oci registry?