diff --git a/.github/ISSUE_TEMPLATE/bug.yaml b/.github/ISSUE_TEMPLATE/bug.yaml index 438da10..7d16fa3 100644 --- a/.github/ISSUE_TEMPLATE/bug.yaml +++ b/.github/ISSUE_TEMPLATE/bug.yaml @@ -1,9 +1,6 @@ name: "🐛 Bug Report" description: Create a new ticket for a bug. -labels: [ - "bug", - "needs triage" -] +labels: ["bug", "needs triage"] body: - type: textarea @@ -58,7 +55,7 @@ body: id: terms attributes: label: Code of Conduct - description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/fonzdm/servarr/CONTRIBUTING.md) + description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/fonzdm/servarr/servarr-chartCONTRIBUTING.md) options: - label: I agree to follow this project's Code of Conduct required: true diff --git a/.github/ISSUE_TEMPLATE/feature.yaml b/.github/ISSUE_TEMPLATE/feature.yaml index 72883ca..5b9e3e5 100644 --- a/.github/ISSUE_TEMPLATE/feature.yaml +++ b/.github/ISSUE_TEMPLATE/feature.yaml @@ -1,9 +1,6 @@ name: "💡 Feature Request" description: Create a new ticket for a new feature request -labels: [ - "enhancement", - "needs triage" -] +labels: ["enhancement", "needs triage"] body: - type: textarea @@ -26,7 +23,7 @@ body: id: terms attributes: label: Code of Conduct - description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/fonzdm/servarr/CONTRIBUTING.md) + description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/fonzdm/servarr/servarr-chartCONTRIBUTING.md) options: - label: I agree to follow this project's Code of Conduct required: true diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index b172b23..75387d4 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,25 +1,26 @@ -* **Please check if the PR fulfills these requirements** -- [ ] The branch naming convention follows our guidelines -- [ ] Docs have been added / updated (for bug fixes / features) +- **Please check if the PR fulfills these requirements** -* **What kind of change does this PR introduce?** (Bug fix, feature, docs update, ...) +* [ ] The branch naming convention follows our guidelines +* [ ] Docs have been added / updated (for bug fixes / features) + +- **What kind of change does this PR introduce?** (Bug fix, feature, docs update, ...) -* **What is the current behavior?** (You can also link to an open issue here) +- **What is the current behavior?** (You can also link to an open issue here) -* **What is the new behavior (if this is a feature change)?** +- **What is the new behavior (if this is a feature change)?** -* **Does this PR introduce a breaking change?** (What changes might users need to make in their application due to this PR?) +- **Does this PR introduce a breaking change?** (What changes might users need to make in their application due to this PR?) -* **Other information**: +- **Other information**: - + diff --git a/.github/workflows/helm-docs.yaml b/.github/workflows/helm-docs.yaml index 4a1b33a..7260379 100644 --- a/.github/workflows/helm-docs.yaml +++ b/.github/workflows/helm-docs.yaml @@ -1,30 +1,29 @@ -name: 'Helm Chart Doc Generator' +name: "Helm Chart Doc Generator" on: push: branches: - - 'dev' - - 'main' + - "dev" + - "main" pull_request: branches: - - 'dev' - - 'main' + - "dev" + - "main" jobs: helm-docs: runs-on: ubuntu-latest steps: + - name: Checkout to current commit + uses: actions/checkout@v4 + with: + ref: ${{ github.head_ref }} + fetch-depth: 0 - - name: Checkout to current commit - uses: actions/checkout@v4 - with: - ref: ${{ github.head_ref }} - fetch-depth: 0 - - - name: Run helm-docs and push to the same branch - uses: losisin/helm-docs-github-action@v1 - with: - git-push: true - git-push-user-name: "Servarr Bot 🤖" - git-push-user-email: "servarr-bot@fonzdm.xyz" - chart-search-root: ./servarr \ No newline at end of file + - name: Run helm-docs and push to the same branch + uses: losisin/helm-docs-github-action@v1 + with: + git-push: true + git-push-user-name: "Servarr Bot 🤖" + git-push-user-email: "servarr-bot@fonzdm.xyz" + chart-search-root: ./servarr/servarr-chart diff --git a/.github/workflows/lint-build.yaml b/.github/workflows/lint-build.yaml index 188dbb5..f7b3a6a 100644 --- a/.github/workflows/lint-build.yaml +++ b/.github/workflows/lint-build.yaml @@ -3,11 +3,11 @@ name: Helm Chart Lint & Build on: push: branches: - - 'dev' + - "dev" pull_request: branches: - - 'dev' - - 'main' + - "dev" + - "main" jobs: lint: @@ -35,7 +35,7 @@ jobs: uses: helm/chart-testing-action@v2.6.1 - name: Run chart-testing (lint) - run: ct lint --chart-dirs=servarr/ --charts=servarr/ --validate-maintainers=false + run: ct lint --chart-dirs=servarr/servarr-chart --charts=servarr/servarr-chart --validate-maintainers=false build: name: build @@ -51,10 +51,10 @@ jobs: uses: azure/setup-helm@v4.1.0 - name: Helm Dependency update - run: helm dependency update servarr/ --debug + run: helm dependency update servarr/servarr-chart --debug - name: Helm Template - run: helm template servarr servarr/ --debug -f .github/ci/ci-values.yaml + run: helm template servarr servarr/servarr-chart --debug -f .github/ci/ci-values.yaml - name: Create Package - run: helm package servarr/ + run: helm package servarr/servarr-chart diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml new file mode 100644 index 0000000..4f15f1e --- /dev/null +++ b/.github/workflows/release.yaml @@ -0,0 +1,35 @@ +name: Release Charts + +on: + push: + branches: + - main + +jobs: + release: + # depending on default permission settings for your org (contents being read-only or read-write for workloads), you will have to add permissions + # see: https://docs.github.com/en/actions/security-guides/automatic-token-authentication#modifying-the-permissions-for-the-github_token + permissions: + contents: write + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v3 + with: + fetch-depth: 0 + + - name: Configure Git + run: | + git config user.name "$GITHUB_ACTOR" + git config user.email "$GITHUB_ACTOR@users.noreply.github.com" + + - name: Install Helm + uses: azure/setup-helm@v3 + + - name: Run chart-releaser + uses: helm/chart-releaser-action@v1.6.0 + with: + charts_dir: servarr + pages_branch: charts + env: + CR_TOKEN: "${{ secrets.GITHUB_TOKEN }}" diff --git a/.github/workflows/static.yaml b/.github/workflows/static.yaml new file mode 100644 index 0000000..9f275ad --- /dev/null +++ b/.github/workflows/static.yaml @@ -0,0 +1,43 @@ +# Simple workflow for deploying static content to GitHub Pages +name: Deploy static content to Pages + +on: + # Runs on pushes targeting the default branch + push: + branches: ["charts"] + + # Allows you to run this workflow manually from the Actions tab + workflow_dispatch: + +# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages +permissions: + contents: read + pages: write + id-token: write + +# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued. +# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete. +concurrency: + group: "pages" + cancel-in-progress: false + +jobs: + # Single deploy job since we're just deploying + deploy: + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v4 + - name: Setup Pages + uses: actions/configure-pages@v5 + - name: Upload artifact + uses: actions/upload-pages-artifact@v3 + with: + # Upload entire repository + path: "." + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v4 diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 352b501..4364a8b 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -5,5 +5,5 @@ repos: - id: helm-docs-container args: # Use root folder as the main repo dir is the chart itself - - --chart-search-root=servarr - - --template-files=README.md.gotmpl \ No newline at end of file + - --chart-search-root=servarr/servarr-chart + - --template-files=README.md.gotmpl diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4b64bfc..1fcab64 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,17 +1,17 @@ # Contributing -When contributing to this repository, please first discuss the change you wish to make via [issue](https://github.com/fonzdm/servarr/issues), email, or any other method with the owners of this repository before making a change. +When contributing to this repository, please first discuss the change you wish to make via [issue](https://github.com/fonzdm/servarr/servarr-chartissues), email, or any other method with the owners of this repository before making a change. Please note we have a code of conduct, please follow it in all your interactions with the project. ## Branch naming convention -| Instance | Branch Name | Description | -|----------|:-----------:|-------------| -| Stable | `main` | Accepts merges from Working and Hotfixes | -| Working | `dev` | Accepts merges from Features/Issues and Hotfixes | -| Feature/Issue | `feat/feature-name` or `fix/bug-name` | Always branch off HEAD of Working | -| Hotfix | `hotfix/hotfix-name` | Always branch off Stable | +| Instance | Branch Name | Description | +| ------------- | :-----------------------------------: | ------------------------------------------------ | +| Stable | `main` | Accepts merges from Working and Hotfixes | +| Working | `dev` | Accepts merges from Features/Issues and Hotfixes | +| Feature/Issue | `feat/feature-name` or `fix/bug-name` | Always branch off HEAD of Working | +| Hotfix | `hotfix/hotfix-name` | Always branch off Stable | ## Merge Request Process diff --git a/README.md b/README.md index 969e582..9fe2705 100644 --- a/README.md +++ b/README.md @@ -22,10 +22,10 @@ $ git clone https://github.com/fonzdm/servarr.git && cd servarr ``` 2. Prepare your [`values.yaml`](#values) -3. Try it in your cluster to check that everything is fine (replace the `servarr/` with the chart folder if your workdir is different): +3. Try it in your cluster to check that everything is fine (replace the `servarr/servarr-chart` with the chart folder if your workdir is different): ```shell -$ helm install servarr-dev servarr/ \ +$ helm install servarr-dev servarr/servarr-chart \ --namespace servarr-dev \ --create-namespace \ --values values.yaml @@ -44,7 +44,7 @@ $ helm install \ ### Values -Please read [Helm Chart README.md](./servarr/README.md) for details on how to configure the values needed for this chart. +Please read [Helm Chart README.md](./servarr/servarr-chartREADME.md) for details on how to configure the values needed for this chart. ## Contributing @@ -52,15 +52,15 @@ Please read [CONTRIBUTING.md](./CONTRIBUTING.md) for details on our code of cond ## Contributors - + -See the full list of [contributors](https://github.com/fonzdm/servarr/contributors) who participated in this project. +See the full list of [contributors](https://github.com/fonzdm/servarr/servarr-chartcontributors) who participated in this project. ## Versioning -We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [releases on this repository](https://github.com/fonzdm/servarr/releases). +We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [releases on this repository](https://github.com/fonzdm/servarr/servarr-chartreleases). ###### Keep in mind that each dependency has its own author and their contributors. Please, reach them out on their repositories. diff --git a/servarr/.helmignore b/servarr/servarr-chart/.helmignore similarity index 100% rename from servarr/.helmignore rename to servarr/servarr-chart/.helmignore diff --git a/servarr/Chart.yaml b/servarr/servarr-chart/Chart.yaml similarity index 100% rename from servarr/Chart.yaml rename to servarr/servarr-chart/Chart.yaml diff --git a/servarr/README.md b/servarr/servarr-chart/README.md similarity index 100% rename from servarr/README.md rename to servarr/servarr-chart/README.md diff --git a/servarr/README.md.gotmpl b/servarr/servarr-chart/README.md.gotmpl similarity index 100% rename from servarr/README.md.gotmpl rename to servarr/servarr-chart/README.md.gotmpl diff --git a/servarr/config/scripts/init-jellyfin.py b/servarr/servarr-chart/config/scripts/init-jellyfin.py similarity index 100% rename from servarr/config/scripts/init-jellyfin.py rename to servarr/servarr-chart/config/scripts/init-jellyfin.py diff --git a/servarr/config/scripts/init-jellyseerr.py b/servarr/servarr-chart/config/scripts/init-jellyseerr.py similarity index 100% rename from servarr/config/scripts/init-jellyseerr.py rename to servarr/servarr-chart/config/scripts/init-jellyseerr.py diff --git a/servarr/config/scripts/init-prowlarr.py b/servarr/servarr-chart/config/scripts/init-prowlarr.py similarity index 100% rename from servarr/config/scripts/init-prowlarr.py rename to servarr/servarr-chart/config/scripts/init-prowlarr.py diff --git a/servarr/config/scripts/init-qbittorrent.py b/servarr/servarr-chart/config/scripts/init-qbittorrent.py similarity index 100% rename from servarr/config/scripts/init-qbittorrent.py rename to servarr/servarr-chart/config/scripts/init-qbittorrent.py diff --git a/servarr/config/scripts/init-radarr.py b/servarr/servarr-chart/config/scripts/init-radarr.py similarity index 100% rename from servarr/config/scripts/init-radarr.py rename to servarr/servarr-chart/config/scripts/init-radarr.py diff --git a/servarr/config/scripts/init-sonarr.py b/servarr/servarr-chart/config/scripts/init-sonarr.py similarity index 100% rename from servarr/config/scripts/init-sonarr.py rename to servarr/servarr-chart/config/scripts/init-sonarr.py diff --git a/servarr/templates/configmaps.yaml b/servarr/servarr-chart/templates/configmaps.yaml similarity index 100% rename from servarr/templates/configmaps.yaml rename to servarr/servarr-chart/templates/configmaps.yaml diff --git a/servarr/templates/init-jellyfin.yaml b/servarr/servarr-chart/templates/init-jellyfin.yaml similarity index 100% rename from servarr/templates/init-jellyfin.yaml rename to servarr/servarr-chart/templates/init-jellyfin.yaml diff --git a/servarr/templates/init-jellyseerr.yaml b/servarr/servarr-chart/templates/init-jellyseerr.yaml similarity index 100% rename from servarr/templates/init-jellyseerr.yaml rename to servarr/servarr-chart/templates/init-jellyseerr.yaml diff --git a/servarr/templates/init-prowlarr.yaml b/servarr/servarr-chart/templates/init-prowlarr.yaml similarity index 100% rename from servarr/templates/init-prowlarr.yaml rename to servarr/servarr-chart/templates/init-prowlarr.yaml diff --git a/servarr/templates/init-radarr.yaml b/servarr/servarr-chart/templates/init-radarr.yaml similarity index 100% rename from servarr/templates/init-radarr.yaml rename to servarr/servarr-chart/templates/init-radarr.yaml diff --git a/servarr/templates/init-sonarr.yaml b/servarr/servarr-chart/templates/init-sonarr.yaml similarity index 100% rename from servarr/templates/init-sonarr.yaml rename to servarr/servarr-chart/templates/init-sonarr.yaml diff --git a/servarr/templates/issuer.yaml b/servarr/servarr-chart/templates/issuer.yaml similarity index 100% rename from servarr/templates/issuer.yaml rename to servarr/servarr-chart/templates/issuer.yaml diff --git a/servarr/templates/pre-deployment-job.yaml b/servarr/servarr-chart/templates/pre-deployment-job.yaml similarity index 100% rename from servarr/templates/pre-deployment-job.yaml rename to servarr/servarr-chart/templates/pre-deployment-job.yaml diff --git a/servarr/templates/pvc.yaml b/servarr/servarr-chart/templates/pvc.yaml similarity index 100% rename from servarr/templates/pvc.yaml rename to servarr/servarr-chart/templates/pvc.yaml diff --git a/servarr/templates/secret.yaml b/servarr/servarr-chart/templates/secret.yaml similarity index 100% rename from servarr/templates/secret.yaml rename to servarr/servarr-chart/templates/secret.yaml diff --git a/servarr/values.yaml b/servarr/servarr-chart/values.yaml similarity index 100% rename from servarr/values.yaml rename to servarr/servarr-chart/values.yaml