Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
85 commits
Select commit Hold shift + click to select a range
386d25e
docs: update README.md
ytanikin Sep 28, 2024
8a83f86
docs: update README.md
ytanikin Sep 28, 2024
d0e5cdc
docs: update README.md
ytanikin Sep 28, 2024
06a373f
docs: update README.md
ytanikin Sep 28, 2024
33e6b55
docs: update README.md
ytanikin Sep 28, 2024
7374d60
docs: update README.md
ytanikin Sep 28, 2024
cccf7d5
docs: update README.md
ytanikin Sep 28, 2024
6ecd564
docs: update README.md
ytanikin Sep 28, 2024
1b6c11e
docs: update README.md
ytanikin Sep 28, 2024
86968bb
feat: add scope labeling
ytanikin Sep 28, 2024
ec2c2a4
feat: add scope labeling
ytanikin Sep 28, 2024
8e10d64
feat: add scope labeling
ytanikin Sep 28, 2024
368967f
feat: add scope labeling
ytanikin Sep 28, 2024
c597aaa
feat: add scope labeling
ytanikin Sep 28, 2024
6c0a1bc
feat: add scope labeling
ytanikin Sep 28, 2024
5755a02
feat: add scope labeling
ytanikin Sep 28, 2024
f6cf23b
docs: update README.md
ytanikin Oct 21, 2024
7c288b8
docs: update README.md
ytanikin Oct 26, 2024
763f071
feat: add-scope-labeling
ytanikin Oct 26, 2024
ac36124
feat: add-scope-labeling
ytanikin Oct 26, 2024
a80e857
feat: add-scope-labeling
ytanikin Oct 26, 2024
3150950
feat: add-scope-labeling
ytanikin Oct 26, 2024
ef7b0f7
feat: add-scope-labeling
ytanikin Oct 27, 2024
552e772
feat: add-scope-labeling
ytanikin Oct 27, 2024
c0c8553
feat: add-scope-labeling
ytanikin Oct 27, 2024
a9a3709
feat: add-scope-labeling
ytanikin Oct 27, 2024
11c7ca6
feat: add-scope-labeling
ytanikin Oct 27, 2024
5d7e4df
feat: add-scope-labeling
ytanikin Oct 27, 2024
ae7aed2
feat: add-scope-labeling
ytanikin Oct 27, 2024
129c2e8
feat: add-scope-labeling
ytanikin Oct 27, 2024
4daab23
feat: add-scope-labeling
ytanikin Oct 27, 2024
690d99f
feat: add-scope-labeling
ytanikin Oct 27, 2024
99b6152
feat: add-scope-labeling
ytanikin Oct 27, 2024
f5e8ae3
feat: add-scope-labeling
ytanikin Oct 27, 2024
6ec104b
feat: add-scope-labeling
ytanikin Oct 27, 2024
c08c646
feat: add-scope-labeling
ytanikin Oct 27, 2024
2db9c92
feat: add-scope-labeling
ytanikin Oct 27, 2024
34d56ae
feat: add-scope-labeling
ytanikin Oct 27, 2024
c8e8477
feat: add-scope-labeling
ytanikin Oct 27, 2024
3802e62
feat: add-scope-labeling
ytanikin Oct 27, 2024
f7916a6
feat: add-scope-labeling
ytanikin Oct 27, 2024
7e89952
feat: add-scope-labeling
ytanikin Oct 27, 2024
e549938
feat: add-scope-labeling
ytanikin Oct 27, 2024
4ca99f5
feat: add-scope-labeling
ytanikin Oct 27, 2024
bd161d0
feat: add-scope-labeling
ytanikin Oct 27, 2024
bb156d1
feat: add-scope-labeling
ytanikin Oct 27, 2024
63042f0
feat: add-scope-labeling
ytanikin Oct 27, 2024
7aa74b2
feat: add-scope-labeling
ytanikin Oct 27, 2024
1b8df3c
feat: add-scope-labeling
ytanikin Oct 27, 2024
acfcc18
feat: add-scope-labeling
ytanikin Oct 27, 2024
8c0614f
feat: add-scope-labeling
ytanikin Oct 27, 2024
c33a50d
feat: add-scope-labeling
ytanikin Oct 27, 2024
a93e55d
feat: add-scope-labeling
ytanikin Oct 27, 2024
3370026
feat: add-scope-labeling
ytanikin Oct 27, 2024
f5166d8
feat: add-scope-labeling
ytanikin Oct 27, 2024
a83e54c
feat: add-scope-labeling
ytanikin Oct 27, 2024
96aa341
feat: add-scope-labeling
ytanikin Oct 27, 2024
d9b9bc7
feat: add-scope-labeling
ytanikin Oct 27, 2024
96aedb2
feat: add-scope-labeling
ytanikin Oct 27, 2024
94f981d
feat: add-scope-labeling
ytanikin Oct 27, 2024
8cd8e18
feat: add-scope-labeling
ytanikin Oct 27, 2024
f87a746
feat: add-scope-labeling
ytanikin Oct 27, 2024
8f8db74
feat: add-scope-labeling
ytanikin Oct 27, 2024
2a6f789
feat: add-scope-labeling
ytanikin Oct 27, 2024
7e05692
feat: add-scope-labeling
ytanikin Oct 27, 2024
aa28d61
feat: add-scope-labeling
ytanikin Oct 27, 2024
813f4ef
feat: add-scope-labeling
ytanikin Oct 27, 2024
489e2d3
feat: add-scope-labeling
ytanikin Oct 27, 2024
7a9d042
feat: add-scope-labeling
ytanikin Oct 27, 2024
4f0b99d
feat: add-scope-labeling
ytanikin Oct 27, 2024
448ce75
feat: add-scope-labeling
ytanikin Oct 27, 2024
4ff20a8
feat: add-scope-labeling
ytanikin Oct 27, 2024
81752ec
feat: add-scope-labeling
ytanikin Oct 27, 2024
83568b9
feat: add-scope-labeling
ytanikin Oct 27, 2024
3e7a376
feat: add-scope-labeling
ytanikin Oct 27, 2024
5d59e52
feat: add-scope-labeling
ytanikin Oct 27, 2024
82e01ee
feat: add-scope-labeling
ytanikin Oct 27, 2024
b092e79
Merge branch 'refs/heads/main' into add-scope-labeling
ytanikin Oct 27, 2024
da02f2b
Merge branch 'main' into add-scope-labeling
ytanikin Oct 27, 2024
60dd096
feat: add-scope-labeling
ytanikin Oct 27, 2024
a0aa32b
Merge remote-tracking branch 'origin/add-scope-labeling' into add-sco…
ytanikin Oct 27, 2024
05993f2
feat: add-scope-labeling
ytanikin Oct 27, 2024
b313427
feat: add-scope-labeling
ytanikin Oct 27, 2024
0b5cee1
feat: add-scope-labeling
ytanikin Oct 27, 2024
e6be772
feat: add-scope-labeling
ytanikin Oct 27, 2024
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -37,3 +37,4 @@ jobs:
"revert": "revert",
"wip": "WIP"
}'
add_scope_label: 'true' # false by default
11 changes: 7 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,16 @@ Conventional Commits is a lightweight convention on top of commit messages. It p

