refactor: 다른 레포에서 호출해 사용할 수 있도록 설정 업데이트 #4
Conversation
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
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 focuses on enhancing the reusability of the project's GitHub Action for Notion synchronization. It achieves this by updating the README.md to provide comprehensive guidance for external repositories wishing to integrate and utilize this action, streamlining the setup process for consumers.
Highlights
- Action Reusability: The primary goal of this pull request is to refactor the documentation to enable the project's Notion synchronization GitHub Action to be easily called and reused from other repositories.
- Updated Setup Guide: The
README.mdhas been significantly updated to provide clear instructions, including a YAML snippet, for consuming repositories on how to integrate and configure thesync-notion.ymlworkflow. - Documentation Restructuring: Notion-specific property setup details (like
IDandGitHub Pull Requestsproperties) have been relocated from the main setup section to an 'Error checking' section, clarifying their role as prerequisites for the action's proper functioning rather than initial setup steps for this repository.
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.
Code Review
This pull request refactors the documentation to explain how to use the GitHub Action as a reusable workflow from other repositories. The changes are a good step towards making the action more accessible. I've added a few comments to improve the clarity and completeness of the setup instructions, which should help users avoid common configuration issues.
| ``` | ||
| https://www.notion.so/example/example-227402b843138042a10ec85b1ec04aaf | ||
| ``` | ||
| - 레포지토리 시크릿 키에 `NOTION_DATABASE_ID` 추가 |
There was a problem hiding this comment.
The setup instructions are missing guidance for the NOTION_TOKEN secret. The example workflow file requires secrets.NOTION_TOKEN, but this section only mentions NOTION_DATABASE_ID. This omission will likely lead to setup failures for users.
Please add instructions for creating the NOTION_TOKEN secret as well. It's a token generated from Notion's integrations page.
| - 레포지토리 시크릿 키에 `NOTION_DATABASE_ID` 추가 | |
| - 레포지토리 시크릿 키에 `NOTION_TOKEN`과 `NOTION_DATABASE_ID`를 추가합니다. |
| - 속성 타입: `url` | ||
| - 속성 이름: `GitHub Pull Requests` | ||
|  | ||
| ``` |
There was a problem hiding this comment.
For better readability and to enable syntax highlighting, it's good practice to specify the language of a code block in Markdown. Please add yaml to this code block.
| ``` | |
| ```yaml |
| ### 에러 시 확인할 부분 | ||
| - **기본키 속성** | ||
| - 속성 이름: `ID` (식별용 기본키로 반드시 `ID`여야 합니다) | ||
|  | ||
|
|
||
| - **GitHub 링크 연결용 속성** | ||
| - 속성 타입: `url` | ||
| - 속성 이름: `GitHub Pull Requests` | ||
|  | ||
|
|
||
| ### 에러 시 확인할 부분 | ||
| - 생성일시가 `생성 일시` 인지 확인 | ||
| - `상태` 속성이 맞는지 확인, `진행 중` 속성, `완료` 속성이 있는지 확인 | ||
| - 그 외 본 레포지토리의 scripts/sync-notion.ts 코드를 확인해 코드와 다르게 설정한 부분이 있는지 확인 |
There was a problem hiding this comment.
The "에러 시 확인할 부분" (What to check in case of an error) section contains essential setup requirements for the Notion database. It would be more user-friendly to present this information as a prerequisite step, rather than as a troubleshooting guide.
Consider restructuring the documentation to have a dedicated "Notion Database Setup" section that lists all required properties (ID, GitHub Pull Requests, 생성 일시, 상태, etc.) before the "GitHub Secret 설정" section. This would provide a clearer, step-by-step guide for new users.
No description provided.