devthefuture/helm-pages
3
1
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

chore: wip

Browse source
This commit is contained in:
devthejo 2023-12-16 12:50:33 +01:00
parent b91f06f410
commit 0b7aafede1
Signed by: devthejo
GPG key ID: C04215C627711F5C
3 changed files with 15 additions and 15 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
README.md
View file

@ -1,6 +1,6 @@
# Helm Publisher # Helm Publisher
A GitHub Action for publishing Helm charts with Github Pages. A GitHub Action for publishing Helm charts with Codeberg/Github Pages.
## Usage ## Usage
@ -10,7 +10,7 @@ Inputs:
* `charts_url` The GitHub Pages URL, defaults to `https://<OWNER>.github.io/<REPOSITORY>` * `charts_url` The GitHub Pages URL, defaults to `https://<OWNER>.github.io/<REPOSITORY>`
* `owner` The GitHub user or org that owns this repository, defaults to the owner in `GITHUB_REPOSITORY` env var * `owner` The GitHub user or org that owns this repository, defaults to the owner in `GITHUB_REPOSITORY` env var
* `repository` The GitHub repository, defaults to the `GITHUB_REPOSITORY` env var * `repository` The GitHub repository, defaults to the `GITHUB_REPOSITORY` env var
* `branch` The branch to publish charts, defaults to `gh-pages` * `branch` The branch to publish charts, defaults to `pages`
* `target_dir` The target directory to store the charts, defaults to `.` * `target_dir` The target directory to store the charts, defaults to `.`
* `helm_version` The Helm CLI version, defaults to the latest release * `helm_version` The Helm CLI version, defaults to the latest release
* `linting` Toggle Helm linting, can be disabled by setting it to `off` * `linting` Toggle Helm linting, can be disabled by setting it to `off`
@ -26,7 +26,7 @@ Inputs:
## Examples ## Examples
Package and push all charts in `./charts` dir to `gh-pages` branch: Package and push all charts in `./charts` dir to `pages` branch:
```yaml ```yaml
name: release name: release
@ -40,12 +40,12 @@ jobs:
steps: steps:
- uses: actions/checkout@v2 - uses: actions/checkout@v2
- name: Publish Helm charts - name: Publish Helm charts
uses: stefanprodan/helm-gh-pages@master uses: https://git.devthefuture.org/devthefuture/helm-pages.git@master
with: with:
token: ${{ secrets.GITHUB_TOKEN }} token: ${{ secrets.GITHUB_TOKEN }}
``` ```
Package and push charts in `./chart` dir to `gh-pages` branch in a different repository: Package and push charts in `./chart` dir to `pages` branch in a different repository:
```yaml ```yaml
name: release-chart name: release-chart
@ -59,19 +59,19 @@ jobs:
steps: steps:
- uses: actions/checkout@v2 - uses: actions/checkout@v2
- name: Publish Helm chart - name: Publish Helm chart
uses: stefanprodan/helm-gh-pages@master uses: https://git.devthefuture.org/devthefuture/helm-pages.git@master
with: with:
token: ${{ secrets.BOT_GITHUB_TOKEN }} token: ${{ secrets.BOT_GITHUB_TOKEN }}
charts_dir: chart charts_dir: chart
charts_url: https://charts.fluxcd.io charts_url: https://charts.fluxcd.io
owner: fluxcd owner: fluxcd
repository: charts repository: charts
branch: gh-pages branch: pages
target_dir: charts target_dir: charts
commit_username: johndoe commit_username: johndoe
commit_email: johndoe@example.com commit_email: johndoe@example.com
``` ```
Package chart with specified chart & app versions and push all charts in `./charts` dir to `gh-pages` branch: Package chart with specified chart & app versions and push all charts in `./charts` dir to `pages` branch:
```yaml ```yaml
name: release name: release
on: on:
@ -84,7 +84,7 @@ jobs:
steps: steps:
- uses: actions/checkout@v2 - uses: actions/checkout@v2
- name: Publish Helm charts - name: Publish Helm charts
uses: stefanprodan/helm-gh-pages@master uses: https://git.devthefuture.org/devthefuture/helm-pages.git@master
with: with:
token: ${{ secrets.GITHUB_TOKEN }} token: ${{ secrets.GITHUB_TOKEN }}
app_version: 1.16.0 app_version: 1.16.0

10
action.yml
View file

@ -1,5 +1,5 @@
name: 'Helm Publisher' name: 'Helm Publisher'
description: 'A GitHub/Gitea/Forgejo Action for publishing Helm charts with Gh-Pages/Pages' description: 'A Forgejo/Gitea/GitHub Action for publishing Helm charts with Codeberg/Github Pages'
author: 'DevTheJo' author: 'DevTheJo'
branding: branding:
icon: 'command' icon: 'command'
@ -12,16 +12,16 @@ inputs:
description: "The charts directory, defaults to `charts`" description: "The charts directory, defaults to `charts`"
required: false required: false
charts_url: charts_url:
description: "The GitHub Pages URL, defaults to `https://<OWNER>.github.io/<REPOSITORY>`" description: "The Pages URL, defaults to `https://<OWNER>.codeberg.page/<REPOSITORY>`"
required: false required: false
owner: owner:
description: "The GitHub user or org that owns this repository, defaults to `GITHUB_REPOSITORY`" description: "The user or org that owns this repository, defaults to `GITHUB_REPOSITORY`"
required: false required: false
repository: repository:
description: "The GitHub repository name, defaults to `GITHUB_REPOSITORY`" description: "The repository name, defaults to `GITHUB_REPOSITORY`"
required: false required: false
branch: branch:
description: "The branch to publish charts, defaults to `gh-pages`" description: "The branch to publish charts, defaults to `pages`"
required: false required: false
target_dir: target_dir:
description: "The target directory to store the charts, defaults to `.`" description: "The target directory to store the charts, defaults to `.`"

2
src/entrypoint.sh
View file

@ -39,7 +39,7 @@ main() {
fi fi
if [[ -z "$BRANCH" ]]; then if [[ -z "$BRANCH" ]]; then
BRANCH="gh-pages" BRANCH="pages"
fi fi
if [[ -z "$TARGET_DIR" ]]; then if [[ -z "$TARGET_DIR" ]]; then