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

Add support for index-path and pages-index-path #1

Merged
merged 2 commits into from
Apr 16, 2024
Merged
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
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,8 @@ A GitHub action to turn a GitHub project into a self-hosted Helm chart repo, usi
- `mark_as_latest`: When you set this to `false`, it will mark the created GitHub release not as 'latest'.
- `packages_with_index`: When you set this to `true`, it will upload chart packages directly into publishing branch.
- `pages_branch`: Name of the branch to be used to push the index and artifacts. (default to: gh-pages but it is not set in the action it is a default value for the chart-releaser binary)
- `pages_index_path`: Path to the index file in the gh-pages branch. (default to: index.yaml but it is not set in the action)
- `index_path`: Path to the index file. (default to: .cr-index/index.yaml but it is not set in the action)

### Outputs

Expand Down
14 changes: 14 additions & 0 deletions action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,12 @@ inputs:
pages_branch:
description: "Name of the branch to be used to push the index and artifacts. (default to: gh-pages but it is not set in the action it is a default value for the chart-releaser binary)"
required: false
pages_index_path:
description: "The GitHub pages index path. (default to: index.yaml but it is not set in the action)"
required: false
index_path:
description: "Path to index file. (default to: .cr-index/index.yaml but it is not set in the action)"
required: false
outputs:
changed_charts:
description: "A comma-separated list of charts that were released on this run. Will be an empty string if no updates were detected, will be unset if `--skip_packaging` is used: in the latter case your custom packaging step is responsible for setting its own outputs if you need them."
Expand Down Expand Up @@ -120,6 +126,14 @@ runs:
args+=(--pages-branch "${{ inputs.pages_branch }}")
fi

if [[ -n "${{ inputs.pages_index_path }}" ]]; then
args+=(--pages-index-path "${{ inputs.pages_index_path }}")
fi

if [[ -n "${{ inputs.index_path }}" ]]; then
args+=(--index-path "${{ inputs.index_path }}")
fi

"$GITHUB_ACTION_PATH/cr.sh" "${args[@]}"

if [[ -f changed_charts.txt ]]; then
Expand Down
22 changes: 22 additions & 0 deletions cr.sh
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,8 @@ Usage: $(basename "$0") <options>
--skip-upload Skip package upload, just create the release. Not needed in case of OCI upload.
-l, --mark-as-latest Mark the created GitHub release as 'latest' (default: true)
--packages-with-index Upload chart packages directly into publishing branch
--index-path The path to the index file
--pages-index-path The path to the index file in the pages branch
EOF
}

Expand All @@ -55,6 +57,8 @@ main() {
local mark_as_latest=true
local packages_with_index=false
local pages_branch=
local index_path=
local pages_index_path=

parse_command_line "$@"

Expand Down Expand Up @@ -176,6 +180,18 @@ parse_command_line() {
shift
fi
;;
--index-path)
if [[ -n "${2:-}" ]]; then
index_path="$2"
shift
fi
;;
--pages-index-path)
if [[ -n "${2:-}" ]]; then
pages_index_path="$2"
shift
fi
;;
-n | --install-dir)
if [[ -n "${2:-}" ]]; then
install_dir="$2"
Expand Down Expand Up @@ -351,6 +367,12 @@ update_index() {
if [[ -n "$pages_branch" ]]; then
args+=(--pages-branch "$pages_branch")
fi
if [[ -n "$index_path" ]]; then
args+=(--index-path "$index_path")
fi
if [[ -n "$pages_index_path" ]]; then
args+=(--pages-index-path "$pages_index_path")
fi

echo 'Updating charts repo index...'
cr index "${args[@]}"
Expand Down