-
Notifications
You must be signed in to change notification settings - Fork 17
/
Copy pathaction.yml
42 lines (38 loc) · 1.68 KB
/
action.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
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
name: Markdown autodocs
description: 'A github action that automatically format markdown files, sync external docs/src code & make better docs.'
author: Dinesh Sonachalam <[email protected]>
inputs:
commit_author:
description: Value used for the commit author. Defaults to the username of whoever triggered this workflow run.
required: false
default: ${{ github.actor }} <${{ github.actor }}@users.noreply.github.com>
commit_user_email:
description: Email address used for the commit user
required: false
default: [email protected]
commit_message:
description: Commit message
required: false
default: Apply automatic changes
branch:
description: Git branch name, where changes should be pushed too.
required: false
default: ${{ github.head_ref }}
output_file_paths:
description: Output markdown file paths.
required: false
default: '[./README.md]'
categories:
description: Categories to automatically sync or transform its contents in the markdown files.
required: false
default: '[code-block,json-to-html-table,workflow-artifact-table,markdown]'
runs:
using: composite
steps:
- run: wget https://raw.githubusercontent.com/dineshsonachalam/markdown-autodocs/master/action.py
shell: bash
- run: python3 action.py -repo '${{ github.repository }}' -access_token '${{ github.token }}' -commit_author '${{ inputs.commit_author }}' -commit_user_email '${{ inputs.commit_user_email }}' -commit_message '${{ inputs.commit_message }}' -branch '${{ inputs.branch }}' -output_file_paths '${{ inputs.output_file_paths }}' -categories '${{ inputs.categories }}'
shell: bash
branding:
icon: 'book'
color: blue