Skip to content

Commit b384dfa

Browse files
authored
Add pr-labels feature docs
1 parent 11090ca commit b384dfa

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,14 @@
22
Common workflows required for some or all replicatedhq repos
33

44
## Workflows
5-
* **pr-labels.yml**: Fails if a PR does not have the necessary labels for Engineering metrics
5+
* **pr-labels.yml**: Fails if a PR does not have the necessary labels for Engineering metrics, will apply primary labels if the PR title or `HEAD` commit message contains a semantic commit, for example:
6+
* `feat(ci)`, `feature(ci)`: Adds `type::feature`
7+
* `bug(ci)`: Adds `type::bug`
8+
* `chore(ci)`: Adds `type::chore`
69

710
## Actions
811
Any custom actions related to these workflows reside in `.github/actions`.
912

1013
JavaScript actions must have their `dist` folders rebuilt if changed. Run `npm run all` in the action folder before committing and pushing.
1114

12-
* **pr-labels**: Implements the PR label check logic as outlined in the wiki.
15+
* **pr-labels**: Implements the PR label check logic as outlined in the wiki.

0 commit comments

Comments
 (0)