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: Added more examples for Rust, Go, Java runtimes #612

Merged
merged 8 commits into from
Sep 10, 2024

Conversation

antonbabenko
Copy link
Member

Description

Motivation and Context

Breaking Changes

How Has This Been Tested?

  • I have updated at least one of the examples/* to demonstrate and validate my change(s)
  • I have tested and validated these changes using one or more of the provided examples/* projects
  • I have executed pre-commit run -a on my pull request

@antonbabenko antonbabenko marked this pull request as ready for review September 7, 2024 00:35
@antonbabenko
Copy link
Member Author

@MaxymVlasov Do you know why some of the recent upgrade of pre-commit-terraform changes the README files created by terraform_wrapper_module_for_each hook. This made this build fail.

I think we should not touch those files created by terraform_wrapper_module_for_each and not add terraform-docs markers there. What do you think?

@antonbabenko antonbabenko changed the title feat: Added basic Rust examples feat: Added more examples for Rust, Go, Java runtimes Sep 7, 2024
@MaxymVlasov
Copy link

I think that I don't see BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK references in terraform_wrapper_module_for_each hook so curently I'm curious from where you get them at all in this hook, as it not set anywhere. Did you do some copy-paste inside the repo by this hook?

Marker migration runs right before terraform-docs execution otherwise tool will fail to write any changes. There nothing about "by whom" README was generated, so it can't be disabled inside hook, only inside .pre-comit-config for that hook

@antonbabenko
Copy link
Member Author

@MaxymVlasov There was no BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK in the original README.md in master neither, but I think terraform-docs hook put the reference which gets replaced. Could you please verify?

@MaxymVlasov
Copy link

So you talking about addition of new sections to the end of files, which looks like setting

- id: terraform_docs
  args:
    - --hook-config=--add-to-existing-file=true

was specified or markers was add manually.

By default, no markers added => no markers can be replaced too if they didn't exist

In any case, if I understand correctly, it comes from your commit, not from CI (if in this repo any autofixes exist)
b64057c#diff-6cba5a18fb655f06690ca2441b966c53a642d61bedf603879dd61d5a3586a926R102

If your configuration never included option above, and you didn't add markers manually, what exactly you did step by step during this commit? Please place a bug report with these steps, so I will be able to reproduce this issue

examples/runtimes/versions.tf Outdated Show resolved Hide resolved
examples/runtimes/versions.tf Show resolved Hide resolved
Copy link
Member

@bryantbiggs bryantbiggs left a comment

Choose a reason for hiding this comment

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

Overall looks good - few minor nits

examples/runtimes/java_eq_fun.tf Outdated Show resolved Hide resolved
examples/runtimes/main.tf Outdated Show resolved Hide resolved
examples/runtimes/main.tf Outdated Show resolved Hide resolved
examples/runtimes/versions.tf Show resolved Hide resolved
examples/runtimes/java_eq_fun.tf Outdated Show resolved Hide resolved
@antonbabenko
Copy link
Member Author

Waiting for antonbabenko/pre-commit-terraform#716 by @MaxymVlasov to be merged

@MaxymVlasov
Copy link

Merged

@antonbabenko antonbabenko merged commit a6fe411 into master Sep 10, 2024
30 checks passed
@antonbabenko antonbabenko deleted the rust-examples branch September 10, 2024 21:39
antonbabenko pushed a commit that referenced this pull request Sep 10, 2024
## [7.9.0](v7.8.1...v7.9.0) (2024-09-10)

### Features

* Added more examples for Rust, Go, Java runtimes ([#612](#612)) ([a6fe411](a6fe411))
@antonbabenko
Copy link
Member Author

This PR is included in version 7.9.0 🎉

Copy link

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 Oct 11, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants