Skip to content
This repository was archived by the owner on Nov 14, 2021. It is now read-only.

Commit 9a9217e

Browse files
committed
feat: Add description of inputs
1 parent 1e6073d commit 9a9217e

File tree

1 file changed

+31
-19
lines changed

1 file changed

+31
-19
lines changed

action.yml

Lines changed: 31 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,63 +1,75 @@
1-
name: 'Notion2Github'
1+
name: Notion2Github
22
author: Younho Choo
3-
description: 'Automatic syncronization from Notion to Github'
3+
description: Automatic syncronization from Notion to Github
44
branding:
55
icon: inbox
66
color: black
77
inputs:
88
database-url:
9-
description: ''
9+
description: URL of the notion database to extract.
1010
required: true
1111

1212
# export config
1313
docs-directory:
14-
description: ''
14+
description: Directory in which the notion page to extract will be stored.
1515
required: false
1616
recursive-export:
17-
description: ''
17+
description: Whether or not to recursively export child page.
1818
required: false
1919
create-page-directory:
20-
description: ''
20+
description: Whether or not to create subdirectory with page title.
2121
required: false
2222
add-metadata:
23-
description: ''
23+
description: Whether or not to add metadata to content.
2424
required: false
2525
lower-pathname:
26-
description: ''
26+
description: Whether or not to make pathname to lowercase.
2727
required: false
2828
lower-filename:
29-
description: ''
29+
description: Whether or not to make pathname to uppercase.
3030
required: false
3131
line-break:
32-
description: ''
32+
description: Whether or not to convert empty blocks of notion to line break tag(<br />).
3333
required: false
3434

3535
# database-config
3636
category-column-name:
37-
description: ''
37+
description: >
38+
In the Notion database, you can categorize content by category with "Select" property.
39+
If you create a "Select" property in the Notion database and pass the name of the column,
40+
then folders will be created by category.
3841
required: false
3942
tags-column-name:
40-
description: ''
43+
description: >
44+
In the Notion database, you can tag content with "Multi Select" property. (should set add_metadata to True.)
45+
If you create a "Multi Select" property in the Notion database and pass the name of the column,
46+
then meta data will be insterted to contents.
4147
required: false
4248
created-time-column-name:
43-
description: ''
49+
description: >
50+
In the Notion database, you can manage created time of content with "Created Time" property.
51+
If you create a "Created Time" property in the Notion database and pass the name of the column,
52+
you can add created time to filename.
4453
required: false
4554
status-column-name:
46-
description: ''
55+
description: >
56+
In the Notion database, you can manage the status of content with "Select" property.
57+
If you create a "Select" property in the Notion database and pass the name of the column,
58+
you can import contents in a specific state or change the status of the content.
4759
required: false
4860
current-status:
49-
description: ''
61+
description: Status of content to import. Must be an option in the "status_column_name" column.
5062
required: false
5163
next-status:
52-
description: ''
64+
description: Status of contents after content was imported. Must be an option in the "status_column_name" column.
5365
required: false
5466
filters:
55-
description: ''
67+
description: Key, value pair of filter list to apply to the Notion database.
5668
required: false
5769

5870
runs:
59-
using: 'docker'
60-
image: 'Dockerfile'
71+
using: "docker"
72+
image: "Dockerfile"
6173
args:
6274
- ${{ inputs.database-url }}
6375
- --docs-directory

0 commit comments

Comments
 (0)