Skip to content

Commit dbc51f1

Browse files
release: v3.1.0 (#417)
* release: update package versions to 3.1.0 * release: promote next docs to latest --------- Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
1 parent a7bb363 commit dbc51f1

File tree

6 files changed

+111
-45
lines changed

6 files changed

+111
-45
lines changed

README.md

Lines changed: 20 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -21,12 +21,16 @@ You can combine the following conditions to build simple labeling rules.
2121

2222
- Title (`title`)
2323
- Body (`body`)
24+
- Event actor (`actor`)
2425
- Author (`author`)
2526
- Base branch (`base-branch`)
2627
- Head branch (`head-branch`)
2728
- Draft state (`draft`)
2829
- Changed lines (`changed-lines`)
2930
- Changed files (`changed-files`)
31+
- Commit message (full) (`commit-messages`)
32+
- Commit message subject (`commit-message-subjects`)
33+
- Commit message body (`commit-message-bodies`)
3034

3135
It supports the `issues`, `pull_request`, and `pull_request_target` events, and uses `.github/labeler-config.yml` by
3236
default.
@@ -170,17 +174,22 @@ rules:
170174
> For supported properties, allowed value types, how to use `negate`, and more examples, see
171175
> [Configuration Guide - 5. conditions](/docs/latest/configuration-guide.md#5-conditions).
172176

173-
| Property | Issue | PR | Allowed value types (in precedence order) |
174-
| --------------- | ----- | --- | ----------------------------------------- |
175-
| `title` | O | O | `regex` |
176-
| `body` | O | O | `regex` |
177-
| `author` | O | O | `regex`, `string` |
178-
| `base-branch` | X | O | `regex`, `string` |
179-
| `head-branch` | X | O | `regex`, `string` |
180-
| `draft` | X | O | `boolean` |
181-
| `changed-lines` | X | O | `numeric-comparison` |
182-
| `changed-files` | X | O | `glob-pattern`, `string` |
183-
177+
| Property | Issue | PR | Allowed value types (in precedence order) |
178+
| ------------------------- | ----- | --- | ----------------------------------------- |
179+
| `title` | O | O | `regex` |
180+
| `body` | O | O | `regex` |
181+
| `actor` | O | O | `regex`, `string` |
182+
| `author` | O | O | `regex`, `string` |
183+
| `base-branch` | X | O | `regex`, `string` |
184+
| `head-branch` | X | O | `regex`, `string` |
185+
| `draft` | X | O | `boolean` |
186+
| `changed-lines` | X | O | `numeric-comparison` |
187+
| `changed-files` | X | O | `glob-pattern`, `string` |
188+
| `commit-messages` | X | O | `regex` |
189+
| `commit-message-subjects` | X | O | `regex` |
190+
| `commit-message-bodies` | X | O | `regex` |
191+
192+
- `author` is the issue/PR author, while `actor` is the subject that triggered the event.
184193
- `changed-lines` compares the PR's **total changed lines (additions + deletions)**.
185194
- `regex`: write it in the `/pattern/flags` format.
186195
- `glob-pattern`: write it as a **glob pattern string** such as `src/**/*.ts` or `**/*.md`.

docs/latest/README.ko.md

Lines changed: 20 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -21,12 +21,16 @@
2121

2222
- 제목(`title`)
2323
- 본문(`body`)
24+
- 이벤트 실행자(`actor`)
2425
- 작성자(`author`)
2526
- 대상 브랜치(`base-branch`)
2627
- 소스 브랜치(`head-branch`)
2728
- 드래프트 상태(`draft`)
2829
- 변경 라인 수(`changed-lines`)
2930
- 변경 파일(`changed-files`)
31+
- 커밋 메시지 전체(`commit-messages`)
32+
- 커밋 메시지 제목(`commit-message-subjects`)
33+
- 커밋 메시지 본문(`commit-message-bodies`)
3034

3135
`issues`, `pull_request`, `pull_request_target` 이벤트를 지원하며, 설정 파일은 기본적으로 `.github/labeler-config.yml`
3236
사용합니다.
@@ -169,17 +173,22 @@ rules:
169173
> 지원 속성, 허용 값 타입, `negate` 사용법, 추가 예시는
170174
> [Configuration Guide - 5. conditions](/docs/latest/configuration-guide.ko.md#5-conditions)를 참고하세요.
171175

172-
| 속성 | 이슈 | PR | 허용 값 타입(우선순위) |
173-
| --------------- | ---- | --- | ------------------------ |
174-
| `title` | O | O | `regex` |
175-
| `body` | O | O | `regex` |
176-
| `author` | O | O | `regex`, `string` |
177-
| `base-branch` | X | O | `regex`, `string` |
178-
| `head-branch` | X | O | `regex`, `string` |
179-
| `draft` | X | O | `boolean` |
180-
| `changed-lines` | X | O | `numeric-comparison` |
181-
| `changed-files` | X | O | `glob-pattern`, `string` |
182-
176+
| 속성 | 이슈 | PR | 허용 값 타입(우선순위) |
177+
| ------------------------- | ---- | --- | ------------------------ |
178+
| `title` | O | O | `regex` |
179+
| `body` | O | O | `regex` |
180+
| `actor` | O | O | `regex`, `string` |
181+
| `author` | O | O | `regex`, `string` |
182+
| `base-branch` | X | O | `regex`, `string` |
183+
| `head-branch` | X | O | `regex`, `string` |
184+
| `draft` | X | O | `boolean` |
185+
| `changed-lines` | X | O | `numeric-comparison` |
186+
| `changed-files` | X | O | `glob-pattern`, `string` |
187+
| `commit-messages` | X | O | `regex` |
188+
| `commit-message-subjects` | X | O | `regex` |
189+
| `commit-message-bodies` | X | O | `regex` |
190+
191+
- `author`는 이슈/PR의 작성자이고, `actor`는 해당 이벤트를 발생시킨 주체입니다.
183192
- `changed-lines` 비교 대상은 PR의 **총 변경 줄 수(추가 + 삭제)** 입니다.
184193
- `regex`: `/pattern/flags` 형식으로 작성합니다.
185194
- `glob-pattern`: `src/**/*.ts`, `**/*.md` 같은 **glob 패턴 문자열**로 작성합니다.

docs/latest/configuration-guide.ko.md

Lines changed: 34 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -266,16 +266,20 @@ conditions:
266266

267267
### 5.1 이벤트별 지원 속성
268268

269-
| 속성 | 이슈 | PR | 허용 값 타입(우선순위) |
270-
| --------------- | ---- | --- | ------------------------ |
271-
| `title` | O | O | `regex` |
272-
| `body` | O | O | `regex` |
273-
| `author` | O | O | `regex`, `string` |
274-
| `base-branch` | X | O | `regex`, `string` |
275-
| `head-branch` | X | O | `regex`, `string` |
276-
| `draft` | X | O | `boolean` |
277-
| `changed-lines` | X | O | `numeric-comparison` |
278-
| `changed-files` | X | O | `glob-pattern`, `string` |
269+
| 속성 | 이슈 | PR | 허용 값 타입(우선순위) |
270+
| ------------------------- | ---- | --- | ------------------------ |
271+
| `title` | O | O | `regex` |
272+
| `body` | O | O | `regex` |
273+
| `actor` | O | O | `regex`, `string` |
274+
| `author` | O | O | `regex`, `string` |
275+
| `base-branch` | X | O | `regex`, `string` |
276+
| `head-branch` | X | O | `regex`, `string` |
277+
| `draft` | X | O | `boolean` |
278+
| `changed-lines` | X | O | `numeric-comparison` |
279+
| `changed-files` | X | O | `glob-pattern`, `string` |
280+
| `commit-messages` | X | O | `regex` |
281+
| `commit-message-subjects` | X | O | `regex` |
282+
| `commit-message-bodies` | X | O | `regex` |
279283

280284
### 5.2 속성
281285

@@ -288,6 +292,10 @@ conditions:
288292
- 이슈/PR 본문(`issue.body`, `pullRequest.body`)을 대상으로 검사합니다.
289293
- 본문이 비어 있으면, 본문 값은 빈 문자열(`''`)로 처리한 뒤 평가합니다.
290294

295+
#### actor
296+
297+
- 현재 이벤트를 발생시킨 주체(`actor`)를 대상으로 검사합니다.
298+
291299
#### author
292300

293301
- 이슈/PR 작성자 로그인 이름(`issue.author.login`, `pullRequest.author.login`)을 대상으로 검사합니다.
@@ -314,6 +322,22 @@ conditions:
314322
- PR 변경 파일 경로 목록을 기준으로 검사합니다.
315323
- 각 파일 경로를 하나씩 검사하며, 하나라도 일치하면 조건은 참이 됩니다.
316324

325+
#### commit-messages
326+
327+
- PR에 포함된 각 커밋의 전체 메시지를 기준으로 검사합니다.
328+
- 각 커밋 메시지를 하나씩 검사하며, 하나라도 정규식에 일치하면 조건은 참이 됩니다.
329+
330+
#### commit-message-subjects
331+
332+
- PR에 포함된 각 커밋 메시지의 제목을 기준으로 검사합니다.
333+
- 각 커밋 제목을 하나씩 검사하며, 하나라도 정규식에 일치하면 조건은 참이 됩니다.
334+
335+
#### commit-message-bodies
336+
337+
- PR에 포함된 각 커밋 메시지의 본문을 기준으로 검사합니다.
338+
- 각 커밋 본문을 하나씩 검사하며, 하나라도 정규식에 일치하면 조건은 참이 됩니다.
339+
- 본문이 비어 있으면, 본문 값은 빈 문자열(`''`)로 처리한 뒤 평가합니다.
340+
317341
### 5.3 값 타입
318342

319343
#### regex

docs/latest/configuration-guide.md

Lines changed: 34 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -275,16 +275,20 @@ conditions:
275275

276276
### 5.1 Supported Properties by Event
277277

278-
| Property | Issue | PR | Allowed value types (in precedence order) |
279-
| --------------- | ----- | --- | ----------------------------------------- |
280-
| `title` | O | O | `regex` |
281-
| `body` | O | O | `regex` |
282-
| `author` | O | O | `regex`, `string` |
283-
| `base-branch` | X | O | `regex`, `string` |
284-
| `head-branch` | X | O | `regex`, `string` |
285-
| `draft` | X | O | `boolean` |
286-
| `changed-lines` | X | O | `numeric-comparison` |
287-
| `changed-files` | X | O | `glob-pattern`, `string` |
278+
| Property | Issue | PR | Allowed value types (in precedence order) |
279+
| ------------------------- | ----- | --- | ----------------------------------------- |
280+
| `title` | O | O | `regex` |
281+
| `body` | O | O | `regex` |
282+
| `actor` | O | O | `regex`, `string` |
283+
| `author` | O | O | `regex`, `string` |
284+
| `base-branch` | X | O | `regex`, `string` |
285+
| `head-branch` | X | O | `regex`, `string` |
286+
| `draft` | X | O | `boolean` |
287+
| `changed-lines` | X | O | `numeric-comparison` |
288+
| `changed-files` | X | O | `glob-pattern`, `string` |
289+
| `commit-messages` | X | O | `regex` |
290+
| `commit-message-subjects` | X | O | `regex` |
291+
| `commit-message-bodies` | X | O | `regex` |
288292

289293
### 5.2 Properties
290294

@@ -297,6 +301,10 @@ conditions:
297301
- Checks the issue/PR body (`issue.body`, `pullRequest.body`).
298302
- If the body is empty, it is evaluated after treating the body value as an empty string (`''`).
299303

304+
#### actor
305+
306+
- Checks the subject that triggered the current event (`actor`).
307+
300308
#### author
301309

302310
- Checks the issue/PR author's login (`issue.author.login`, `pullRequest.author.login`).
@@ -323,6 +331,22 @@ conditions:
323331
- Checks against the list of changed file paths in the PR.
324332
- Each file path is checked one by one, and the condition becomes true if any one of them matches.
325333

334+
#### commit-messages
335+
336+
- Checks against the full message of each commit included in the PR.
337+
- Each commit message is checked one by one, and the condition becomes true if any one of them matches the regex.
338+
339+
#### commit-message-subjects
340+
341+
- Checks against the subject of each commit message included in the PR.
342+
- Each commit subject is checked one by one, and the condition becomes true if any one of them matches the regex.
343+
344+
#### commit-message-bodies
345+
346+
- Checks against the body of each commit message included in the PR.
347+
- Each commit body is checked one by one, and the condition becomes true if any one of them matches the regex.
348+
- If the body is empty, it is evaluated after treating the body value as an empty string (`''`).
349+
326350
### 5.3 Value Types
327351

328352
#### regex

package-lock.json

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "issue-pr-labeler",
33
"description": "GitHub Action that automatically labels issues and pull requests based on user-defined rules.",
4-
"version": "3.0.0",
4+
"version": "3.1.0",
55
"author": {
66
"name": "hoho4190",
77
"url": "https://github.com/hoho4190"

0 commit comments

Comments
 (0)