Skip to content

Commit

Permalink
feat/report template custom (#6)
Browse files Browse the repository at this point in the history
* feat: Add Report template file for custom

* docs: Updating documentation
  • Loading branch information
carlosrfjunior authored Oct 4, 2024
1 parent 4390f6f commit df55c19
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 4 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,10 @@ Helm S3 Publisher is a small project with the purpose of helping in the process

Please refer to the [release page](https://github.com/toolsascode/helm-s3-publisher/releases) for the latest release notes.

## Requirements

- [helm](https://helm.sh)
- [helm-s3](https://github.com/hypnoglow/helm-s3)

## Usage

Expand Down Expand Up @@ -50,6 +54,10 @@ Please refer to the [release page](https://github.com/toolsascode/helm-s3-publis
# (Optional) Directory where the report will be saved by the CLI.
# Default: '.'
report-path: '.'
# (Optional) Indicate the template file you want to use.
# See more at https://github.com/marketplace/actions/go-modeler-for-file-templates
# Default: ${{ github.action_path }}/templates/helm-charts.md.gotmpl
report-template-file: ${{ github.action_path }}/templates/helm-charts.md.gotmpl
# S3 Object ACL to use for charts and indexes. Can be sourced from S3_ACL environment variable.
s3-acl: ''
# Set the content-type for the chart file. Can be sourced from S3_CHART_CONTENT_TYPE environment variable.
Expand Down Expand Up @@ -78,4 +86,6 @@ Please refer to the [release page](https://github.com/toolsascode/helm-s3-publis
report-type: 'json'
report-name: 'helm-s3-publisher'
report-path: ./
report-template-file: ./templates/helm-charts.md.gotmpl
github-step-summary: true
```
12 changes: 8 additions & 4 deletions action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@ author: 'Carlos Freitas <carlosrfjunior@gmail.com>'
description: 'Helm S3 Publisher is a small CLI to help with the chart publishing process.'

branding:
icon: 'terminal'
color: 'green'
icon: 'cloud'
color: 'blue'

inputs:
setup-helm:
Expand Down Expand Up @@ -54,6 +54,10 @@ inputs:
description: Directory where the report will be saved by the CLI.
required: false
default: '.'
report-template-file:
description: "Indicate the template file you want to use. See more at https://github.com/marketplace/actions/go-modeler-for-file-templates"
required: false
default: ${{ github.action_path }}/templates/helm-charts.md.gotmpl
s3-acl:
description: S3 Object ACL to use for charts and indexes. Can be sourced from S3_ACL environment variable.
required: false
Expand Down Expand Up @@ -179,5 +183,5 @@ runs:
environments: |
filename=${{ inputs.report-path }}/${{ inputs.report-name }}.${{ inputs.report-type }}
filereport=${{ steps.upload.outputs.artifact-url }}
template-file: ${{ github.action_path }}/templates/helm-charts.md.gotmpl
github-step-summary: true
template-file: ${{ inputs.report-template-file }}
github-step-summary: ${{ inputs.github-step-summary }}

0 comments on commit df55c19

Please sign in to comment.