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

Support GitHub Pages Index Path other than repository root #150

Closed
caleblloyd opened this issue Mar 1, 2022 · 5 comments · Fixed by #151
Closed

Support GitHub Pages Index Path other than repository root #150

caleblloyd opened this issue Mar 1, 2022 · 5 comments · Fixed by #151
Assignees

Comments

@caleblloyd
Copy link
Contributor

The index.yaml on the GitHub Pages branch is currently hardcoded to the repository root:

indexYamlPath := filepath.Join(worktree, "index.yaml")

It is possible that the file is served from a path, for example:

https://org.github.io/repo/helm/charts/

I propose to add an option to the index command to make the pages-index-path configurable

@cpanato
Copy link
Member

cpanato commented Mar 1, 2022

sounds good to me

@cscetbon
Copy link

cscetbon commented Mar 13, 2022

Why not just respect index-path ? I set index-path to website/helm/index.yaml thinking it would be pushed to that location as well but got the behavior you describe which doesn't make sense to me. In my case the file gets created as it doesn't exists but if you store it in the source code I get why you would need a different variable for that. It's just counter-intuitive when this file is not stored in the source code but only pushed to gh-pages

@caleblloyd
Copy link
Contributor Author

This was confusing to me as well, but upon looking into the source code It looks like index-path is the current working index file on the current branch. It doesn't even have to point to an existing file; the most up-to-date index file can be downloaded by passing the --charts-repo option to cr index

Since GitHub pages branches are often orphan branches with different directory structures, the index-path and pages-index-path could be different.

To make the index-path option work, operations on it should be performed on the pages-branch and not the current branch. I could work up a PR for this if that is the preferred behavior

@cscetbon
Copy link

@cpanato when can we expect a new release in order to use that new feature with chart-releaser-action ?

@cpanato
Copy link
Member

cpanato commented Mar 16, 2022

@cpanato when can we expect a new release in order to use that new feature with chart-releaser-action ?

i will work in some updates and will release soon, lets aim for next week

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants