From beec413137278c9434c3c35b8194b10af74d9a62 Mon Sep 17 00:00:00 2001
From: Takeru O'oyama
+
+
+
+
OpenAI Generate PR Title and Description
+
+ This workflow uses an article generation model by OpenAI to generate the title and body of a pull request. ## Usage ```yaml -name: OpenAI PR Description Generator +name: OpenAI Generate PR Title and Description on: pull_request: @@ -25,7 +31,7 @@ jobs: if: contains(github.event.pull_request.user.login, 'renovate') == false steps: - uses: actions/checkout@v4 - - uses: tqer39/generate-pr-description-action@v0.0.21-alpha + - uses: tqer39/generate-pr-description-action@v1.0.0 with: github-token: ${{ secrets.GITHUB_TOKEN }} open-api-key: ${{ secrets.OPENAI_API_KEY }} @@ -40,3 +46,11 @@ jobs: ### `open-api-key` **Required** OpenAI API key. Specify `${{ secrets.OPENAI_API_KEY }}`. + +## Contribution + +If you find any issues or have improvements, please create an Issue or submit a Pull Request. + +## License + +This action is released under the MIT license. For more information, see [LICENSE](LICENSE). diff --git a/action.yml b/action.yml index ee11444..c6e870a 100644 --- a/action.yml +++ b/action.yml @@ -3,8 +3,8 @@ name: 'Generate Pull Request Title and Description' description: 'Generate Pull Request Title and Description' author: Takeru O'oyama @tqer39 branding: - color: 'blue' - icon: 'terminal' + color: 'green' + icon: 'code' inputs: commit-log-history-limit: diff --git a/docs/README.ja.md b/docs/README.ja.md index 6e11271..a61b48b 100644 --- a/docs/README.ja.md +++ b/docs/README.ja.md @@ -1,11 +1,18 @@ -# Generate Pull Request Title and Description +
+
+
+
+
+ このワークフローでは OpenAI による文章生成モデルを使って、プルリクエストのタイトルと本文を生成します。 +
## 使い方 ```yaml -name: OpenAI PR Description Generator +name: OpenAI Generate PR Title and Description on: pull_request: @@ -24,7 +31,7 @@ jobs: if: contains(github.event.pull_request.user.login, 'renovate') == false steps: - uses: actions/checkout@v4 - - uses: tqer39/generate-pr-description-action@v0.0.21-alpha + - uses: tqer39/generate-pr-description-action@v1.0.0 with: github-token: ${{ secrets.GITHUB_TOKEN }} open-api-key: ${{ secrets.OPENAI_API_KEY }} @@ -39,3 +46,11 @@ jobs: ### `open-api-key` **必須** OpenAI API キー。`${{ secrets.OPENAI_API_KEY }}` を指定します。 + +## 貢献方法 + +問題や課題が発見されたら Issue を作成するか Pull Request を作成していただけると幸いです。 + +## ライセンス + +このアクションは MIT ライセンスのもとで公開されています。詳細については [LICENSE](LICENSE) を参照してください。 diff --git a/docs/header.jpg b/docs/header.jpg new file mode 100644 index 0000000000000000000000000000000000000000..fcc2df8a56c1e45434514bc87c95f76147d77768 GIT binary patch literal 953219 zcmbrlbx>SE`z|=Rgg_u6xCIMtK?a8ew~!#g9fC8sYaqd42yVeGgTvqw+yjFT8W?OC z-1YMPzPr0s``6aqK6R?A>vVUWr{%3zp7(M7aSiZ7SzbvVfQAMDpglc+M>yd9Q|te% z{AZH?vl*U7KXw6#aWMfn01UJ@0CZwB3}Up$UI5+Ge`5W2ZovO8Xy_Q2SlBqYc=*qr zIyAfhprc`6pkrcSVPRrE^$vLY4!|VFB4OZ@!G5V}hVusWia#VV50_E4rknKBt5DUV5Hi(LK0fzrW9B|k)Lv~@Jo)4HSu#Gnyr4ezWu5V
z6%V#VQN=I!z5B6%W_|sWCPYWrXd@e*{v{kEj~s^)E^r^v15HA;E-YLgc9snGX7Rlx
zNXq_EuGrLMXv3~fqRr~!m@Xl_c~+{BOZUvjzlNKS4$d7(eS&t{4P?a--#j1MLUeuF
ztN}nxMM*d7(7L2uR4kswf%@%-I~f^YJ&zeKtX`Kf)g^a6578iBqti^?x$%OQ?^qw?
zKpXC|FB+1NPOY6uj8G-VO=cdRF!A3j`g_8lbPR%ZDQ|dVSm>ADsP*Y4eDWQ7`}AlH
zpHl2_8QYbA<~6-v*zZo2Q4HZ}HX~lT4+K@{h0>;3sv**7EL by50}7jFv;D?+sd7-#rrqM*8NK)GTF*P$O%{iUbha&g0)Q9UQe63ZGi
zBh*Em>|@9LtIZmGCqjNiT7rThiEnx!%$-q-tR>7eh4ohc%nT2+n$~BCoEns?8TE~A
zU0p_sk5e%wF($hwds~Y0J?{&mK~dNbdZKhP`rI_s2JJk#R4UZ2$d(IY4VfL+Xq?6I
zslS-?S=nV>INRMz`+KSU?|o1yH9>x5o_`^bT-WAS<~cca+Qr=fh6_>)k=|Qb<>B|L
z8C%#7zThInE+Y3buV<)5LvBfH+i9y#1YYx3V5E+(p9){2f_lR)Bu5?Fg%_laj)>T=
zkLj>b47B_-fc+L8N*dI9mD9#1*s{9}4QM&^2uM0O+xwTTvNBn_pWA2C@VgOpEhZy4
z3gLKTxJOJ}fA}!jMk2%*C*J>|_nT|m3w5_s2kB8_rk2y!x}DR@x*))w?q*|m8$fL{
zPnlPbNV;37a%-{3GJY%#*tOWtt&Z2VgiApqFFhc#>4j#@=-iY}y3Pc6ap2D07xCT{
zBLRaA_|`~ag%ks{sbmr$W?~fpM_QenP+hcMO4`{`ezO`Hy!DvQR9C{p5CC2aHN(mK
z6@l;!dD~UYRg)B{ckvgu-w5vzU8nz88Eb|pFyfR5GBd&GjWb Ogph0+{(L1UC+!1vhc-?Ndn`ENAqT0iT^C$Y^ mJ?(#&D|ZiCApKjF?3i{=Akw XZo-FF2xSj|qxI;=+u1+Ubi^GOuBPbsHY6Yn61e98yM-skIGmky>aK3XEf2<;OYWZBv1m^++2eWX
zN`AOXdcpel1Gtmh`E!_r*iGE^rGEPzucY&V0c*%M)&PC(x>USIsbH*MY1&I~1}%cD
zICX&>G;y@ByY{>I-VTArnwRNL1|eNT+gYaP`%3g1^lp2iN8Uj5y?*gjoz9$A+uBuw
z)seE1sQv)`=flbu3mlR+&VCmPW)SaSB3_Cw)%{8y$bJ{Talhk36R|5~|H&8lkQ>Xd
zl*xWNP-4h3^edJRz~O;$+>0<6|3vCXC#{3~dCJt(I!ki2`6pRZOhYS0@m#ef3yFS7
zxnr`ZJDY!H#f_Rwe-+V8vKp0utY5V^8ig&UL+x8hc}mr@@yUJ6LC=jQ)i{`Der7f#
zskOR7E#W)1AtUA1?(7zzs|=tz`cL32$4fG9KaP{BV#pZl!Vs6cmnaXNzr(DPb#pb0
z2cerDoH#knO(tSZrNqE54F~~ylWzISH~(7>JQ3qisaSYVwDN|}br}Q}+F&C7yA6FG
zSI`rLd8hY}BRs_qPm>8ypBLz(v_t$Y#C%?Ni>__8$+cDe5c)uShgpAgo}t2AmHw9a
z+F?gVox1V80KkCV1#jIq42C>XkEMLI9aALFUxp=R!y&0s6yP|?3^Q`qkwkCscj6#F
zx;B2}6yy9b^Lm;oIeWGY*{Xh9Sm_@Wv`+L=rX(|x$BHTJq#sce0#>1T5hw81<6j$2
zuP!AbdgRsRrJWB3|FA#^G}w}2lfWiVq^o;iZz4vVvePQ_Z9&9le@}J?GPmqb<9%+l
zKj>%}`MDV^LXX2R&-=cAKS5-GbrmDmEgRWZ454$}KPoFeyLfkKUjbzvsTvvDNdg|7
zUqwU+y|Xj7pN(ydsZ7$Tv!C!lZdVO~OzdCMl$9>0GHdIOC2=*~;Q4fI5>V$PpDX;K
zAu@al&7>S4=)p$t5DS*A%^#agq+0aoF5OpMMs0Q7tC;6#6179tb)qfJUgm4Ty*a%2
zxgWo5TCkGd;2j-y31!gy^p0Rk)OOY5mq()}
s1#DIjCZw?j-%oD+5hnxYuj
zB{>fV>lE?=zR}}8ro^8Sg6VY?|5nNW7g1*&6;<2z?V(cy2?uEzq!9*zp-YC6l
5@PT{K#jRQ=XPEc?1t|Pw#){@TFMDKE~T9FC@P{(Uv
zUGfXmMs3L2STwC-SCUfOTW*2FUc`Z)x^f5b4alg-_&n-MZhqVbmmRhHBFlgc2a}wB
z>SC^m`%VxButT4XD!Wi1PRz1RQk;`((!J*=D&2I%YCWhyuP2TZguvhu;TG}ogUQ>F
z(BHdh+^Yv_B4-WhEopK-Aw`gsMyYfT#%x{b@&7j0)69wf6m)5LH
zjry@Q&}GxpBtp;=&${VDD96U+o1)}5G5I|(JwVXIwSb92YdS0!XwL@K)o1y
^Ps7EJqdbjA-<6GzHmPrhts|;1