Skip to content
You're viewing an older version of this GitHub Action. Do you want to see the latest version instead?
book-open

GitHub Action

github-actions-docs

1.1

github-actions-docs

book-open

github-actions-docs

Generate GitHub action docs for action

Installation

Copy and paste the following snippet into your .yml file.

              

- name: github-actions-docs

uses: tjtharrison/github-actions-docs@1.1

Learn more about this action in tjtharrison/github-actions-docs

Choose a version

github-actions-docs

Github Action to generate github-actions docs for a composite action.

github-actions-docs

Generate GitHub action docs for action

inputs

Title Required Type Description
ACTION_FILE_NAME True string The name of the file to be processed
OUTPUT_FILE_NAME True string The file that the output report will be written to
OUTPUT_MODE True string The output mode, [update/overwrite]. Update will be inserted after a line containing , overwrite will overwrite the whole file

Local development

To develop locally, install requirements to ensure the .env file is used in the project root:

pip3 install -r requirements.txt