-
Notifications
You must be signed in to change notification settings - Fork 0
feat: add git workflow #1
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Summary of Changes
Hello @sezeme, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
This pull request introduces a new feature that establishes an automated workflow to integrate GitHub Pull Requests with Notion. It sets up a Node.js project with a TypeScript script that, when triggered by a PR event, extracts relevant information from the PR and uses the Notion API to update a corresponding entry in a Notion database. This aims to streamline the tracking and management of development tasks by linking them directly to GitHub PR activity.
Highlights
- Automated Notion Integration: Introduced a new TypeScript script (
scripts/sync-notion.ts) designed to run as a GitHub Action, enabling automatic synchronization of GitHub Pull Request information with Notion database entries. - PR-to-Notion Sync Logic: The core script extracts a document ID from the pull request's branch name (e.g.,
FEAT-123), queries a specified Notion database for a matching page, and then updates that page's 'GitHub Pull Requests' property with the PR's URL and its 'Status' property (e.g., '진행 중' for open, '완료' for merged) based on the PR's current state. - Project Setup and Dependencies: Initialized a Node.js project with
package.json,pnpm-lock.yaml, andtsconfig.json, setting up necessary dependencies like@actions/core,@actions/github, and@notionhq/clientfor interacting with GitHub Actions and the Notion API, along withtsxfor running TypeScript directly. - Updated Documentation: The
README.mdhas been updated to include detailed setup instructions for both Notion (specifying the requirement for an 'ID' primary key) and GitHub secrets (explaining how to obtain and set theNOTION_DATABASE_ID).
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments or fill out our survey to provide feedback.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code Review
This pull request introduces a GitHub workflow to synchronize pull request status with a Notion database. Key areas for improvement include validating environment variables, using stable dependency versions, improving documentation, and enhancing type safety.
|  | ||
|
|
||
| github secret 설정 | ||
| - 노션 데이터베이스 아이디를 레포지토리 시크릿 키로 저장해야 합니다. 데이터베이스 아이디는 노션 링크의 숫자 부분입니다. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| import * as core from "@actions/core"; | ||
| import * as github from "@actions/github"; | ||
|
|
||
| const notion = new Client({ auth: process.env.NOTION_TOKEN }); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
|
|
||
| async function run() { | ||
| try { | ||
| const dbId = process.env.NOTION_DATABASE_ID!; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| # Node.js | ||
| node_modules/ No newline at end of file |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| ## 설정 | ||
| notion 설정 | ||
| - 식별할 수 있는 기본키 이름이 ID여야 합니다. | ||
|  |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| "dependencies": { | ||
| "@actions/core": "^1.10.0", | ||
| "@actions/github": "^5.0.0", | ||
| "@notionhq/client": "^4.0.1", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| const propStatus = process.env.NOTION_PROP_STATUS || "상태"; | ||
| const propPR = process.env.NOTION_PROP_PR || "GitHub Pull Requests"; | ||
|
|
||
| const { pull_request: pr } = github.context.payload as any; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| const update: any = { | ||
| properties: { | ||
| [propPR]: { | ||
| url: prUrl, | ||
| }, | ||
| }, | ||
| }; | ||
| if (prState) { | ||
| update.properties[propStatus] = { | ||
| select: { name: prState }, | ||
| }; | ||
| } | ||
|
|
||
| await notion.pages.update({ page_id: pageId, ...update }); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
To improve type safety, define a specific type for the update object's properties instead of using any.
interface UpdateProps {
[key: string]: { url?: string; select?: { name: string } };
}
const properties: UpdateProps = {
[propPR]: {
url: prUrl,
},
};
if (prState) {
properties[propStatus] = {
select: { name: prState },
};
}
await notion.pages.update({ page_id: pageId, properties });
No description provided.