Skip to content

Commit

Permalink
Update branding and readme
Browse files Browse the repository at this point in the history
  • Loading branch information
cliftonc committed Dec 20, 2021
1 parent f0006a8 commit d5f9756
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 4 deletions.
5 changes: 3 additions & 2 deletions action.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
name: 'Notion release notes'
description: 'Creates a new page in an existing database to capture release notes'
icon: type
color: green
branding:
icon: type
color: green
inputs:
token:
description: 'Notion API token'
Expand Down
6 changes: 4 additions & 2 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ This would typically be used alongside https://github.com/mikepenz/release-chang

First, you need to have an integration access token - which you can get from https://www.notion.so/my-integrations after creating an integration. Give the integration a friendly name like 'Github Action Release Notes'.

By default integrations cant access any contentm so you you *must* share your database with the integration you created earlier to be able to access it!
By default integrations cant access any content so you you *must* share your database with the integration you created earlier to be able to access it!

## Notion Database

Expand All @@ -18,6 +18,8 @@ This action expects a Notion database with the following properties:
- Date: date
- Tags: tags

You can use the following template and duplicate it: https://infinitaslearning.notion.site/Notion-Release-Notes-a97bedb581464a3ea24159d8eac576c0

It can look like this:

<img width="981" alt="Screenshot 2021-12-18 at 08 55 42" src="https://user-images.githubusercontent.com/239305/146633970-5e1baaf8-6457-4664-b56c-284355e3b241.png">
Expand Down Expand Up @@ -50,5 +52,5 @@ To get the database ID, simply browse to it, click on the '...' and get a 'Copy
## Development
Assumes you have `@vercel/ncc` installed globally.
Assumes you have `@vercel/ncc` installed globally, you need a `NOTION_TOKEN` in your environment for the tests to pass.
After changes ensure you `npm run build`, commit and then submit a PR.

0 comments on commit d5f9756

Please sign in to comment.