From dc1eb5344406ac2c12cc02d05ee9244e6c3d71b9 Mon Sep 17 00:00:00 2001 From: sezeme Date: Sun, 3 Aug 2025 20:48:24 +0900 Subject: [PATCH] docs: update readme.md --- README.md | 55 ++++++++++++++++++++++++++++++++++--------- assets/github_pr.png | Bin 0 -> 7019 bytes 2 files changed, 44 insertions(+), 11 deletions(-) create mode 100644 assets/github_pr.png diff --git a/README.md b/README.md index 8f54314..de657e3 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,47 @@ -# org-actions-template -노션 - 깃허브 연동을 위한 자동화 레포지토리 +# org-actions-template +노션 - 깃허브 연동 자동화 레포지토리 -## 설정 -notion 설정 -- 식별할 수 있는 기본키 이름이 ID여야 합니다. - ![기본키](assets/id.png) +## 기능 안내 +### 0. 페이지 감지 기능 +- 최근 100개 문서를 대상으로 자동 검색 +- 브랜치명 기반으로 해당 페이지 자동 감지 + 예) `TEAM-132-add-search` → `TEAM-132`를 감지 -github secret 설정 -- 노션 데이터베이스 아이디를 레포지토리 시크릿 키로 저장해야 합니다. 데이터베이스 아이디는 노션 링크의 숫자 부분입니다. -- 시크릿 키 이름은 `NOTION_DATABASE_ID`로 설정해야 합니다. +### 1. 속성 변경 기능 +- PR이 열리면(`open`) 상태를 **진행 중**으로 변경 +- PR이 머지되면(`merge`) 상태를 **완료**로 변경 + +### 2. 링크 연동 기능 +- `GitHub Pull Requests` 속성에 PR 링크 자동 추가 + +## 설정 안내 + +### 1. Notion 설정 +- **기본키 속성** + - 속성 이름: `ID` (식별용 기본키로 반드시 `ID`여야 합니다) + ![기본키](assets/id.png) + +- **GitHub 링크 연결용 속성** + - 속성 타입: `url` + - 속성 이름: `GitHub Pull Requests` + ![GitHub Pull Requests 속성 예시](assets/github_pr.png) + +--- + +### 2. GitHub Secret 설정 +- Notion 데이터베이스 아이디를 레포지토리 시크릿 키로 등록합니다. +- GitHub 시크릿 키 이름: `NOTION_DATABASE_ID` +- 예시 URL: + +``` +https://www.notion.so/example/example-227402b843138042a10ec85b1ec04aaf ``` -https://www.notion.so/example/example-227402b843138042a10ec85b1ec04aaf 에서 227402b843138042a10ec85b1ec04aaf 부분 -``` \ No newline at end of file +→ 이 중 227402b843138042a10ec85b1ec04aaf 가 데이터베이스 아이디입니다. + + + + +### 에러 시 확인할 부분 +- 생성일시가 `생성 일시` 인지 확인 +- `상태` 속성이 맞는지 확인, `진행 중` 속성, `완료` 속성이 있는지 확인 +- 그 외 본 레포지토리의 scripts/sync-notion.ts 코드를 확인해 코드와 다르게 설정한 부분이 있는지 확인 \ No newline at end of file diff --git a/assets/github_pr.png b/assets/github_pr.png new file mode 100644 index 0000000000000000000000000000000000000000..7fdae4fac144d5c521d0f4bce481e648b1e55788 GIT binary patch literal 7019 zcmb_>Wmj9@6D~EN=&xvj0HsBW6?ZExg&@VX6etu6?p7#JXoD1YTHM`(JA`0`AR$3c*yX8ih-eBDoE)en||>59pdC@pc`kyRq|D`AKDr=iW31Y zm}I~Wet{dToJ>XeKS3i$DJQT5|8>`NU^*FJwP zdW@5ieTbm-r+Vw`{H&zis5g-_jc}+W5(-_8dvc=mEt(H)>5_mH0%p2K!kP|h{ARVl z8KSe<5ET*`h!;N?!(UXeNJQJbF3omp?6&BR)aq)4oh)2u{IEy48oU>ZR?tc#_vT^1?~F2 zM#QCXJM)f;i#^1;&zKkS6RzxhWPEcjd2L4}xJ$KK0Rx70T-Be1+`dF!9jf;NXYGCdOx0yeS0qSwxp-n-N)N#Ha-cB{2A< z==L9r`7~cpd}89ypFe+uE56UwVr9$wd043dme0(s{d3yh(EoBQGxCS!WIpuq<4e+| zgHbN2dpKIc_w+%f78p$Q^yyQqMqjVz_I&x1TbDZ(-92)O;{}jF3cu=aJQn?{8^|~Y z*)SeYbpH=OXMUk_v(?iro7IK;0%1|n)$+`n?^)B;@yw5b_$tdf(vYmWB`1wUjt!Yn$o*6!jlU=O^| zt`C9B<>|Zjf0&pWo15Zd{u_;b75H1@@5fL}}Ih`-2@|A%QWupBCTc+J`(WQyJ?;K|J z@lCGi)zvH4%c}y;Yb$kkrnte)-TBbpzh72E76S_Hin$PP-taq2gYvYLoyQl#biiQ2 zw7{7G#S_U7`{@^#+rzzbiW$Y{B1J{$qJg;E4Jmelu+vAx`xQt2C_6e>{wj4=JK$>B z*{d9ewLv2Eh)+iw_#!@kM-8F%;!)MSdz#C9?Z|S|@dHR{c6N}FfkEx5eW;vPY^@7%6c}t%H)s1^8t~$5 z(*7Cp$~cn;Vj=;%g`Mf=dEY68D+9Sytj=x*02x=@t7GZDp#0ResHljMh3VOIueVYt z|8v#SJ2a7owsz02jz@ACk^I8g9aHQ{B4l1mzry?7MQJ0HpEfo&f3&mvo|Z-v5>Bwz zw4t~%TfO!uu>EW~7JII8Oaqa@u5MdhRn<9Kfzurxoo!IFj-_v8l=DcNjr{IT?92@H z;1SM5qcUlT1yzgp3HCOLfQ0XPIfW&=a^3`WcmcZrWO)!4O)*xWF15S6>$Q<_VbFN! zicL&qYdn?vCS9tZzWqM3z?!{JJz1^*oYCa6MnWT0DqW;atyhtt<<6>AM9`F%ca)Ev zH)YGJQ^F%8)UV3+Wa)g*$R1T0b$aR+M&zG5p3`q`Z9R&}n8y`$R&9q^wf6MLU7zob z&N!1gd0xDD@d1ZwYfA^AB~&L7=rrd1ka)j9%?<*fn(BQ0p0Lj;ZY)bTVbq0sOl&M- z9?~kUt<5-jCy~L`ew_+LG*2KpJYCGUudz8ZA%T3j-L!Mgou;a$#^Pv#>*{2{IWe&H zAv-&}e`{{fW3>N<8fpP$0Q>tcjLSVy#=`dZ})w*3~CkTO}I38cXf%P$i-FnE-DdKB<1#h`nl5Fh#gZW<#a zBMJ^cUb4GgHZK7ZDqpZQ?z*|3oo7pJDA^dB`e5z%JyFPN*V zd1YjS2jTFb$Z;m9?r@n=Low)CoZ)SZX7x_i!SfQZshw`dEGueEBkcW@Zv=W^RtxYMcFZcMAWY z-hqnGgQL~wY(11xK}*XRUXB&$KV0mYCF!<(8b3Z>{7zN1V{VRG2-)(K<{#8JIXTI_ zNqQBVyu7p&loLmqnCJ<4f#vOu2jGvLUvEDKlev^3_5>!l=g!>D|3s=iQ#If-UXB8k zNk}MZvv8ZU1BaD^gOQmT&)3%%wXgsc5-RNJd90=N^YhwTXhsIDVOgT=7aXkQv-Nob z-)jS(i>={Op~cSm7S7mM7R@5wJ64Dj~#y3dnTQUMdPff2U80YN>v za&xsu>uanPOF+(0jw?7EzkPCA&MR}Qo;_tdd)s{h#DDcwf0md3wQ6R-x&Z|j<|kK@ zKeYDu18vd>x!{}}QXu-37)f^bc0W(_P$~8wXR))A;jJSwMpyF8c>Q`@Ij;Sla{U0w zd+Fmw`aVv>0aoRpDX&Y%KT-+J0S}QQ~z6*`LJwBPXT|8ihrd4_@ zC@4UwyHBYg+&}_EH7A4`nslYQ(*ULeOKcZxJ}7s=glkZ4T>NSLn&i>@44hr57-m;p*B{>Kz7WX=$lr zghpu0woX`7WV})H6+qMo*F8_j@KjVH&%SIOOxOqzP>YiR1mJpk|6G!`(f@{`0U8Wr z&CSpK003D|TpWNECrS?;+_cGf#@9}MCnhGsgl+k?isF-#TU_%NFt@LDN@nZW-v(Oj zjOVZ{G`k~_-v5b-wb)7s))|g8)mRe*FOQ@Ja=qu}6iA?*zb`x@r=l`9ZbfAJP2g}< zOk-O~(u%I^?#lT2p&l89>d-s{$e6`iK=}ah1sB^~^_iQ3fx*FLH&y;unZB6-N2RjgLAT#gugx6CW4>a^PpwvW;JFxp`TVCa_HJX^ zVeSLupd;p&`l=>VMXo%)dTCkNApG@#iLQ=F*5|LddNjxosVFk@ml25by2%`eaD4k1gDQmX>yh zliS<7uCH%>pN%MJeI(Vw+`O}FKA*65t@T7(T*7Ffq0`2eFhEh*b05T_o){=xR$BU8 zDBvLx5fNynJ^I_B6Tpa;`k*xFBBaBRc1&^B(#6@HOmwCMG|D6J>gp=~Ig>Uyx~Uu8 z+Cms?Zevp^ozZ-}H5QvtqKmxr*;*^=o7#bok5?HIkM#A00TaE~)|UIcg{k>fBKR0U zTAPX7r;t{OwEcwx^d!MXtROsbB^#x00pR+Y3NFm`MTJW)j;p(KUSZ?6c?JAA z+KhDl(^(STa>Efyvo{6aC)+~Xfx*?))rKq!+77rJMr}WZ7Jc-jh|y!%#B@VLIwb~o zXKdI+AUHsNp5o*4l=lHB2(XY7+X`=b&TMadb^q4uW~%2UBUc$2Cdqsk7N%)}87x`$ zqi1${vy}ma&dx$m;)`gf3gfWARIR$^=|!lbJez>*%c6jrR@V(8w!Gr$?t0znX}9yU z-oC!Xua{n!%|un^9M7zPA71;RwiVJL;U5inCakR-pe1QEDO6kW@$oV4?D$36h8B=! z$%KRiP2D_7M?BGtsM8<(se%sqf$h;MXZN2;MP2j7i)7g1cs}h4r>75vl$Ne+obUNp z7TaKe3}I|yvW0Ay!rTyZ3xgfBi99oY;QB6&*~(Ve)^?$P`LKgtNR+LkV~%)P*xF)5 zL_~zAxUG%#h+WkJlT?{kXO~Bp_ZAXKrTdkYm9abK`Y2poU4c3Plrgk%SKI~yfnov! zmH{x!>qlLBK(=Rt<8jBdnz$W&(6J7Ur3$<5qYNDN zQre5s`R1#w_#I*tg%FjZKgb30#QT59OeVMyJQ@>4{kjZfPy^rr`E=m zT%J~_N>L9QO_u@(iHZ3FJ`nM}ZoKkQL4w2-<&f zu&7HGkzM#<;BB0)=WY5xB&wNoMuc_On_O zlarM-b$sZBpoBUB`CfVB_5kR~#;D73m&huc`^tPCKGQZyz2nuFr6p3()ebk!bVXin zuFq&f*!=;>>;J2 z2o4Q>(yb_NR#o3{E1~!`yvk$56C~yFSWi#rugg0Q4vx*K7B04gpM*O|m%kO=a=-}3 zg}{iY$ezBwO8Nb*SrTh&YoLO$K0q)0dufiLE;nuc==8p1?@Az53&=;auq)qNPe&GB z-r&W+o0QU04pH}Q0&=^2WSPlGBqVX`k^Dy)@vJwu$(Wn-%~9`5rx$=S^TI}mvB?-Q zb3{4-hg(j=k+b!CoL_(o2G2Oy_%W@joz!+K>cUCJBS)3RTq~A z$|(J#5#E5yfLGxUiI35{4I&<=uU(p!Z{Lt##6fAMj}Y@U!em}CfNyM=RlrpJ{6Jjl z{yOcWsrLc>HKPRM72~@zRiqW_S)G{+Ey>r%j2`M1tpXJs8sm-0;fcBlb| z!)>OD#my%sCVrkvO8#A6cRC%&`e$H(mqyWxsc3zC2_~mnNdS6AK;i-t?aa)~SfS=B zn>7an21IDmi4OGwvfSjKk%5MotbD#J&|P5Yl%C4e$kS#!L&nC(E9u+d4zdo`9yyjA zjH~2nr3yg6rlxc(>IyOO@dJ79C`G8AfzND?KJ@nX=33_>ZE0O(ZN}ct=YCYv_mc_k zyso;v^}EG*l7K+DqYCB3|7h#=Hh(_G7dt8nET@?DvHx6Zrgc86=c|{fyI&;n2HYBT z8PV55y*ZvkiFSY;T`VH%r2<~PlE6R+6&vg>7;{WPvdYR&Z!Y#27#Y9qFJQd(n_~NP zey!jyHkbth?tiq{lmQ%p&*^4wNd?$$@l-Vg3vh84 z3jgMy%SPeEfT|xrTToV>ZcvE5%?g3KVq{{jJdC^YJL@HZb8_gn1dxW{AQyeEhZtWI zdq&?NSae53qeRJ-f&8|=Pe(w<`)7%7vDCoz`gAYa*m1BIe?!EVnSzgx@A`~h!y+K; z`*(boCRiVnJjoD!szqt3s@~p7*?7EGz5vI`*`CT|{z#+C70JIoFN!tW2)PgR4!=sb zQgDhN0n`;>)4&_@5a$A=^4hCILWS_%v$cx6HuenMHpgO{PS$B4 z6x$J6DT;pw4Ot)lhd#c2^%}<%$vc+wWEx7arf8~((-dN0skS4L9 z&CU0W%srC@5VH`MUjY(BS3N5$A4y18KL2UFt>DE>uCbBee|u&$T)RJ!|XTz3YaTKD%F8Xc7Hq&6bO-hzg%Zhl~gw2KR`m6cUvW8-1hz&HV|U@6+=!Pou} zg`8#7EFS9m~0mz@^;kk6%)HvuDBwuC8nWFr^mq65RQUALhx(j^u zuB*u@cs!;BY=+s0yE?P^MHF|u6=z@T#9{f;DQWGSspA`F7qMy F{{Tyt0Y3l$ literal 0 HcmV?d00001