{"id":15679871,"url":"https://github.com/npalm/action-docs-action","last_synced_at":"2025-04-14T16:14:33.106Z","repository":{"id":36969140,"uuid":"340903179","full_name":"npalm/action-docs-action","owner":"npalm","description":"Action to update GitHub action documentation","archived":false,"fork":false,"pushed_at":"2025-02-10T06:03:46.000Z","size":3502,"stargazers_count":14,"open_issues_count":11,"forks_count":10,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-03-28T04:51:15.094Z","etag":null,"topics":["action","actions","docs-generator"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","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/npalm.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","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}},"created_at":"2021-02-21T13:03:55.000Z","updated_at":"2024-11-16T07:25:44.000Z","dependencies_parsed_at":"2024-02-18T11:29:12.575Z","dependency_job_id":"05efa0f9-039b-4450-a15d-fa22582a257d","html_url":"https://github.com/npalm/action-docs-action","commit_stats":{"total_commits":107,"total_committers":6,"mean_commits":"17.833333333333332","dds":0.3551401869158879,"last_synced_commit":"38921c50c11673b699e0c85de671238af59f327f"},"previous_names":[],"tags_count":13,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/npalm%2Faction-docs-action","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/npalm%2Faction-docs-action/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/npalm%2Faction-docs-action/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/npalm%2Faction-docs-action/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/npalm","download_url":"https://codeload.github.com/npalm/action-docs-action/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248574960,"owners_count":21127094,"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":["action","actions","docs-generator"],"created_at":"2024-10-03T16:38:17.019Z","updated_at":"2025-04-14T16:14:33.081Z","avatar_url":"https://github.com/npalm.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp\u003e\n  \u003ca href=\"https://github.com/npalm/action-docs-action/actions\"\u003e\u003cimg alt=\"action-docs-action status\" src=\"https://github.com/npalm/action-docs-action/actions/workflows/ci.yml/badge.svg\"\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n\u003c!-- action-docs-header source=\"action.yml\" --\u003e\n# Action to update GitHub Action documentation\n\u003c!-- action-docs-header source=\"action.yml\" --\u003e\n\nThis action wraps [action-docs](https://github.com/npalm/action-docs) to update action and workflow documentation. By default the action will update `README.md` based on the `action.yml`. See the parameters for changing the defaults.\n\n## Usage\n\nThe action will update your readme by replacing html comment tags. Add one of more tags based on the following template to your repo:  `\u003c!-- action-docs-(header | description | inputs | outputs | runs | usage | all) source=\"action-file.yml\" --\u003e` to add the corresponding section.\n\n- `header` : to add/update a header based on the name of the action/workflow (only added if action option `includeNameHeader` is set to true)\n- `description` : to add/update a section with a descriptions of the action (applicable to actions only)\n- `inputs`: to add/update a section with inputs of the action/workflow\n- `outputs`: to add/update a section with outputs of the action/workflow\n- `runs`: to add/update a section of the environment required to run (applicable to actions only)\n- `usage`: to add/update a section containing an example of how to call the action/workflow. This comment also requires passing a project and a version to use in the example e.g. `\u003c!-- action-docs-usage source=\"action-file.yml\" project=\"npalm/action-docs\" version=\"v2.3.0\" --\u003e`.\n- `all`: to include all of the above in order\n\nIn your workflow add the action, see below for the available parameters.\n\n```yaml\n      - uses: npalm/action-docs-action\n```\n\nThe action will not commit any change, to ensure the changes are persisted you can use an action to [commit](https://github.com/stefanzweifel/git-auto-commit-action) or raise a [pull request](https://github.com/peter-evans/create-pull-request).\n\n\n\u003c!-- action-docs-inputs source=\"action.yml\" --\u003e\n## Inputs\n\n| name | description | required | default |\n| --- | --- | --- | --- |\n| `readme` | \u003cp\u003eReadme file to update.\u003c/p\u003e | `false` | `README.md` |\n| `actionFile` | \u003cp\u003eThe action definition file.\u003cbr/\u003e\u003cem\u003eDeprecated: This input is replaced by sourceFile\u003c/em\u003e\u003c/p\u003e | `false` | `\"\"` |\n| `sourceFile` | \u003cp\u003eThe action or workflow definition file.\u003c/p\u003e | `false` | `action.yml` |\n| `includeNameHeader` | \u003cp\u003eInclude the name header in the updated readme.\u003c/p\u003e | `false` | `true` |\n| `tocLevel` | \u003cp\u003eTOC level used for the headers. The \u003ccode\u003eincludeNameHeader\u003c/code\u003e input is influecing the TOC level, setting \u003ccode\u003eincludeNameHeader\u003c/code\u003e to true will increase the TOC level by 1.\u003c/p\u003e | `false` | `2` |\n| `lineBreaks` | \u003cp\u003eLine breaks to be used in updated readme (LF, CR or CRLF).\u003c/p\u003e | `false` | `LF` |\n\u003c!-- action-docs-inputs source=\"action.yml\" --\u003e\n\n\n\u003c!-- action-docs-runs source=\"action.yml\" --\u003e\n## Runs\n\nThis action is a `node20` action.\n\u003c!-- action-docs-runs source=\"action.yml\" --\u003e\n## License\n\nThis project are released under the [MIT License](./LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnpalm%2Faction-docs-action","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnpalm%2Faction-docs-action","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnpalm%2Faction-docs-action/lists"}