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: about 2 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-02-17T19:52:11.000Z (about 1 year ago)
- Last Synced: 2025-02-17T20:33:42.370Z (about 1 year ago)
- Topics: documentation-tool, github-actions, readme, self-documenting
- Language: TypeScript
- Homepage:
- Size: 1.41 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. This ensures that the readme file is always
up-to-date with the latest information about the action.
## Branding
| Attribute | Value |
| --------- | ----- |
| Color | green |
| Icon | book |
## Inputs
| Name | Description | Default | Required | Deprecation |
| ---------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | ------------ | -------- | ----------- |
| 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 | - |
| 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 | - |
## Outputs
This action does not define any outputs.
## Environment Variables
This action does not require any environment variables.
## Dependencies
This section provides a graph of dependencies relevant to this action.
dependencies:
- GitHub Actions Runner
- Specific environment variables
- Required files and configurations
## Runs
**Execution Type:** node20
This action uses a Node.js runtime configuration.
## Example Usage
jobs:
example:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Run Update README.md with Action Metadata
uses: ./
with:
readme-file-path:
action-file-path:
## Acknowledgments
This project leverages Markdown generation techniques from
[coderrob.com](https://coderrob.com), developed by **Robert Lindley**.