{"id":20958672,"url":"https://github.com/reakaleek/gh-action-readme","last_synced_at":"2026-04-15T14:31:30.659Z","repository":{"id":242562763,"uuid":"806519393","full_name":"reakaleek/gh-action-readme","owner":"reakaleek","description":"A GitHub CLI extension to generate and update GitHub Action docs","archived":false,"fork":false,"pushed_at":"2024-06-13T16:37:34.000Z","size":36,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-08-21T07:13:04.658Z","etag":null,"topics":["gh-extension","github-actions","markdown"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/reakaleek.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-05-27T10:58:43.000Z","updated_at":"2024-06-13T16:37:37.000Z","dependencies_parsed_at":"2024-06-03T19:59:51.068Z","dependency_job_id":"39394f20-f076-4c44-8860-04bc56cdc72b","html_url":"https://github.com/reakaleek/gh-action-readme","commit_stats":null,"previous_names":["reakaleek/gh-action-readme"],"tags_count":5,"template":false,"template_full_name":null,"purl":"pkg:github/reakaleek/gh-action-readme","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/reakaleek%2Fgh-action-readme","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/reakaleek%2Fgh-action-readme/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/reakaleek%2Fgh-action-readme/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/reakaleek%2Fgh-action-readme/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/reakaleek","download_url":"https://codeload.github.com/reakaleek/gh-action-readme/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/reakaleek%2Fgh-action-readme/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":273397761,"owners_count":25098233,"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","status":"online","status_checked_at":"2025-09-03T02:00:09.631Z","response_time":76,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["gh-extension","github-actions","markdown"],"created_at":"2024-11-19T01:49:04.960Z","updated_at":"2026-04-15T14:31:30.646Z","avatar_url":"https://github.com/reakaleek.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003c!-- Generated by https://github.com/reakaleek/gh-action-readme --\u003e\n\n# gh-action-readme\n![GitHub Release](https://img.shields.io/github/v/release/reakaleek/gh-action-readme?logo=github)\n![GitHub Release Date](https://img.shields.io/github/release-date/reakaleek/gh-action-readme?display_date=published_at\u0026logo=github)\n![GitHub go.mod Go version](https://img.shields.io/github/go-mod/go-version/reakaleek/gh-action-readme)\n![GitHub License](https://img.shields.io/github/license/reakaleek/gh-action-readme)\n[![ci](https://github.com/reakaleek/gh-action-readme/actions/workflows/ci.yml/badge.svg)](https://github.com/reakaleek/gh-action-readme/actions/workflows/ci.yml)\n\nA GitHub CLI extension to inject GitHub Actions metadata into `README.md` markdown files.\n\n\u003e [!TIP]\n\u003e Do you need to manage multiple actions in a github-actions monorepo? Check out the [How to Manage Monorepos with Multiple Actions](./docs/how-to/manage-monorepos.md) documentation for more information.\n\n## Prerequisites\n- [GitHub CLI](https://cli.github.com/) installed and authenticated.\n\n## ⚡️ Quick Start\n\n### Install the gh-action-readme extension\n\nThe `gh-action-readme` extension can be installed using the following command.\n\n```bash\ngh extension install reakaleek/gh-action-readme\n```\n\n### Create a README.md file\n\nCreate a `README.md` file in the action directory containing the `action.yml` file.\n\nYou can use the following template to define the metadata placeholders.\n\n```markdown\n# \u003c!--name--\u003e\u003c!--/name--\u003e\n\u003c!--description--\u003e\n\n## Inputs\n\u003c!--inputs--\u003e\n```\n\n### Update the `README.md` file\n\nRun the following command to update the `README.md` file with the metadata from the `action.yml` file.\n\n```bash\ngh action-readme update\n```\n\n### That's it! 🎉\n\nThe `README.md` file will be updated with the metadata from the `action.yml` file.\n\n```diff\n-# \u003c!--name--\u003e\u003c!--/name--\u003e\n+# \u003c!--name--\u003eAwesome Action\u003c!--/name--\u003e\n\u003c!--description--\u003e\n+A GitHub Action that does something awesome.\n+Something that is very useful.\n+\u003c!--/description--\u003e\n\n## Inputs\n\u003c!--inputs--\u003e\n+| Name   | Description     | Required | Default   |\n+|--------|-----------------|----------|-----------|\n+| input1 | The first input | `true`   | `default` |\n+\u003c!--/inputs--\u003e\n```\n\n\nCheckout the documentation for more information on how to use the `gh-action-readme` extension.\n- [Getting Started](./docs/tutorials/getting-started.md) - Quick start tutorial (5 minutes)\n- [Building a Complete Action README](./docs/tutorials/complete-action-readme.md) - Full example with all features\n- [Set up pre-commit hooks](./docs/how-to/setup-precommit.md) - Automatically update READMEs on commit\n- [Manage monorepos with multiple actions](./docs/how-to/manage-monorepos.md) - Bulk operations on multiple actions\n- [Check for documentation drift](./docs/how-to/check-documentation-drift.md) - Verify docs are up-to-date\n\n\n## Pre-commit (recommended)\n\n\u003e [!NOTE]\n\u003e Using gh-action-readme as a pre-commit hook does not require\n\u003e you to install the `gh-action-readme` extension in github cli.\n\nYou can also use the `gh-action-readme` extension as a [pre-commit](https://pre-commit.com/) hook to automatically update the `README.md` file before committing changes.\n\nAdd the following configuration to the `.pre-commit-config.yaml` file.\n\n```yaml\nrepos:\n  - repo: https://github.com/reakaleek/gh-action-readme\n    rev: v0.5.0\n    hooks:\n      - id: action-readme\n```\n\nThen run the following command to install the pre-commit hook.\n\n```bash\npre-commit install\n```\n\n\u003e [!TIP]\n\u003e You can use the [pre-commit action](https://github.com/marketplace/actions/pre-commit) to run the pre-commit checks in your GitHub Actions workflow.\n\n## GitHub Actions Workflow\n\u003c!--description--\u003e\nThis action checks if the documentation is up-to-date for multiple  GitHub Actions in a monorepo.\n\u003c!--/description--\u003e\n\n### Inputs\n\u003c!--inputs--\u003e\n| Name           | Description                                                                                                                                          | Required | Default               |\n|----------------|------------------------------------------------------------------------------------------------------------------------------------------------------|----------|-----------------------|\n| `version`      | Use a specific version of gh-action-readme (e.g. v0.5.0). You can find the latest version at https://github.com/reakaleek/gh-action-readme/releases. | `false`  | ` `                   |\n| `github-token` | A GitHub token with permissions to install extensions.                                                                                               | `false`  | `${{ github.token }}` |\n| `command`      | The gh-action-readme command to run.                                                                                                                 | `false`  | `diff`                |\n| `args`         | Arguments to pass to the command.                                                                                                                    | `false`  | `--recursive`         |\n\u003c!--/inputs--\u003e\n\n### Outputs\n\u003c!--outputs--\u003e\n| Name | Description |\n|------|-------------|\n\u003c!--/outputs--\u003e\n\n\u003c!--usage action=\"reakaleek/gh-action-readme\" version=\"v1\"--\u003e\n```yaml\nname: Check README.md\n\non:\n  pull_request:\n    paths:\n      - '**/action.yml'\n      - '**/README.md'\n\njobs:\n  gh-actions-readme-diff:\n    runs-on: ubuntu-latest\n    steps:\n      - uses: actions/checkout@v5\n      - uses: reakaleek/gh-action-readme@v1\n```               \n\u003c!--/usage--\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Freakaleek%2Fgh-action-readme","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Freakaleek%2Fgh-action-readme","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Freakaleek%2Fgh-action-readme/lists"}