{"id":25543471,"url":"https://github.com/Coderrob/update-readme","last_synced_at":"2026-02-06T03:30:19.498Z","repository":{"id":274992585,"uuid":"924493235","full_name":"Coderrob/update-action-readme","owner":"Coderrob","description":"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.","archived":false,"fork":false,"pushed_at":"2025-02-17T19:52:11.000Z","size":1481,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-17T20:33:42.370Z","etag":null,"topics":["documentation-tool","github-actions","readme","self-documenting"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Coderrob.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":"CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":["coderrob"],"buy_me_a_coffee":"coderrob"}},"created_at":"2025-01-30T05:25:32.000Z","updated_at":"2025-02-17T19:52:13.000Z","dependencies_parsed_at":"2025-02-17T20:37:07.421Z","dependency_job_id":null,"html_url":"https://github.com/Coderrob/update-action-readme","commit_stats":null,"previous_names":["coderrob/update-action-readme"],"tags_count":2,"template":false,"template_full_name":"actions/typescript-action","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Coderrob%2Fupdate-action-readme","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Coderrob%2Fupdate-action-readme/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Coderrob%2Fupdate-action-readme/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Coderrob%2Fupdate-action-readme/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Coderrob","download_url":"https://codeload.github.com/Coderrob/update-action-readme/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239793071,"owners_count":19697893,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["documentation-tool","github-actions","readme","self-documenting"],"created_at":"2025-02-20T07:19:33.275Z","updated_at":"2026-02-06T03:30:19.406Z","avatar_url":"https://github.com/Coderrob.png","language":"TypeScript","funding_links":["https://github.com/sponsors/coderrob","https://buymeacoffee.com/coderrob"],"categories":[],"sub_categories":[],"readme":"# Update README.md with Action Metadata\n\nUpdates a README.md file with metadata from an action's YAML configuration file.\nThis includes information such as the action name, description, inputs, outputs,\nand other relevant details. This ensures that the readme file is always\nup-to-date with the latest information about the action.\n\n## Branding\n\n| Attribute | Value |\n| --------- | ----- |\n| Color     | green |\n| Icon      | book  |\n\n## Inputs\n\n| Name             | Description                                                                                                                                     | Default      | Required | Deprecation |\n| ---------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | ------------ | -------- | ----------- |\n| 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   | -           |\n| 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   | -           |\n\n## Outputs\n\nThis action does not define any outputs.\n\n## Environment Variables\n\nThis action does not require any environment variables.\n\n## Dependencies\n\nThis section provides a graph of dependencies relevant to this action.\n\n    dependencies:\n    - GitHub Actions Runner\n    - Specific environment variables\n    - Required files and configurations\n\n## Runs\n\n**Execution Type:** node20\n\nThis action uses a Node.js runtime configuration.\n\n## Example Usage\n\n    jobs:\n      example:\n        runs-on: ubuntu-latest\n        steps:\n          - uses: actions/checkout@v2\n          - name: Run Update README.md with Action Metadata\n            uses: ./\n            with:\n              readme-file-path: \u003cvalue\u003e\n              action-file-path: \u003cvalue\u003e\n\n## Acknowledgments\n\nThis project leverages Markdown generation techniques from\n[coderrob.com](https://coderrob.com), developed by **Robert Lindley**.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FCoderrob%2Fupdate-readme","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FCoderrob%2Fupdate-readme","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FCoderrob%2Fupdate-readme/lists"}