Skip to content

Commit

Permalink
chore: update configuration for semantic-prs app
Browse files Browse the repository at this point in the history
Switch to validating individual commits as opposed to PR titles.
  • Loading branch information
kmontag committed Jul 2, 2024
1 parent 82b7e66 commit ff2ad03
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 19 deletions.
16 changes: 4 additions & 12 deletions .github/semantic.yml
Original file line number Diff line number Diff line change
@@ -1,13 +1,5 @@
# Config file for https://github.com/Ezard/semantic-prs.
# Config file for semantic-prs (https://github.com/Ezard/semantic-prs).
---
# PRs will generally be squashed and merged, so we only care about the
# title for purposes of semantic versioning. This also prevents false
# positives when some commits use semantic messages, but the PR title
# does not.
#
# Note this means the check will be irrelevant for PRs which are
# intended to be merged rather than squashed. Merged PRs are useful,
# for example, if we want to merge several semantic changes all at
# once (i.e. without multiple releases); to accomplish this, we would
# use semantic messages on individual commits.
titleOnly: true
# PRs will be rebased before being merged. Individual commits need to
# follow the semantic PR spec.
commitsOnly: true
11 changes: 4 additions & 7 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,20 +9,17 @@ The project uses
meaning that a new release will be published whenever functional
changes are pushed to the `master` branch.

To support this, PR titles must follow the [Conventional Commits
Spec](https://www.conventionalcommits.org/en/v1.0.0/), e.g. `fix: some fix` (for a patch version release) or `feat: some feature` (for a
Commits must follow the [Conventional Commits
Spec](https://www.conventionalcommits.org/en/v1.0.0/), e.g. `fix: some
fix` (for a patch version release) or `feat: some feature` (for a
minor version release).

(Note that PRs will generally be squashed rather than merged directly,
so it's the PR title, rather than individual commit messages, which
must follow this spec.)

### CI Validations

PRs need to pass the following checks before they can be merged:

```sh
npm run check # Validates typings.
npm run check # Validates types.
npm run lint # Validates code style.
npm run test # Validates functionality.
```
Expand Down

0 comments on commit ff2ad03

Please sign in to comment.