This GitHub Action checks that the PR title adheres to the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) specification. If the PR title contains a valid task type and optionally a task number, it labels the PR based on the task type.

### Why Conventional Commits?
### Why PR Conventional Commits?

- **Automatic Generation of CHANGELOGs**: With Conventional Commits, CHANGELOGs can be automatically generated, making it easier for users to find what's changed between releases.
- **Explicitly Communicate Nature of Changes**: Conventional commits establish a clear guideline, making it easier for people to contribute to your projects.
- **Simple Navigation through Git History**: Conventional commits make it easy to identify the nature of changes (fix, feat, chore, etc.) when searching through the git commit history.
- **Compatibility with Semantic Versioning (SemVer)**: Conventional Commits provides a structured format for commit messages, which aligns with SemVer and helps understand version changes without reading the code.
- **Labeling PRs**: By labeling PRs based on the task type, it provides a visual indication of the nature of changes and helps in organizing and prioritizing PR reviews.
- Adding a `!` in the PR title will automatically assign the breaking change label to the PR.
- **Labeling PRs**: By labeling PRs based on the task type, it provides a visual indication of the nature of changes and helps in organizing and prioritizing PR reviews.
- **Breaking Change**: Adding a `!` in the PR title will automatically assign the breaking change label to the PR.
- **Filtering by labels**: You can filter out specific labels in GitHub Pull Requests UI


### Inputs

Expand All @@ -36,7 +38,7 @@ By default, this action adds labels based on the task type. For example, a pull
Adding a `!` in the PR title will automatically assign the breaking change label to the PR.

If you prefer not to add labels, you can disable the labeling functionality by setting the `add_label` input to `'false'`. In such cases, the action will still validate the PR title against the Conventional Commits specification but will not add any labels.
![img.png](pull_requests.png)
![img.png](labels.png)

### Configuring Squash Merging

Expand All @@ -51,6 +53,7 @@ Make sure that at least one merge option is enabled (merge commits, squashing, o

When using the squash merge option, all commits from the head branch will be combined into a single commit in the base branch. The default commit message presented when merging a pull request with squash will be the PR title.

![squash_config.png](squash_config.png)
## Examples

### Basic Usage, no label, no ticket numbers validation
Expand Down
8 changes: 8 additions & 0 deletions action.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,14 @@ inputs:
description: 'Whether to add labels'
required: false
default: 'true'
add_scope_label:
description: 'Whether to add scope labels, such login for the title "fix(login): fix message in login page'
required: false
default: 'false'
scope_label_prefix:
description: 'A JSON string mapping task types to custom scope label names'
required: false
default: ''
token:
description: 'GitHub token for applying labels.'
required: false
Expand Down
Loading
Loading