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

Automate generating terraform configs README files #2117

Merged
merged 1 commit into from
Jun 24, 2022

Conversation

kron4eg
Copy link
Member

@kron4eg kron4eg commented Jun 24, 2022

What type of PR is this?
/kind documentation

What this PR does / why we need it:

  • To avoid forgetting to update the README file of the corresponding terraform config now we will fail the CI (verify-codegen).
  • Formalize the procedure of terraform config README generation

Which issue(s) this PR fixes (optional, in fixes #<issue number>(, fixes #<issue_number>, ...) format, will close the issue(s) when PR gets merged):
Fixes #

Special notes for your reviewer:

Does this PR introduce a user-facing change?:

Automate generating terraform configs README files

Bonus: verification of up to date of those READMEs
@kubermatic-bot kubermatic-bot added release-note Denotes a PR that will be considered when it comes time to generate release notes. kind/documentation Categorizes issue or PR as related to documentation. dco-signoff: yes Denotes that all commits in the pull request have the valid DCO signoff message. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Jun 24, 2022
@adeniyistephen
Copy link
Contributor

looks good to me.

Copy link
Member

@ahmedwaleedmalik ahmedwaleedmalik left a comment

Choose a reason for hiding this comment

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

/approve ⭐

@kubermatic-bot kubermatic-bot added the lgtm Indicates that a PR is ready to be merged. label Jun 24, 2022
@kubermatic-bot
Copy link
Contributor

LGTM label has been added.

Git tree hash: 6173243f1b590b9c5a277f2cc0b8973c475ec9be

@kubermatic-bot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: ahmedwaleedmalik

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@kubermatic-bot kubermatic-bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jun 24, 2022
@kubermatic-bot kubermatic-bot merged commit f7070ab into kubermatic:master Jun 24, 2022
@kubermatic-bot kubermatic-bot added this to the KubeOne 1.5 milestone Jun 24, 2022
@kron4eg kron4eg deleted the autoreadme-terraform-docs branch June 24, 2022 13:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. dco-signoff: yes Denotes that all commits in the pull request have the valid DCO signoff message. kind/documentation Categorizes issue or PR as related to documentation. lgtm Indicates that a PR is ready to be merged. release-note Denotes a PR that will be considered when it comes time to generate release notes. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants