Skip to content

Latest commit

 

History

History
52 lines (36 loc) · 1001 Bytes

action.md

File metadata and controls

52 lines (36 loc) · 1001 Bytes

GitHub Action

stitchmd-action is a GitHub Action that will install and run stitchmd for you in CI. With stitchmd-action, you can set up GitHub Workflows to:

  • Validate that your output file is always up-to-date

    uses: abhinav/stitchmd-action@v1
with:
  mode: check
  summary: doc/SUMMARY.md
  output: README.md

  • Automatically update your output file based on edits

    uses: abhinav/stitchmd-action@v1
with:
  mode: write
  summary: doc/SUMMARY.md
  output: README.md

# Optionally, use https://github.com/stefanzweifel/git-auto-commit-action
# to automatically push these changes.

  • Install a binary of stitchmd and implement your own behavior

    uses: abhinav/stitchmd-action@v1
with:
  mode: install

For more information, see stitchmd-action.