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

Use new readme action #71

Merged
merged 6 commits into from
May 7, 2024
Merged

Use new readme action #71

merged 6 commits into from
May 7, 2024

Conversation

goruha
Copy link
Member

@goruha goruha commented Apr 26, 2024

what

  • Use new readme action
  • Remove the multi-doc YAML hack to README.yaml which was added to make it more obvious to developers when they forget to change the boilerplate.

why

  • actions-tools/yaml-outputs doesn't support multi-doc

image

@goruha goruha requested review from a team as code owners April 26, 2024 15:21
@goruha goruha requested review from hans-d and jamengual April 26, 2024 15:21
@mergify mergify bot added triage Needs triage needs-cloudposse Needs Cloud Posse assistance labels Apr 26, 2024
Copy link

mergify bot commented Apr 26, 2024

Important

Cloud Posse Engineering Team Review Required

This pull request modifies files that require Cloud Posse's review. Please be patient, and a core maintainer will review your changes.

To expedite this process, reach out to us on Slack in the #pr-reviews channel.

@goruha goruha requested a review from a team as a code owner April 26, 2024 15:30
@goruha
Copy link
Member Author

goruha commented Apr 26, 2024

/terratest

@goruha
Copy link
Member Author

goruha commented May 1, 2024

/terratest

Copy link
Member

@osterman osterman left a comment

Choose a reason for hiding this comment

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

This was added by Jeremy to reduce the likelihood of developers forgetting to update it which happens A LOT. A better check would be to have maybe the readme action error if boilerplate is detected, and an override flag is false.

@goruha goruha requested a review from osterman May 1, 2024 17:29
@mergify mergify bot removed the triage Needs triage label May 7, 2024
@goruha
Copy link
Member Author

goruha commented May 7, 2024

/terratest

@goruha goruha merged commit 7cb20c9 into main May 7, 2024
17 checks passed
@goruha goruha deleted the readme-generate branch May 7, 2024 22:59
@mergify mergify bot removed the needs-cloudposse Needs Cloud Posse assistance label May 7, 2024
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.

2 participants