Skip to content

Commit 58d3bae

Browse files
committed
Fixes to readme
1 parent 7da94ae commit 58d3bae

1 file changed

Lines changed: 19 additions & 10 deletions

File tree

readme.md

Lines changed: 19 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -25,21 +25,30 @@ It looks like this after it has run:
2525

2626
## Usage
2727

28-
Typically this is used with a changelog builder:
28+
This is typically deployed as a scheduled action:
2929

3030
```yaml
31+
name: Catalog
32+
on:
33+
schedule:
34+
- cron: '30 5 * * *'
35+
workflow_dispatch:
36+
jobs:
37+
catalog:
38+
runs-on: ubuntu-latest
39+
steps:
40+
- name: Notion github catalog
41+
uses: infinitaslearning/notion-github-catalog@main
42+
with:
43+
github_owner: infinitaslearning
44+
github_token: ${{ secrets.PAT_GITHUB_TOKEN }}
45+
notion_token: ${{ secrets.NOTION_TOKEN }}
46+
database: 2b26b4290cc84d95ad3e93c3255277a1
47+
repository_type: all
3148

32-
- name: Notion github catalog
33-
uses: infinitaslearning/notion-github-catalog@main
34-
with:
35-
github_owner: infinitaslearning
36-
github_token: ${{ secrets.GITHUB_TOKEN }}
37-
notion_token: ${{ secrets.NOTION_TOKEN }}
38-
database: 619f0845c68a4c18837ebdb9812b90c0
39-
repository_type: all
4049
```
4150

42-
To get the database ID, simply browse to it, click on the '...' and get a 'Copy link'. The GUID at the end of the URL is the id.
51+
To get the database ID, simply browse to it, click on the '...' in Notion, and get a 'Copy link'. The GUID at the end of the URL is the id, this works on both embedded and full page databases.
4352

4453
## Development
4554

0 commit comments

Comments
 (0)