Skip to content

cdkft: use reusable workflow and translate more - #32457

Merged
breathingdust merged 4 commits into
hashicorp:mainfrom
DanielMSchmidt:d-use-reusable-workflow-and-use-more-files
Jul 19, 2023
Merged

cdkft: use reusable workflow and translate more#32457
breathingdust merged 4 commits into
hashicorp:mainfrom
DanielMSchmidt:d-use-reusable-workflow-and-use-more-files

Conversation

@DanielMSchmidt

@DanielMSchmidt DanielMSchmidt commented Jul 11, 2023 •
edited
Loading

Copy link
Copy Markdown
Collaborator

Description

This refactors the action into the reusable github action workflow as a better abstraction and it bumps the cdktf version we use which should handle partial snippets better
I also enabled the translation of lambda, eks, and vpc prefixed docs.
Lastly I removed the org scoped token, it might be possible to create the automatic PR with just the GITHUB_TOKEN (since we don't act on the push or PR trigger where this is problematic)

Relations

Closes #0000

References

@github-actions

github-actions Bot commented Jul 11, 2023

Copy link
Copy Markdown
Contributor

Community Note

Voting for Prioritization

  • Please vote on this pull request by adding a 👍 reaction to the original post to help the community and maintainers prioritize this pull request.
  • Please see our prioritization guide for information on how we prioritize.
  • Please do not leave "+1" or other comments that do not add relevant new information or questions, they generate extra noise for issue followers and do not help prioritize the request.

For Submitters

  • Review the contribution guide relating to the type of change you are making to ensure all of the necessary steps have been taken.
  • For new resources and data sources, use skaff to generate scaffolding with comments detailing common expectations.
  • Whether or not the branch has been rebased will not impact prioritization, but doing so is always a welcome surprise.

@github-actions github-actions Bot added size/XL Managed by automation to categorize the size of a PR. documentation Introduces or discusses updates to documentation. service/lambda Issues and PRs that pertain to the lambda service. service/ec2 Issues and PRs that pertain to the ec2 service. service/eks Issues and PRs that pertain to the eks service. repository Repository modifications; GitHub Actions, developer docs, issue templates, codeowners, changelog. github_actions Pull requests that update Github_actions code service/ipam Issues and PRs that pertain to the ipam service. service/vpnclient Issues and PRs that pertain to the vpnclient service. service/transitgateway Issues and PRs that pertain to the transitgateway service. service/wavelength Issues and PRs that pertain to the wavelength service. service/ec2outposts Issues and PRs that pertain to the ec2outposts service. service/vpc Issues and PRs that pertain to the vpc service. service/vpclattice Issues and PRs that pertain to the vpclattice service. needs-triage Waiting for first response or review from a maintainer. and removed size/XL Managed by automation to categorize the size of a PR. labels Jul 11, 2023
@DanielMSchmidt
DanielMSchmidt force-pushed the d-use-reusable-workflow-and-use-more-files branch from 8a80b03 to 5856f8c Compare July 11, 2023 16:03
@github-actions github-actions Bot added the size/XL Managed by automation to categorize the size of a PR. label Jul 11, 2023
@justinretzolk justinretzolk removed the needs-triage Waiting for first response or review from a maintainer. label Jul 11, 2023
@DanielMSchmidt
DanielMSchmidt force-pushed the d-use-reusable-workflow-and-use-more-files branch from 5856f8c to fbbedfb Compare July 13, 2023 09:57
@github-actions github-actions Bot added the linter Pertains to changes to or issues with the various linters. label Jul 13, 2023
@DanielMSchmidt

DanielMSchmidt commented Jul 13, 2023 •
edited
Loading

Copy link
Copy Markdown
Collaborator Author

Got a PR to change tfproviderdocs to ignore cdktf files in the content check: bflad/tfproviderdocs#80

Once it's merged here I'll do another PR against the fork currently in use

ansgarm
ansgarm reviewed Jul 14, 2023
View reviewed changes
Comment thread .github/workflows/cdktf-documentation.yml Outdated
@DanielMSchmidt
DanielMSchmidt force-pushed the d-use-reusable-workflow-and-use-more-files branch from 22bb438 to 63aba6f Compare July 18, 2023 10:09
breathingdust
breathingdust approved these changes Jul 18, 2023
View reviewed changes

@breathingdust breathingdust left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM though I think that the job will probably fail due to PR creation being blocked at org level. If so we can update it to use our GitHub App token. However it may make more sense to create your own GitHub app that you could use and manage across all the repositories that you are creating cdktf docs for.

@DanielMSchmidt

DanielMSchmidt commented Jul 18, 2023

Copy link
Copy Markdown
Collaborator Author

Sounds good 👍 I'll do a follow-up PR anyways to include a few more missing resources, so just let me know which token to use there :)

@DanielMSchmidt
cdkft: use reusable workflow and translate more
678a7f7
@DanielMSchmidt
fix: ignore cdktf markdown docs
9fb34e1 
Due to the partial translation there might be missing links. The registry UI handles them gracefully so it's not a real problem
@DanielMSchmidt
chore: add instance documentation to translated docs
4f0115e
@DanielMSchmidt
cdktf: update r/lambda_alias.html.markdown,r/instance.html.markdown,r…
db26505 
…/eks_node_group.html.markdown,r/eks_identity_provider_config.html.markdown,r/eks_fargate_profile.html.markdown,r/eks_cluster.html.markdown,r/eks_addon.html.markdown,r/ec2_transit_gateway_vpc_attachment_accepter.html.markdown,r/ec2_transit_gateway_vpc_attachment.html.markdown,r/ec2_transit_gateway_route_table_propagation.html.markdown
@DanielMSchmidt
DanielMSchmidt force-pushed the d-use-reusable-workflow-and-use-more-files branch from 5682053 to db26505 Compare July 19, 2023 08:44
@DanielMSchmidt

DanielMSchmidt commented Jul 19, 2023

Copy link
Copy Markdown
Collaborator Author

I also added aws_instance docs as per @ansgarm request. Can we get this in before the release?

@breathingdust
breathingdust merged commit c706d95 into hashicorp:main Jul 19, 2023
@github-actions github-actions Bot added this to the v5.9.0 milestone Jul 19, 2023
@github-actions

github-actions Bot commented Jul 20, 2023

Copy link
Copy Markdown
Contributor

This functionality has been released in v5.9.0 of the Terraform AWS Provider. Please see the Terraform documentation on provider versioning or reach out if you need any assistance upgrading.

For further feature requests or bug reports with this functionality, please create a new GitHub issue following the template. Thank you!

@github-actions

github-actions Bot commented Aug 20, 2023

Copy link
Copy Markdown
Contributor

I'm going to lock this pull request because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active issues.
If you have found a problem that seems related to this change, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.

@github-actions github-actions Bot locked as resolved and limited conversation to collaborators Aug 20, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

@breathingdust breathingdust breathingdust approved these changes
+1 more reviewer
@ansgarm ansgarm ansgarm left review comments
Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

documentation Introduces or discusses updates to documentation. github_actions Pull requests that update Github_actions code linter Pertains to changes to or issues with the various linters. repository Repository modifications; GitHub Actions, developer docs, issue templates, codeowners, changelog. service/ec2outposts Issues and PRs that pertain to the ec2outposts service. service/ec2 Issues and PRs that pertain to the ec2 service. service/eks Issues and PRs that pertain to the eks service. service/ipam Issues and PRs that pertain to the ipam service. service/lambda Issues and PRs that pertain to the lambda service. service/transitgateway Issues and PRs that pertain to the transitgateway service. service/vpc Issues and PRs that pertain to the vpc service. service/vpclattice Issues and PRs that pertain to the vpclattice service. service/vpnclient Issues and PRs that pertain to the vpnclient service. service/wavelength Issues and PRs that pertain to the wavelength service. size/XL Managed by automation to categorize the size of a PR.

Projects

None yet

Milestone

v5.9.0

Development

Successfully merging this pull request may close these issues.

4 participants

@DanielMSchmidt @breathingdust @ansgarm @justinretzolk