https://github.com/szenius/notion-burndown

Generate burndown chart from Notion database
https://github.com/szenius/notion-burndown

burndown burndown-chart notion notion-api notion-database notion-enhancer scrum scrum-agile

Last synced: 3 days ago
JSON representation

Generate burndown chart from Notion database

• Host: GitHub
• URL: https://github.com/szenius/notion-burndown
• Owner: szenius
• Created: 2021-07-26T15:23:14.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2024-04-13T01:03:25.000Z (7 months ago)
• Last Synced: 2024-04-14T00:41:47.852Z (7 months ago)
• Topics: burndown, burndown-chart, notion, notion-api, notion-database, notion-enhancer, scrum, scrum-agile
• Language: JavaScript
• Homepage:
• Size: 4.18 MB
• Stars: 58
• Watchers: 5
• Forks: 25
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# notion burndown

![on_master](https://github.com/szenius/notion-burndown/actions/workflows/on_master.yml/badge.svg)

Generates burndown charts based on Notion databases.

This goes out to all of us who chose to put our scrum boards on Notion even though it doesn't have proper scrum features... Just because it's \*~aesthetic~\*.

## Usage

### Step 1. One-time setup on Notion

1. [Create a Notion integration](https://developers.notion.com/docs/getting-started#step-1-create-an-integration).

   1. Copy down the secret token and store it somewhere safe.

2. You should have one database for your product backlog. On top of that, you need to create two other databases:

   1. Sprint Summary: List of sprints and their information. For the integration to retrieve the latest sprint's information.

      1. Compulsory fields: Sprint (number), Start (Date), End (Date)

   2. Daily Summary: How many points are left in the latest sprint every day.

      1. Compulsory fields: Sprint (number), Date (Date), Points (number)

3. [Give your integration access to all 3 databases.](https://developers.notion.com/docs/getting-started#step-2-share-a-database-with-your-integration)

You may refer to [this template](https://szenius.notion.site/Template-Notion-Burndown-Chart-ca567af7c1e34a9dadb56db8095b7349) for setting up your own databases.

### Step 2. Schedule the integration to run daily

This project is published as a GitHub action in the marketplace. You can make use of scheduled GitHub workflows to run it for free.

```yml

uses: szenius/[email protected]

with:

  NOTION_KEY: "Notion integration access token"

  NOTION_DB_BACKLOG: "Notion Database ID of Sprint Backlog"

  NOTION_DB_SPRINT_SUMMARY: "Notion Database ID of Sprint Summary"

  NOTION_DB_DAILY_SUMMARY: "Notion Database ID of Daily Summary"

  NOTION_PROPERTY_SPRINT: "Name of the property with the sprint number"

  NOTION_PROPERTY_ESTIMATE: "Name of the property with the estimate"

  NOTION_PROPERTY_PATTERN_STATUS_EXCLUDE: "Regex of the statuses of stories which are done"

  INCLUDE_WEEKENDS: "True if weekends should be included in the chart, false otherwise."

  SPRINT_START: "True if it is the start of a new sprint, false otherwise. When true, a new entry will be created in the Sprint Summary database, and the sprint end date will be 14 days later (sprint start day excluded). Note that new sprint summary will not be created if today is still in the middle of the last sprint."

```

You should set up two workflows:

1. Workflow that runs at the start of each sprint - refer to [this workflow](.github/workflows/sprint_start.yml) for setting up your own

2. Workflow that runs daily during the sprint - refer to [this workflow](.github/workflows/sprint_daily.yml) for setting up your own