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

chore: remove bin/helm-doc #13482

Merged
merged 3 commits into from
Dec 13, 2024
Merged

chore: remove bin/helm-doc #13482

merged 3 commits into from
Dec 13, 2024

Conversation

alpeb
Copy link
Member

@alpeb alpeb commented Dec 13, 2024

The version in bin/helm-doc isn't in sync with what's installed in the dev container, which generates a diff in the README chart files. CI uses the dev container and it appears most folks do as well, so I'm removing that script instead of having to keep it in sync.

@alpeb alpeb requested a review from a team as a code owner December 13, 2024 15:05
olix0r
olix0r previously approved these changes Dec 13, 2024
@olix0r
Copy link
Member

olix0r commented Dec 13, 2024

@alpeb there are a few more references in the repo

@alpeb
Copy link
Member Author

alpeb commented Dec 13, 2024

Good spot 👍
I'm removing the call to helm-docs from the helm-publish action since at that point we've already verified the READMEs are in sync.

@alpeb
Copy link
Member Author

alpeb commented Dec 13, 2024

In my last push I made the following updates:

  • Removed the helm.yml workflow
  • Removed bin/helm-docs-diff, not used anywhere
  • Updated the helm-publish action to use helm-docs from the setup-tools action
  • Removed the generated charts README.md files; people can consult the values.yaml files directly, or the generated READMEs at https://artifacthub.io/
  • Uptaded the BUILD.md file to remove instructions about helm-docs.

Copy link
Member

@adleong adleong left a comment

Choose a reason for hiding this comment

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

🌮 🌮 🌮 🌮 🌮

The version in `bin/helm-doc` isn't in sync with what's installed in the
dev container, which generates a diff in the README chart files. CI uses
the dev container and it appears most folks do as well, so I'm removing
that script instead of having to keep it in sync.
- Removed the helm.yml workflow
- Removed bin/helm-docs-diff, not used anywhere
- Updated the helm-publish action to use helm-docs from the setup-tools action
- Removed the generated charts `README.md` files; people can consult the `values.yaml` files directly, or the generated READMEs at https://artifacthub.io/
- Uptaded the `BUILD.md` file to remove instructions about helm-docs.
@alpeb alpeb force-pushed the alpeb/remove-bin-helm-docs branch from c689e58 to b90e09a Compare December 13, 2024 19:52
@alpeb alpeb merged commit 71d15ff into main Dec 13, 2024
23 checks passed
@alpeb alpeb deleted the alpeb/remove-bin-helm-docs branch December 13, 2024 20:00
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