Action Workflow Documenter

This tool will document action workflows in a repository

Index

• Inputs
• Outputs
• Example
• Contributing
  • Incrementing the Version
  • Source Code Changes
  • Updating the README.md
• Code of Conduct
• License

Inputs

Parameter	Is Required	Default Value	Description
github-pat	true	None	The github personal access token used for interactions with github.
save-to-artifact	false	'false'	If true, save to documentation as an artifact. Used for testing.
save-to-branch	false	'false'	If true, save to documentation to a branch
save-to-wiki	false	'false'	If true, save to documentation to repository's wiki

Outputs

This workflow has zero outputs.

Example

jobs:
  job1:
    runs-on: [self-hosted, im-linux]
    steps:
      ...
      - name: 'Document Workflows'
        uses: ahernandez411/action-workflow-documenter@v1.0.2
        with:
          github-pat: ${{ secrets.GITHUB_TOKEN }}
      ...

Contributing

When creating PRs, please review the following guidelines:

• The action code does not contain sensitive information.
• At least one of the commit messages contains the appropriate +semver: keywords listed under Incrementing the Version for major and minor increments.
• The README.md has been updated with the latest version of the action. See Updating the README.md for details.

Incrementing the Version

This repo uses git-version-lite in its workflows to examine commit messages to determine whether to perform a major, minor or patch increment on merge if source code changes have been made. The following table provides the fragment that should be included in a commit message to active different increment strategies.

Increment Type	Commit Message Fragment
major	+semver:breaking
major	+semver:major
minor	+semver:feature
minor	+semver:minor
patch	default increment type, no comment needed

Source Code Changes

The files and directories that are considered source code are listed in the files-with-code and dirs-with-code arguments in both the build-and-review-pr and increment-version-on-merge workflows.

If a PR contains source code changes, the README.md should be updated with the latest action version. The build-and-review-pr workflow will ensure these steps are performed when they are required. The workflow will provide instructions for completing these steps if the PR Author does not initially complete them.

If a PR consists solely of non-source code changes like changes to the README.md or workflows under ./.github/workflows, version updates do not need to be performed.

Updating the README.md

If changes are made to the action's source code, the usage examples section of this file should be updated with the next version of the action. Each instance of this action should be updated. This helps users know what the latest tag is without having to navigate to the Tags page of the repository. See Incrementing the Version for details on how to determine what the next version will be or consult the first workflow run for the PR which will also calculate the next version.

Code of Conduct

This project has adopted the im-open's Code of Conduct.

License

Copyright © 2023, Extend Health, LLC. Code released under the MIT license.