coderrob/Update README.md with Action Metadata
Updates a README.md file with metadata from an action's YAML configuration file. This includes information such as the action name, description, inputs, outputs, and other relevant details.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| readme-file-path | The path to the README.md file that should be updated. This is relative to the repository root. If not specified, it defaults to 'README.md'. | yes | ./README.md |
| action-file-path | The path to the YAML configuration file for the action. This is relative to the repository root. If not specified, it defaults to 'action.yml'. | yes | ./action.yml |
| action-repository | The repository where the action is located. This is used to generate links and references within the README.md file. | no | ${{ github.action_repository }} |
Outputs
no outputs