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

feat: switch doc generation to use helm-docs and add a workflow to auto bump the chart version on pr approval #114

Open
wants to merge 4 commits into
base: master
Choose a base branch
from

Conversation

MarshallAsch
Copy link
Member

@MarshallAsch MarshallAsch commented Oct 29, 2024

The inital commits here do not include the new generated version of the chart README to show its generation after the GH approval.

This workflow will update the chart version automatically after receiving an approval from from one of the maintainers. The version will be selected based on the presence of one of the chart: patch, chart: minor, or chart:major labels on the PR.

Then the chart documentation will be re generated and committed back to the source branch.

Note: the chart testing linter is expected to fail until after the action is run to bump the chart version

@MarshallAsch MarshallAsch requested a review from a team as a code owner October 29, 2024 18:09
@MarshallAsch MarshallAsch added the chart: patch Patch version bump label Oct 29, 2024
Copy link
Member

@cilindrox cilindrox left a comment

Choose a reason for hiding this comment

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

LGTM 👍

.github/workflows/version.yaml Outdated Show resolved Hide resolved
name: Bump Version and Generate Docs
on:
pull_request_review:
types: [submitted]
Copy link
Member

Choose a reason for hiding this comment

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

maybe filter by PRs targetting main or repo's default branch?

Also, dunno how I feel running this on the PR vs on commits to main - IMO the latter would prevent any churn on the PR branch and might reduce any risks with commits

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
chart: patch Patch version bump enhancement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants