feat(INT-52): add GHA to sync issues to Notion DB #53
Conversation
WalkthroughA new GitHub Actions workflow named "Notion Sync" has been introduced. This workflow is set to trigger on manual invocation as well as various GitHub issue events such as opened, edited, labeled, and closed. It runs a job that utilizes the Changes
Sequence Diagram(s)sequenceDiagram
participant GitHub
participant Notion Sync Workflow
participant Notion API
GitHub->>Notion Sync Workflow: Issue event or manual dispatch
Notion Sync Workflow->>Notion API: Sync issue data (using secrets)
Notion API-->>Notion Sync Workflow: Confirmation/response
Possibly related PRs
Poem
Tip ⚡💬 Agentic Chat (Pro Plan, General Availability)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
Documentation and Community
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
.github/workflows/notion-sync.yaml (2)
6-20: Consider optimizing event triggers to reduce unnecessary runs.
You’re listening to a broad set of issue events—including high‑frequencyeditedevents—which may trigger redundant syncs for minor changes. You could add anifcondition on the job or step to run only when the issue’s title or body actually changes, for example:jobs: notion_job: if: > github.event_name == 'workflow_dispatch' || (github.event_name == 'issues' && (github.event.action != 'edited' || github.event.changes.title || github.event.changes.body)) runs-on: ubuntu-latest …This can help avoid rate‑limit issues or unwanted updates.
26-30: Pin to a stable release and verify action inputs.
- You’re currently pinned to a commit hash for immutability; consider switching to the official release tag (e.g.,
@v2) for easier upgrades:- uses: tryfabric/notion-github-action@10c6b128faeb9a1f16efc65a0b388b7595047e62 + uses: tryfabric/notion-github-action@v2- If future steps need repository context, add a checkout step:
- uses: actions/checkout@v3- Finally, please confirm that the input keys
notion-tokenandnotion-dbmatch the action’s documentation for the version you’re using.
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
.github/workflows/notion-sync.yaml(1 hunks)
🔇 Additional comments (2)
.github/workflows/notion-sync.yaml (2)
1-5: Root-level permissions are minimal and appropriate.
Scopingpermissions: issues: readat the workflow level follows the principle of least privilege and limits the GITHUB_TOKEN to only what’s required.
21-25: Job definition is clear and concise.
Yournotion_jobusesubuntu-latestand has a descriptive name, which makes it easy to understand in the Actions UI.
| name: Add GitHub Issues to Notion | ||
| steps: | ||
| - name: Add GitHub Issues to Notion | ||
| uses: tryfabric/notion-github-action@10c6b128faeb9a1f16efc65a0b388b7595047e62 |
There was a problem hiding this comment.
Maybe a comment here for what GitHub release this is?
|
@westonplatter we're good to close out, yeah? |
what
why
references
Summary by CodeRabbit