rialto/.github/workflows/commit_message_format.yml at master · rdkcentral/rialto · 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
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
#
# If not stated otherwise in this file or this component's LICENSE file the
# following copyright and licenses apply:
#
# Copyright 2024 Sky UK
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#

name: commit-message-format

# Controls when the workflow will run
on:
  # Triggers the workflow on pull request to master and release/* branches
  pull_request:
    branches: ["master", "release/*"]

# A workflow run is made up of one or more jobs that can run sequentially or in parallel
jobs:
  # This job checks the commit message of the merge
  check-commit-message:
    name: Check Commit Message

    # Runs on ubuntu
    runs-on: ubuntu-latest

    # Steps represent a sequence of tasks that will be executed as part of the job
    steps:
      - name: Post commit message comment on PR
        uses: mshick/add-pr-comment@v2
        with:
          message: |
            Pull request title must follow the pattern:
            < JIRA TICKET >: < one line summary of change less than 65 characters >

            Pull request description must follow the Commit message format for RDK-E:
            https://etwiki.sys.comcast.net/spaces/RDKAR/pages/1407997180/Commit+Message+Format+For+RDKE

            1. Associated JIRA ticket in format : < JIRA TICKET >: < one line summary of change less than 65 characters >
            2. Detailed reason for change information
            3. Test procedure. Only references links to Jira ticket or sub tickets where test steps and references are captured.

            < JIRA TICKET >: < one line summary of change less than 65 characters >
            < empty line >
            Reason for change: <explanation of change>
            Test Procedure: < https://ccp.sys.comcast.net/browse/JIRA TICKET/url/to/test_step_section>

      # Check PR title
      - name: Match PR title
        uses: actions-ecosystem/action-regex-match@v2
        id: pr-title-match
        if: failure() || success()
        with:
          text: ${{ github.event.pull_request.title }}
          regex: '^[A-Z][A-Z0-9]+-\d+: .{1,64}$'

      # Check PR body
      - name: Match PR Body
        uses: actions-ecosystem/action-regex-match@v2
        id: pr-body-match
        if: failure() || success()
        with:
          text: ${{ github.event.pull_request.body }}
          regex: '^([A-Z][A-Z0-9]+-\d+): (.{1,64})\r?\n\r?\nReason for change:([\s\S]*?)(?:\r?\nTest Procedure:([\s\S]*))?$'

      - name: Check Commit message
        if: (failure() || success()) && (steps.pr-body-match.outputs.match == '')
        run: exit 1

      # Print description.
      - name: Log string on failure
        if: failure()
        run: echo ${{ github.event.pull_request.body }}