Autodoc-workflow-artifacts NPM

A GitHub Action for auto documenting workflow artifacts table in README.md.

Usage in markdown

Usage in workflow

Add the following step at the end of your job, after other steps that might add or change files.

# Autodoc workflow artifacts in ./README.md
- uses: dineshsonachalam/Autodoc-workflow-artifacts@v2

# To commit the updated ./README.md and  push them back to the GitHub repository
- uses: stefanzweifel/git-auto-commit-action@v4

# or use: https://github.com/actions/checkout#push-a-commit-using-the-built-in-token

The following is an extended example with all possible options available for this Action.

- uses: dineshsonachalam/Autodoc-workflow-artifacts@v2
  with:
    # Optional branch name where commit should be pushed to.
    # Defaults to the current branch.
    branch: feature-123

    # Optional local file path to the README.md. 
    # Defaults to the root of the repository (`./README.md`)
    input_file_path: ./README.md

Example Workflow

name: autodoc-workflow-artifacts

on:
  workflow_run:
    workflows:
      - publish-to-npm
    types:
      - completed

jobs:        
  autoupdate-readme:
      runs-on: ubuntu-latest
      steps:
        - uses: actions/checkout@v2

        - uses: dineshsonachalam/Autodoc-workflow-artifacts@v2

        - uses: stefanzweifel/git-auto-commit-action@v4
          with:
            commit_message: Autodoc workflow artifactsTable
            branch: ${{ github.head_ref }}
            file_pattern: README.md