climpr/Document Bicep Module
Creates default markdown README.md documentation for the specified module and commits it to the repository.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stalelast commit Oct 14, 2024
- License
- GPL 3.0
Pinned Snippet
uses: climpr/document-bicep-module@0c46137e662d34ed0c68604294d00143adf9e3fe # v1.0.0tags can be moved; commit SHAs can't. why a SHA?
Inputs
| name | description | required | default |
|---|---|---|---|
| root-path | The root path for the modules. | yes | — |
| module-name | The name of the module. This should include the full relative path below the root-path, not including any leading or trailing '/'. Example: 'subnet' or 'modules/subnet'. | yes | — |
| as-pull-request | Setting this parameter to 'true' will create a pull request instead of committing directly to the default branch. | no | false |
Outputs
no outputs