Skip to content

Commit

Permalink
chore: add details to the readme (#23)
Browse files Browse the repository at this point in the history
* chore: add details to the readme

Clarify the steps required in order to set this up.

* fix(readme): remove `v` prefix from release

As the release is named `1.0.0` the example in the readme will fail to fetch `v1.0.0`.

Co-authored-by: Sebastian Holmqvist <csholmq@users.noreply.github.com>
  • Loading branch information
csholmq and csholmq committed Sep 15, 2021
1 parent 2ad3995 commit 090f4be
Showing 1 changed file with 9 additions and 5 deletions.
14 changes: 9 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,15 +18,15 @@ Notion Board
## Introduction
This action lets you sync your GitHub issue with your notion board. Currently it syncs issue state and labels.

> More feature on the way.
> More features on the way.
## Inputs

|input|description|required|
|-----|-----------|--------|
|`NOTION_API_KEY`|your notion api key|`true`|
|`NOTION_DATABASE`|your notion database id|`true`|
|`GITHUB_TOKEN`|your github token|`true`|
|`GITHUB_TOKEN`|your github token|`true`| (automatically created)

## Usage
```yml
Expand All @@ -40,18 +40,22 @@ jobs:
steps:
- uses: actions/checkout@v2
- name: Notion Board
uses: Souvikns/Notion-Board@v1.0.0
uses: Souvikns/Notion-Board@1.0.0
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
NOTION_API_KEY: ${{ secrets.NOTION_API_KEY }}
NOTION_DATABASE: ${{ secrets.NOTION_DATABASE }}
```

As of now notion API does not allow creating or changing properties, so right now you have to add these properties manually to use this action.
Start with [setting up an integration and sharing your Notion database](https://developers.notion.com/docs/getting-started) with the integration.

After setting up your workflow, add your `NOTION_API_KEY` and `NOTION_DATABASE` secrets to your repository.

As of right now notion API does not allow creating or changing properties, meaning you have to **add these properties manually** to your database in order to use this action.
- URL - type: `URL`
- id - type: `Number`
- state - type: `Select`
- labels - type: `Mutli-Select`
- labels - type: `Multi-Select`

## Screenshot
![board](./screenshots/notion-board.PNG)

0 comments on commit 090f4be

Please sign in to comment.