-
Notifications
You must be signed in to change notification settings - Fork 11
26 lines (26 loc) · 1.1 KB
/
github-action-update-readme.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
name: update README.md code blocks
on: [push, pull_request]
jobs:
build:
runs-on: ubuntu-latest
steps:
- name: checkout
uses: actions/checkout@v3
- name: Markdown autodocs
uses: dineshsonachalam/markdown-autodocs@v1.0.7
with:
# Optional, defaults to author of the commit that triggered the run
commit_author: Author <actions@github.com>
# Optional, defaults to "actions@github.com"
commit_user_email: actions@github.com
# Optional, but recommended
# Defaults to "Apply automatic changes"
commit_message: Apply automatic changes
# Optional branch name where commit should be pushed to.
# Defaults to the current branch.
# branch: feature-123
# Optional output file paths, defaults to '[./README.md]'.
# output_file_paths: '[./README.md]'
# Categories to automatically sync or transform its contents in the markdown files.
# Defaults to '[code-block,json-to-html-table,workflow-artifact-table]'
categories: '[code-block]'