Skip to content

Commit

Permalink
📝 Add Automatic sync of Action documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
JeroenKnoops committed Oct 14, 2021
1 parent cdf8b8f commit 57ee3be
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 0 deletions.
25 changes: 25 additions & 0 deletions .github/workflows/action-docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Workflow to keep action docs up to date

name: 'Action docs'
on:
push:
branches:
- main
- add-github-action-docs

jobs:
update:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2.3.4

- uses: npalm/action-docs-action@v1.1.0
with:
tocLevel: 4

- name: Update readme in the repository
if: github.event_name != 'pull_request'
uses: stefanzweifel/git-auto-commit-action@v4.12.0
with:
commit_message: "chore(ci): Updating readme"
file_pattern: README.md
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -127,6 +127,11 @@ The easiest way to use this action is to add the following into your workflow fi
with:
path: build.provenance
```

<!-- action-docs-description -->
<!-- action-docs-inputs -->
<!-- action-docs-outputs -->

### Available commands
* Generate
Command that generates the provenance.
Expand Down

0 comments on commit 57ee3be

Please sign in to comment.