Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Introduce workflow to use this repo as Helm repo #26

Closed
wants to merge 9 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 2 additions & 5 deletions .github/ISSUE_TEMPLATE/bug.yaml
Original file line number Diff line number Diff line change
@@ -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
Expand Down Expand Up @@ -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
7 changes: 2 additions & 5 deletions .github/ISSUE_TEMPLATE/feature.yaml
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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
19 changes: 10 additions & 9 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -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, ...)

<placeholder>

* **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)

<placeholder>

* **What is the new behavior (if this is a feature change)?**
- **What is the new behavior (if this is a feature change)?**

<placeholder>

* **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?)

<placeholder>

* **Other information**:
- **Other information**:

<placeholder>

<!-- By submitting this Pull Request, you agree to follow our [Code of Conduct](https://github.com/fonzdm/servarr/CONTRIBUTING.md) -->
<!-- By submitting this Pull Request, you agree to follow our [Code of Conduct](https://github.com/fonzdm/servarr/servarr-chartCONTRIBUTING.md) -->
35 changes: 17 additions & 18 deletions .github/workflows/helm-docs.yaml
Original file line number Diff line number Diff line change
@@ -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: "[email protected]"
chart-search-root: ./servarr
- 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: "[email protected]"
chart-search-root: ./servarr/servarr-chart
14 changes: 7 additions & 7 deletions .github/workflows/lint-build.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,11 @@ name: Helm Chart Lint & Build
on:
push:
branches:
- 'dev'
- "dev"
pull_request:
branches:
- 'dev'
- 'main'
- "dev"
- "main"

jobs:
lint:
Expand Down Expand Up @@ -35,7 +35,7 @@ jobs:
uses: helm/[email protected]

- 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
Expand All @@ -51,10 +51,10 @@ jobs:
uses: azure/[email protected]

- 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
35 changes: 35 additions & 0 deletions .github/workflows/release.yaml
Original file line number Diff line number Diff line change
@@ -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 "[email protected]"

- name: Install Helm
uses: azure/setup-helm@v3

- name: Run chart-releaser
uses: helm/[email protected]
with:
charts_dir: servarr
pages_branch: charts
env:
CR_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
43 changes: 43 additions & 0 deletions .github/workflows/static.yaml
Original file line number Diff line number Diff line change
@@ -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
4 changes: 2 additions & 2 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
- --chart-search-root=servarr/servarr-chart
- --template-files=README.md.gotmpl
14 changes: 7 additions & 7 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -44,23 +44,23 @@ $ helm install <release-name> <servarr-chart> \

### 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

Please read [CONTRIBUTING.md](./CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.

## Contributors

<a href="https://github.com/fonzdm/servarr/graphs/contributors">
<a href="https://github.com/fonzdm/servarr/servarr-chartgraphs/contributors">
<img src="https://contrib.rocks/image?repo=fonzdm/servarr" />
</a>

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.

Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Loading