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

move helm charts page to ghpages branch and publish on release #759

Merged
merged 2 commits into from
Oct 22, 2021

Conversation

bwagner5
Copy link
Contributor

1. Issue, if available:
https://github.com/awslabs/karpenter/runs/3965960509

2. Description of changes:
For some reason the pages build and deployment stopped working. We were publishing the whole repo, but since we're hosting https://karpenter.sh w/ Netlify now, we can just publish the charts dir without the docs and website content. Unfortunately, GH pages doesn't allow you to configure a custom directory to deploy in the same branch (only /(root) and /docs). So this PR adds a gh-action that publishes the charts dir to the gh-pages branch which will hopefully avoid running into weird build failures unrelated to the content that we actually care about publishing.

This PR also uses https://charts.karpenter.sh which is currently a CDN distro for the github pages origin/path. But this can be changed in the future if we'd like to move away from GH Pages for helm chart distribution without requiring users to update their helm repo URL.

3. Does this change impact docs?

  • Yes, PR includes docs updates
  • Yes, issue opened: link to issue
  • No

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

@netlify
Copy link

netlify bot commented Oct 22, 2021

✔️ Deploy Preview for karpenter-docs-prod ready!

🔨 Explore the source changes: 5259822

🔍 Inspect the deploy log: https://app.netlify.com/sites/karpenter-docs-prod/deploys/6172e4bda69b8d0008c3d3d0

😎 Browse the preview: https://deploy-preview-759--karpenter-docs-prod.netlify.app

@bwagner5 bwagner5 requested a review from ellistarn October 22, 2021 16:34
@@ -11,3 +11,9 @@ jobs:
with:
repo_token: "${{ secrets.GITHUB_TOKEN }}"
prerelease: false
- name: Deploy Helm Charts to GH Pages
uses: JamesIves/[email protected]
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Have you looked at this action from helm helm/chart-releaser-action?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think that action does a little more than we want. In the docs it says it cuts a Github release when it finds a new chart. Maybe that can be disabled, not sure? This might be something to look into though since it would replace the other manual steps we do to create the index. For now, this PR will fix our current process and we can investigate better tooling like this helm gh action when we fully automate the release process.

Copy link
Contributor

@ellistarn ellistarn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice! Approved just in case Prateek's recommendation doesn't pan out.

@bwagner5 bwagner5 merged commit 151b2ec into aws:main Oct 22, 2021
@bwagner5 bwagner5 deleted the move-pages branch October 22, 2021 17:10
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 this pull request may close these issues.

3 participants