iobroker-sync/.github/workflows/pr-title.yml at 03d849dbd65d6da2e53d656a360bd1f8baaeca8f · mschmicking/iobroker-sync · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
name: PR title

# The PR title becomes the squashed commit message, and release-please derives the
# next version from it. A title that does not parse means a release that silently
# does not happen, so it is validated before merge rather than discovered after.
on:
  pull_request_target:
    types: [opened, edited, synchronize, reopened]

permissions:
  pull-requests: read

jobs:
  conventional-commit:
    runs-on: ubuntu-latest
    steps:
      - uses: amannn/action-semantic-pull-request@v6
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        with:
          # feat -> minor, fix/perf -> patch, feat! or a BREAKING CHANGE footer -> major.
          # The rest are patch-or-nothing and never drive a release on their own.
          types: |
            feat
            fix
            perf
            refactor
            docs
            test
            build
            ci
            chore
            revert
          # Optional, but keep the vocabulary small so it stays meaningful. A scope is
          # not required, but any scope used must appear here.
          #
          # 'main' is not a component — it is the branch name release-please puts in its
          # own PR title ("chore(main): release 1.0.0"). Without it that title fails this
          # check, and once the check is required by the branch ruleset the release PR
          # becomes unmergeable.
          scopes: |
            sync
            auth
            watch
            logs
            json
            types
            cli
            deps
            docs
            release
            main
          requireScope: false
          # Only the trailing full stop is rejected. A lower-case rule was tried and
          # removed: Dependabot capitalises some of its titles ("Bump x from 1 to 2")
          # and not others, so it failed dependency PRs for a reason unrelated to
          # anything a human chose.
          subjectPattern: ^(?!.*\.$).+$
          subjectPatternError: |
            The subject "{subject}" must not end with a full stop, e.g.
            "feat(logs): stream the server log".