https://github.com/coderrob/update-readme
A GitHub Action that keeps your repository’s README.md fresh and clean! Automatically generates or updates your README with technical documentation and usage examples, ensuring your project stays well-documented with zero hassle.
https://github.com/coderrob/update-readme
documentation-tool github-actions readme self-documenting
Last synced: 9 months ago
JSON representation
A GitHub Action that keeps your repository’s README.md fresh and clean! Automatically generates or updates your README with technical documentation and usage examples, ensuring your project stays well-documented with zero hassle.
- Host: GitHub
- URL: https://github.com/coderrob/update-readme
- Owner: Coderrob
- License: apache-2.0
- Created: 2025-01-30T05:25:32.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-03-20T08:08:14.000Z (about 1 year ago)
- Last Synced: 2025-03-20T08:23:19.387Z (about 1 year ago)
- Topics: documentation-tool, github-actions, readme, self-documenting
- Language: TypeScript
- Homepage:
- Size: 1.57 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
# 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.
## Branding
| Attribute | Value |
| --------- | ----- |
| Color | green |
| Icon | book |
## Inputs
| Name | Description | Default | Required |
| ----------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------- | -------- |
| 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'. | ./action.yml | ✅ Yes |
| action-repository | The repository where the action is located. This is used to generate links and references within the README.md file. | ${{ github.action_repository }} | ❌ No |
| 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'. | ./README.md | ✅ Yes |
## Outputs
This action does not define any outputs.
## Runs
**Execution Type:** node20
## Example Usage
```yaml
jobs:
example:
runs-on: ubuntu-latest
steps:
- name: Checkout Source
id: checkout-source
uses: actions/checkout@v2
- name: Update README.md with Action Metadata
uses: Coderrob/update-action-readme@v1
with:
action-file-path:
action-repository:
readme-file-path:
```
## Acknowledgments
This project leverages Markdown generation techniques from
[coderrob.com](https://coderrob.com), developed by **Robert Lindley**.