changelog-syncer

GitHub Action to synchronize the description of a pull request to a Notion Database.

Usage

Example of a workflow sending details of merged pull requests to a Notion Database.

name: Changelog sync

on:
  pull_request_target:
    branches: ["main"]
    types:
      - closed

permissions: read-all

jobs:
  if_merged:
    if: github.event.pull_request.merged == true
    runs-on: ubuntu-latest
    steps:
      - name: Synchronize changelog
        uses: Mergifyio/gha-changelog-syncer@main
        with:
          NOTION_API_KEY: ${{ secrets.NOTION_API_KEY }}
          NOTION_DATABASE_ID: ${{ secrets.NOTION_DATABASE_ID }}

Run locally

Clone the repository and install Python dependecies.

poetry install

Create a .env file by copying .env.example file and completing empty variables. Then run the program.

poetry run cli_handler --title 'hello' --description 'there' --merged_at '2022-10-17'