docs: update readme.md #2
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,14 +1,47 @@ | ||
| # org-actions-template | ||
| 노션 - 깃허브 연동 자동화 레포지토리 | ||
|
|
||
| ## 기능 안내 | ||
| ### 0. 페이지 감지 기능 | ||
| - 최근 100개 문서를 대상으로 자동 검색 | ||
| - 브랜치명 기반으로 해당 페이지 자동 감지 | ||
| 예) `TEAM-132-add-search` → `TEAM-132`를 감지 | ||
|
|
||
| ### 1. 속성 변경 기능 | ||
| - PR이 열리면(`open`) 상태를 **진행 중**으로 변경 | ||
| - PR이 머지되면(`merge`) 상태를 **완료**로 변경 | ||
|
|
||
| ### 2. 링크 연동 기능 | ||
| - `GitHub Pull Requests` 속성에 PR 링크 자동 추가 | ||
|
|
||
| ## 설정 안내 | ||
|
|
||
| ### 1. Notion 설정 | ||
| - **기본키 속성** | ||
| - 속성 이름: `ID` (식별용 기본키로 반드시 `ID`여야 합니다) | ||
|  | ||
|
|
||
| - **GitHub 링크 연결용 속성** | ||
| - 속성 타입: `url` | ||
| - 속성 이름: `GitHub Pull Requests` | ||
|  | ||
|
|
||
| --- | ||
|
|
||
| ### 2. GitHub Secret 설정 | ||
| - Notion 데이터베이스 아이디를 레포지토리 시크릿 키로 등록합니다. | ||
| - GitHub 시크릿 키 이름: `NOTION_DATABASE_ID` | ||
| - 예시 URL: | ||
|
|
||
| ``` | ||
| https://www.notion.so/example/example-227402b843138042a10ec85b1ec04aaf | ||
| ``` | ||
| → 이 중 227402b843138042a10ec85b1ec04aaf 가 데이터베이스 아이디입니다. | ||
|
|
||
|
|
||
|
|
||
|
|
||
|
Comment on lines
+42
to
+43
There was a problem hiding this comment. There are multiple consecutive blank lines here. For better readability and consistency, it's best to use only one or two blank lines to separate sections. I'd suggest removing these extra blank lines. |
||
| ### 에러 시 확인할 부분 | ||
| - 생성일시가 `생성 일시` 인지 확인 | ||
| - `상태` 속성이 맞는지 확인, `진행 중` 속성, `완료` 속성이 있는지 확인 | ||
| - 그 외 본 레포지토리의 scripts/sync-notion.ts 코드를 확인해 코드와 다르게 설정한 부분이 있는지 확인 | ||
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
This line, along with several others in the file, has trailing whitespace. While this doesn't break rendering on most markdown viewers, it's a good practice to remove trailing spaces for consistency and to avoid potential issues in stricter environments or with certain tools.
This also applies to lines 7, 19, 20, 21, 22, 24, 25, 26, 27, 31, and 34.