Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

Commitddbf3d9

Browse files
sarayourfriendbacarybrunorschristian
authored
Add comment-key input (#82)
* Add comment-key input* Fix typoCo-authored-by: Bruno Bodian <bacarybruno@gmail.com>* Prevent mixing up comments with and without keys* Add docs to readme for the comment-key option* Apply suggestions from code review---------Co-authored-by: Bruno Bodian <bacarybruno@gmail.com>Co-authored-by: Ryan Christian <33403762+rschristian@users.noreply.github.com>
1 parent68c0fd1 commitddbf3d9

File tree

3 files changed

+37
-2
lines changed

3 files changed

+37
-2
lines changed

‎README.md‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -179,3 +179,32 @@ By default, files are compared after gzip compression, but it's possible to use
179179
```yaml
180180
compression: "none"
181181
```
182+
183+
### Checking multiple bundles
184+
185+
The action reuses the same comment each time it runs on a PR. In order to run the action multiple times against separate bundles for a single PR, you must provide a `comment-key` option, which the action will use to determine which comment to add or update for the run. The example below demonstrates this for separate "modern" and "legacy" bundles:
186+
187+
```diff
188+
name: Compressed Size
189+
on: [pull_request]
190+
jobs:
191+
modern-bundle-size-check:
192+
runs-on: ubuntu-latest
193+
steps:
194+
- uses: actions/checkout@v2
195+
- uses: preactjs/compressed-size-action@v2
196+
with:
197+
build-script: "build:modern"
198+
+ comment-key: modern
199+
200+
legacy-bundle-size-check:
201+
runs-on: ubuntu-latest
202+
steps:
203+
- uses: actions/checkout@v2
204+
- uses: preactjs/compressed-size-action@v2
205+
with:
206+
build-script: "build:legacy"
207+
+ comment-key: legacy
208+
```
209+
210+
If you do not provide this key, the action will attempt to use (and therefore replace) the same comment for both bundles, hiding the output for whichever run finished last.

‎action.yml‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,9 @@ inputs:
4242
default:'{**/*.map,**/node_modules/**}'
4343
cwd:
4444
description:'A custom working directory to execute the action in relative to repo root (defaults to .)'
45+
comment-key:
46+
description:'Optional key to include in the bot comment to allow for multiple bundle calculations to be posted in separate comments.'
47+
4548
runs:
4649
using:'node20'
4750
main:'index.js'

‎src/index.js‎

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -185,11 +185,13 @@ async function run(octokit, context, token) {
185185
issue_number:pull_number
186186
};
187187

188+
constcommentKey=getInput('comment-key')
189+
188190
constcomment={
189191
...commentInfo,
190192
body:
191193
markdownDiff+
192-
'\n\n<a href="https://github.com/preactjs/compressed-size-action"><sub>compressed-size-action</sub></a>'
194+
`\n\n<a href="https://github.com/preactjs/compressed-size-action"><sub>compressed-size-action${commentKey ?`::${commentKey}` :''}</sub></a>`
193195
};
194196

195197
if(context.eventName!=='pull_request'&&context.eventName!=='pull_request_target'){
@@ -213,9 +215,10 @@ async function run(octokit, context, token) {
213215
letcommentId;
214216
try{
215217
constcomments=(awaitoctokit.issues.listComments(commentInfo)).data;
218+
constcommentRegExp=newRegExp(`<sub>[\s\n]*(compressed|gzip)-size-action${commentKey ?`::${commentKey}` :''}</sub>`)
216219
for(leti=comments.length;i--;){
217220
constc=comments[i];
218-
if(/<sub>[\s\n]*(compressed|gzip)-size-action/.test(c.body)){
221+
if(commentRegExp.test(c.body)){
219222
commentId=c.id;
220223
break;
221224
}

0 commit comments

Comments
 (0)
[8]ページ先頭
©2009-2025 Movatter.jp