Add support for generating documentation for actions #505
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
austinvalle
commented
Aug 12, 2025
| @@ -10,15 +10,15 @@ require ( | |||
| github.com/hashicorp/go-version v1.7.0 | |||
| github.com/hashicorp/hc-install v0.9.2 | |||
| github.com/hashicorp/terraform-exec v0.23.0 | |||
| github.com/hashicorp/terraform-json v0.25.0 | |||
| github.com/hashicorp/terraform-json v0.25.1-0.20250808120122-465ba375ab0a | |||
There was a problem hiding this comment.
TODO: This needs to be updated once this PR is merged for terraform-json: hashicorp/terraform-json#166
austinvalle
force-pushed
the
av/actions
branch
from
29ec78e to
be3235b
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Related Issue
Ref: hashicorp/terraform-json#166
Example usage:
Description
This PR adds support for generating action documentation. Docs are generated in a subdirectory
/actionsfor thegenerate,validate, andmigratecommands.Currently the only type of action is unlinked which is essentially the same as any other resource/data source/ephemeral resource, however, there will eventually be additional action types that need additional documentation generated for them (such as linked managed resource types), so there are some duplicated bits to allow that to happen later.
Rollback Plan
Changes to Security Controls
No