{"id":17271960,"url":"https://github.com/pndurette/gh-actions-auto-docs","last_synced_at":"2025-04-14T08:20:41.657Z","repository":{"id":70116536,"uuid":"604425926","full_name":"pndurette/gh-actions-auto-docs","owner":"pndurette","description":"A GitHub Action for generating GitHub Action Markdown documentation","archived":false,"fork":false,"pushed_at":"2024-03-18T22:46:36.000Z","size":30,"stargazers_count":5,"open_issues_count":2,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-10T08:11:18.024Z","etag":null,"topics":["auto-docs","auto-documentation","documentation-generator","github-actions"],"latest_commit_sha":null,"homepage":"","language":"Python","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/pndurette.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","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}},"created_at":"2023-02-21T03:05:45.000Z","updated_at":"2025-02-15T19:21:45.000Z","dependencies_parsed_at":"2024-03-11T23:45:25.386Z","dependency_job_id":"67c76948-9187-4c86-9023-c497b9f8956d","html_url":"https://github.com/pndurette/gh-actions-auto-docs","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pndurette%2Fgh-actions-auto-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pndurette%2Fgh-actions-auto-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pndurette%2Fgh-actions-auto-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pndurette%2Fgh-actions-auto-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pndurette","download_url":"https://codeload.github.com/pndurette/gh-actions-auto-docs/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248844036,"owners_count":21170505,"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":["auto-docs","auto-documentation","documentation-generator","github-actions"],"created_at":"2024-10-15T08:47:27.538Z","updated_at":"2025-04-14T08:20:41.614Z","avatar_url":"https://github.com/pndurette.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# gh-actions-auto-docs\n\n\u003e A GitHub Action for generating GitHub Action documentation—[including its own!](.github/workflows/doc.yml)\n\n[![Tests](https://github.com/pndurette/gh-actions-auto-docs/actions/workflows/test.yml/badge.svg?branch=main)](https://github.com/pndurette/gh-actions-auto-docs/actions/workflows/test.yml)\n\n## Features\n\n* Generates GitHub Action documentation from the `action.yml` file\n* Support multi-line Markdown `description` yaml fields—only document your action once! (see [Example](#example))\n* Features git auto-commit to open PRs or push to branches\n\n## Setup\n\n1. In your `README.md` (or anywhere you'd like), add the template markers where you want the documentation to be inserted:\n\n```markdown\n\u003c!--doc_begin--\u003e\n\u003c!--doc_end--\u003e\n```\n\n2. Add `pndurette/gh-actions-auto-docs` to a workflow, for example:\n   *(Note the requirements for allowing the workflow to push to git!)*\n\n```yaml\nname: Generate Action Docs\n\non: [pull_request]\n\njobs:\n  doc:\n    runs-on: ubuntu-latest\n\n    permissions:\n      # Required to push changes!\n      contents: write\n\n    steps:\n    - uses: actions/checkout@v3\n      with:\n        # Required to push changes!\n        ref: ${{ github.event.pull_request.head.ref }}\n\n    - uses: pndurette/gh-actions-auto-docs@v1\n```\n\n## Configuration\n\n*This section was automatically generated by this action from its own [`action.yml`](./action.yml)*\n\u003c!--doc_begin_--\u003e\n### Inputs\n|Input|Description|Default|Required|\n|-----|-----------|-------|:------:|\n|`action_yaml_file`|The path to the GitHub Action's `action.yml` file|`./action.yml`|no|\n|`include_inputs`|Whenever to document the action's inputs|`true`|no|\n|`include_outputs`|Whenever to document the action's outputs|`true`|no|\n|`heading_size`|\u003cp\u003eThe Markdown heading size to use for the documented\u003cbr /\u003esections (i.e. number of \u003ccode\u003e#\u003c/code\u003e)\u003c/p\u003e|`3`|no|\n|`template_file`|The file used as template|`./README.md`|no|\n|`target_file`|\u003cp\u003eThe resulting file of the template substitution.\u003cbr /\u003eTo update in-place, this can be the same as \u003ccode\u003etemplate_file\u003c/code\u003e.\u003c/p\u003e|`./README.md`|no|\n|`marker_start`|\u003cp\u003eThe opening marker from which the template substitution\u003cbr /\u003ewill take place\u003c/p\u003e|`\u003c!--doc_begin--\u003e`|no|\n|`marker_end`|\u003cp\u003eThe closing marker to which the template substitution\u003cbr /\u003ewill take place\u003c/p\u003e|`\u003c!--doc_end--\u003e`|no|\n|`git_push`|Whenever to commit and push changes changes to `target_file`|`true`|no|\n|`git_push_user_name`|The git user name to commit with|`github-actions[bot]`|no|\n|`git_push_user_email`|The git user email to commit with|`github-actions[bot]@users.noreply.github.com`|no|\n|`git_commit_message`|The git commit message|`GitHub Action Auto-Docs`|no|\n|`git_commit_signoff`|Whenever to sign-off the git commit|`false`|no|\n\n\u003c!--doc_end_--\u003e\n\n## Example\n\nThis `action.yml` ...\n\n```yaml\n# [...]\n\ninputs:\n  param1:\n    description: This param has some **bold** and *italics*\n    required: true\n    default: value1\n  param2:\n    description: |\n      Path to some yaml:\n\n      \\```yaml\n      foo: bar\n      baz:\n        - abc\n      \\```\n\n      :warning: **Some cautionnary `tale`!**\n    required: false\n    default: ./some_file.yaml\n  param3:\n    description: See [link to somewhere](https://github.com)\n\noutputs:\n  output1:\n    description: |\n      A list to consider:\n      1. This\n      2. That\n  output2:\n    description: |\n      Someone once said:\n\n      \u003e Hello, how do you do?\n  output3:\n    description: This is it\n\n# [...]\n```\n\n... Would generate to:\n\n### Inputs\n|Input|Description|Default|Required|\n|-----|-----------|-------|:------:|\n|`param1`|\u003cp\u003ePath to some yaml:\u003c/p\u003e\u003cpre\u003efoo: bar\u003cbr /\u003ebaz:\u003cbr /\u003e  - abc\u003cbr /\u003e\u003c/pre\u003e\u003cp\u003e:warning: \u003cstrong\u003eSome cautionnary \u003ccode\u003etale\u003c/code\u003e!\u003c/strong\u003e\u003c/p\u003e|`./some_file.yaml`|no|\n|`param2`|This param has some **bold** and *italics*|`value1`|yes|\n|`param3`|See [link to somewhere](https://github.com)|n/a|no|\n### Outputs\n|Output|Description|\n|------|-----------|\n|`output1`|\u003cp\u003eA list to consider:\u003cbr /\u003e1. This\u003cbr /\u003e2. That\u003c/p\u003e|\n|`output2`|\u003cp\u003eSomeone once said:\u003c/p\u003e\u003cblockquote\u003e\u003cp\u003eHello, how do you do?\u003c/p\u003e\u003c/blockquote\u003e|\n|`output3`|This is it|\n\n\n## Licence\n\n[The MIT License (MIT)](LICENSE) Copyright © 2023-2024 Pierre Nicolas Durette\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpndurette%2Fgh-actions-auto-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpndurette%2Fgh-actions-auto-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpndurette%2Fgh-actions-auto-docs/lists"}