diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index a705a925..71e7aba8 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -1,2 +1,2 @@ # https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/about-code-owners -* @onedr0p @bjw-s @billimek +* @onedr0p @bjw-s @billimek @carpenike diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md index c56d5794..2c97123a 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.md +++ b/.github/ISSUE_TEMPLATE/bug-report.md @@ -2,7 +2,7 @@ name: Bug report about: Create a report to help us improve title: '' -labels: bug +labels: kind:bug assignees: '' --- diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index c08ac045..c3c9d4c8 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,8 +1,8 @@ -blank_issues_enabled: true +blank_issues_enabled: false contact_links: -- name: Ask a question - url: https://github.com/k8s-at-home/charts/discussions - about: Please ask and answer questions here. - name: Discuss on Discord url: https://discord.com/invite/sTMX7Vh about: Join our Discord community +- name: Ask a question + url: https://github.com/k8s-at-home/organization/discussions + about: Please ask and answer questions here. diff --git a/.github/ISSUE_TEMPLATE/feature-request.md b/.github/ISSUE_TEMPLATE/enhancement.md similarity index 95% rename from .github/ISSUE_TEMPLATE/feature-request.md rename to .github/ISSUE_TEMPLATE/enhancement.md index 72fbde2c..2f9b6c34 100644 --- a/.github/ISSUE_TEMPLATE/feature-request.md +++ b/.github/ISSUE_TEMPLATE/enhancement.md @@ -2,7 +2,7 @@ name: Feature request about: Suggest an idea for this project title: '' -labels: enhancement +labels: kind:enhancement assignees: '' --- diff --git a/.github/workflows/charts-helm-docs.yaml b/.github/workflows/charts-helm-docs.yaml index 45bec68f..c3f23d03 100644 --- a/.github/workflows/charts-helm-docs.yaml +++ b/.github/workflows/charts-helm-docs.yaml @@ -17,7 +17,7 @@ jobs: - name: Install Helm uses: azure/setup-helm@v1 with: - version: v3.4.0 + version: v3.5.3 - uses: actions/setup-python@v2 with: @@ -38,11 +38,11 @@ jobs: token: ${{ secrets.GITHUB_TOKEN }} branch: "helm-docs/ci" delete-branch: true - title: "chore(docs) update helm-docs [ci-skip]" + title: "chore(docs): update helm-docs [ci-skip]" signoff: true committer: "${{ github.actor }} <${{ github.actor }}@users.noreply.github.com>" author: "${{ github.actor }} <${{ github.actor }}@users.noreply.github.com>" - commit-message: "chore(docs) update helm-docs [ci-skip]" + commit-message: "chore(docs): update helm-docs [ci-skip]" body: | Signed-off-by: ${{ github.actor }} <${{ github.actor }}@users.noreply.github.com> labels: helm-docs diff --git a/.github/workflows/charts-lint-test.yaml b/.github/workflows/charts-lint-test.yaml index 3fc0ee34..bb9288f3 100644 --- a/.github/workflows/charts-lint-test.yaml +++ b/.github/workflows/charts-lint-test.yaml @@ -24,7 +24,7 @@ jobs: - name: Install Helm uses: azure/setup-helm@v1 with: - version: v3.4.0 + version: v3.5.3 - uses: actions/setup-python@v2 with: @@ -62,7 +62,7 @@ jobs: - name: Install Helm uses: azure/setup-helm@v1 with: - version: v3.4.0 + version: v3.5.3 - name: Install Ruby uses: ruby/setup-ruby@v1 @@ -91,7 +91,7 @@ jobs: - name: Install Helm uses: azure/setup-helm@v1 with: - version: v3.4.0 + version: v3.5.3 - uses: actions/setup-python@v2 with: diff --git a/.github/workflows/charts-release.yaml b/.github/workflows/charts-release.yaml index 7bf18515..3379dcbf 100644 --- a/.github/workflows/charts-release.yaml +++ b/.github/workflows/charts-release.yaml @@ -49,7 +49,7 @@ jobs: - name: Install Helm uses: azure/setup-helm@v1 with: - version: v3.4.0 + version: v3.5.3 - name: Run chart-releaser uses: helm/chart-releaser-action@v1.2.0 diff --git a/.github/workflows/invalid-template.yaml b/.github/workflows/invalid-template.yaml index 57fe3d12..34f96882 100644 --- a/.github/workflows/invalid-template.yaml +++ b/.github/workflows/invalid-template.yaml @@ -13,7 +13,7 @@ jobs: - uses: dessant/support-requests@v2 with: github-token: ${{ secrets.GITHUB_TOKEN }} - support-label: 'invalid:template-incomplete' + support-label: 'kind:invalid-template' issue-comment: > :wave: @{issue-author}, please follow the template provided. close-issue: true diff --git a/.github/workflows/support.yaml b/.github/workflows/support.yaml index f768987c..1f9af0d3 100644 --- a/.github/workflows/support.yaml +++ b/.github/workflows/support.yaml @@ -13,14 +13,15 @@ jobs: - uses: dessant/support-requests@v2 with: github-token: ${{ secrets.GITHUB_TOKEN }} - support-label: 'support' + support-label: 'kind:support' issue-comment: > :wave: @{issue-author}, we use the issue tracker exclusively for bug reports and feature requests. However, this issue appears to be a support request. Please use our support channels - to get help with our Helm charts. + to get help. + - [Docs](https://docs.k8s-at-home.com/) - [Discord](https://discord.gg/sTMX7Vh) - - [GitHub Discussions](https://github.com/k8s-at-home/charts/discussions) + - [GitHub Discussions](https://github.com/k8s-at-home/organization/discussions) close-issue: true lock-issue: false issue-lock-reason: 'off-topic' diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0fc65b2d..796f3cd1 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -39,24 +39,6 @@ See `git help commit`: Once changes have been merged, the release job will automatically run to package and release changed charts. -### Create new chart -``` -# Clone -git clone -cd charts -sh -c "$(curl --location https://taskfile.dev/install.sh)" -- -d -b .bin - -# Create chart -PATH=$PATH:$PWD/.bin -task deps:install -task chart:create CHART=chart_name -# Don't forgot edit some chart informations in charts/char_name/Chart.yaml and charts/char_name/values.yaml - -# Linting -task chart:lint CHART=chart_name -task chart:ct-lint CHART=chart_name -``` - ### Immutability Chart releases must be immutable. Any change to a chart warrants a chart version bump even if it is only changed to the documentation. @@ -70,10 +52,6 @@ Charts should start at `1.0.0`. Any breaking (backwards incompatible) changes to 1. Bump the MAJOR version 2. In the README, under a section called "Upgrading", describe the manual steps necessary to upgrade to the new (specified) MAJOR version -### pre-commit +### Pre-commit This repo supports the [pre-commit](https://pre-commit.com) framework. By installing the framework (see [docs](https://pre-commit.com/#install)) it is possible to perform the chart linting step before committing your code. This can help prevent linter issues in the pipeline. Note that this requires having Docker running on your development environment. - -## Documentation - -See the [Docs](https://docs.k8s-at-home.com/our-helm-charts/getting-started/) for more information. diff --git a/README.md b/README.md index fea15808..0d7ae405 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,10 @@ -# k8s@Home collection of helm charts +# Helm charts -[![Discord](https://img.shields.io/badge/discord-chat-7289DA.svg)](https://discord.com/invite/7PbmHRK) -[![](https://github.com/k8s-at-home/charts/workflows/Release%20Charts/badge.svg?branch=master)](https://github.com/k8s-at-home/charts/actions) -[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit) -[![Artifact Hub](https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/k8s-at-home)](https://artifacthub.io/packages/search?repo=k8s-at-home) -[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) +[![docs](https://img.shields.io/badge/docs-rtfm-yellow?logo=gitbook&logoColor=white&style=for-the-badge)](https://github.com/pre-commit/pre-commit) +[![Discord](https://img.shields.io/badge/discord-chat-7289DA.svg?maxAge=60&style=for-the-badge)](https://discord.gg/sTMX7Vh) +[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white&style=for-the-badge)](https://github.com/pre-commit/pre-commit) +[![renovate](https://img.shields.io/badge/renovate-enabled-brightgreen?style=for-the-badge&logo=data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjUgNSAzNzAgMzcwIj48Y2lyY2xlIGN4PSIxODkiIGN5PSIxOTAiIHI9IjE4NCIgZmlsbD0iI2ZlMiIvPjxwYXRoIGZpbGw9IiM4YmIiIGQ9Ik0yNTEgMjU2bC0zOC0zOGExNyAxNyAwIDAxMC0yNGw1Ni01NmMyLTIgMi02IDAtN2wtMjAtMjFhNSA1IDAgMDAtNyAwbC0xMyAxMi05LTggMTMtMTNhMTcgMTcgMCAwMTI0IDBsMjEgMjFjNyA3IDcgMTcgMCAyNGwtNTYgNTdhNSA1IDAgMDAwIDdsMzggMzh6Ii8+PHBhdGggZmlsbD0iI2Q1MSIgZD0iTTMwMCAyODhsLTggOGMtNCA0LTExIDQtMTYgMGwtNDYtNDZjLTUtNS01LTEyIDAtMTZsOC04YzQtNCAxMS00IDE1IDBsNDcgNDdjNCA0IDQgMTEgMCAxNXoiLz48cGF0aCBmaWxsPSIjYjMwIiBkPSJNMjg1IDI1OGw3IDdjNCA0IDQgMTEgMCAxNWwtOCA4Yy00IDQtMTEgNC0xNiAwbC02LTdjNCA1IDExIDUgMTUgMGw4LTdjNC01IDQtMTIgMC0xNnoiLz48cGF0aCBmaWxsPSIjYTMwIiBkPSJNMjkxIDI2NGw4IDhjNCA0IDQgMTEgMCAxNmwtOCA3Yy00IDUtMTEgNS0xNSAwbC05LThjNSA1IDEyIDUgMTYgMGw4LThjNC00IDQtMTEgMC0xNXoiLz48cGF0aCBmaWxsPSIjZTYyIiBkPSJNMjYwIDIzM2wtNC00Yy02LTYtMTctNi0yMyAwLTcgNy03IDE3IDAgMjRsNCA0Yy00LTUtNC0xMSAwLTE2bDgtOGM0LTQgMTEtNCAxNSAweiIvPjxwYXRoIGZpbGw9IiNiNDAiIGQ9Ik0yODQgMzA0Yy00IDAtOC0xLTExLTRsLTQ3LTQ3Yy02LTYtNi0xNiAwLTIybDgtOGM2LTYgMTYtNiAyMiAwbDQ3IDQ2YzYgNyA2IDE3IDAgMjNsLTggOGMtMyAzLTcgNC0xMSA0em0tMzktNzZjLTEgMC0zIDAtNCAybC04IDdjLTIgMy0yIDcgMCA5bDQ3IDQ3YTYgNiAwIDAwOSAwbDctOGMzLTIgMy02IDAtOWwtNDYtNDZjLTItMi0zLTItNS0yeiIvPjxwYXRoIGZpbGw9IiMxY2MiIGQ9Ik0xNTIgMTEzbDE4LTE4IDE4IDE4LTE4IDE4em0xLTM1bDE4LTE4IDE4IDE4LTE4IDE4em0tOTAgODlsMTgtMTggMTggMTgtMTggMTh6bTM1LTM2bDE4LTE4IDE4IDE4LTE4IDE4eiIvPjxwYXRoIGZpbGw9IiMxZGQiIGQ9Ik0xMzQgMTMxbDE4LTE4IDE4IDE4LTE4IDE4em0tMzUgMzZsMTgtMTggMTggMTgtMTggMTh6Ii8+PHBhdGggZmlsbD0iIzJiYiIgZD0iTTExNiAxNDlsMTgtMTggMTggMTgtMTggMTh6bTU0LTU0bDE4LTE4IDE4IDE4LTE4IDE4em0tODkgOTBsMTgtMTggMTggMTgtMTggMTh6bTEzOS04NWwyMyAyM2M0IDQgNCAxMSAwIDE2TDE0MiAyNDBjLTQgNC0xMSA0LTE1IDBsLTI0LTI0Yy00LTQtNC0xMSAwLTE1bDEwMS0xMDFjNS01IDEyLTUgMTYgMHoiLz48cGF0aCBmaWxsPSIjM2VlIiBkPSJNMTM0IDk1bDE4LTE4IDE4IDE4LTE4IDE4em0tNTQgMThsMTgtMTcgMTggMTctMTggMTh6bTU1LTUzbDE4LTE4IDE4IDE4LTE4IDE4em05MyA0OGwtOC04Yy00LTUtMTEtNS0xNiAwTDEwMyAyMDFjLTQgNC00IDExIDAgMTVsOCA4Yy00LTQtNC0xMSAwLTE1bDEwMS0xMDFjNS00IDEyLTQgMTYgMHoiLz48cGF0aCBmaWxsPSIjOWVlIiBkPSJNMjcgMTMxbDE4LTE4IDE4IDE4LTE4IDE4em01NC01M2wxOC0xOCAxOCAxOC0xOCAxOHoiLz48cGF0aCBmaWxsPSIjMGFhIiBkPSJNMjMwIDExMGwxMyAxM2M0IDQgNCAxMSAwIDE2TDE0MiAyNDBjLTQgNC0xMSA0LTE1IDBsLTEzLTEzYzQgNCAxMSA0IDE1IDBsMTAxLTEwMWM1LTUgNS0xMSAwLTE2eiIvPjxwYXRoIGZpbGw9IiMxYWIiIGQ9Ik0xMzQgMjQ4Yy00IDAtOC0yLTExLTVsLTIzLTIzYTE2IDE2IDAgMDEwLTIzTDIwMSA5NmExNiAxNiAwIDAxMjIgMGwyNCAyNGM2IDYgNiAxNiAwIDIyTDE0NiAyNDNjLTMgMy03IDUtMTIgNXptNzgtMTQ3bC00IDItMTAxIDEwMWE2IDYgMCAwMDAgOWwyMyAyM2E2IDYgMCAwMDkgMGwxMDEtMTAxYTYgNiAwIDAwMC05bC0yNC0yMy00LTJ6Ii8+PC9zdmc+)](https://github.com/renovatebot/renovate) +[![Artifact Hub](https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/k8s-at-home&style=for-the-badge)](https://artifacthub.io/packages/search?repo=k8s-at-home) ## Usage @@ -19,20 +19,13 @@ helm repo add k8s-at-home https://k8s-at-home.com/charts/ You can then run `helm search repo k8s-at-home` to see the charts. -## Charts - -See [Artifact Hub](https://artifacthub.io/packages/search?org=k8s-at-home) or [charts](./charts/) for a complete list. - -## Common library - -The majority of the charts in this repository are using a common library we built. The reason we went with this pattern is a lot of applications are pretty similar in their requirements for Helm charts. Using a library makes maintaining much easier and keeps charts consistent in features. If contributing a new chart first try to make it using the library we built. - -More information can be found in our [wiki](https://github.com/k8s-at-home/charts/wiki) and in the common chart directory [here](https://github.com/k8s-at-home/charts/tree/master/charts/common). - ## Support -- Having problems with a chart? Open a new [issue](https://github.com/k8s-at-home/charts/issues/new/choose) or discuss in our [Discord](https://discord.gg/sTMX7Vh) in the `#support` channel. -- New idea? Discuss [here](https://github.com/k8s-at-home/charts/discussions) or in our [Discord](https://discord.gg/sTMX7Vh) in the `#charts` channel. +We have a few outlets for getting support with our projects: + +- Visit our [Docs](https://docs.k8s-at-home.com/). +- Bugs or feature requests should be opened in an [issue](https://github.com/k8s-at-home/charts/issues/new/choose). +- Questions or comments should be discussed in our [Discord](https://discord.gg/sTMX7Vh) or via [Github discussions](https://github.com/k8s-at-home/organization/discussions). ## Contributing diff --git a/docs/images/vscode_devcontainer_popup.png b/docs/images/vscode_devcontainer_popup.png deleted file mode 100644 index 0ecda7c2..00000000 Binary files a/docs/images/vscode_devcontainer_popup.png and /dev/null differ diff --git a/docs/images/vscode_run_unittests.png b/docs/images/vscode_run_unittests.png deleted file mode 100644 index 1932b7ee..00000000 Binary files a/docs/images/vscode_run_unittests.png and /dev/null differ