Documentation for branch gh-pages

[zacharyblasczyk]

Please document that .gitignore should not have *.tgz in the gh-pages branch.

From what I have seen, it should only include a CNAME, README.md, your *.tgz files, and a index.yaml. The index and tgz's coming from this action.

It is common to start a project with a /chart/${CHART_NAME}and a .gitignore while testing.

That ignore file will likely include

# Ignore all .tgz files
*.tgz

The readme currently states:

Pre-requisites

1. A GitHub repo containing a directory with your Helm charts (default is a folder named /charts, if you want to
   maintain your charts in a different directory, you must include a charts_dir input in the workflow).
2. A GitHub branch called gh-pages to store the published charts.

When you create a gh-pages branch manually, it will copy over all the files in the main branch including the .gitignore and that will lead to helm/chart-releaser-action@v1.6.0 erroring out

The following paths are ignored by one of your .gitignore files:
${CHART_NAME}-x.y.z.tgz
hint: Use -f if you really want to add them.
hint: Disable this message with "git config advice.addIgnoredFile false"
Error: exit status 1