com.unity.netcode.gameobjects/.github/workflows/pr-description-validation.yml at develop-2.0.0 · theandylee/com.unity.netcode.gameobjects · 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
84
85
86
# This workflow is designed to verify that the pull request description contains a required sections that are important from quality perspective.
# ## Backport section is important as a reminder to account for backports for anyone that works with NGO repository (to 1.X or 2.X branches respectively).
# ## Testing & QA section is important to ensure that the PR has appropriate testing coverage and is important when QA will evaluate PRs before Playtesting for the release.
# ## Documentation section is important to ensure that the documentation is updated with the changes made in the PR.

# If any of the sections is missing, the workflow will fail and block the PR from merging, prompting the developer to add those sections to the PR description.
# The workflow is configured to run when PR is created as well as when it is edited which also counts simple description edits.

name: "NGO - PR description validation"

on:
  pull_request:
    types: [opened, edited, synchronize, reopened]
    branches:
      - develop
      - develop-2.0.0
      - develop-3.x.x
      - release/*

jobs:
  pr-description-validation:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code
        uses: actions/checkout@v7

      - name: Check PR description
        uses: actions/github-script@v9
        with:
          script: |
            const pr = context.payload.pull_request;
            const body = pr.body || '';

            // List of user patterns to skip description validation
            // This should be automations where we don't care that much about the description format
            const skipUserPatterns = [
              /^unity-renovate/,
              /svc/
            ];

            // If PR author matches the skip list, exit early
            const author = pr.user.login;
            console.log(`PR author: ${author}`);
            if (skipUserPatterns.some(pattern => pattern.test(author))) {
              console.log(`Skipping PR description check for user: ${author}`);
              return;
            }

            // List of mandatory PR sections
            const requiredSections = [
              {
                header: '## Backports',
                description: 'PR description must include a "## Backports" section. Please add this section and provide information about this PR backport to develop or develop-2.0.0 branch respectively or explain why backport is not needed.'
              },
              {
                header: '## Up-port',
                description: 'PR description must include a "## Up-port" section. Please add this section and provide information about this PR up-port to develop-3.0.0 branch or explain why up-port is not needed.'
              },
              {
                header: '## Testing & QA',
                description: 'PR description must include a "## Testing & QA" section. Please add this section and provide information about the testing performed for this PR. It can range from adding unit tests to full samples and is needed from QA side to analyze PRs while Playtesting for the release.'
              },
              {
                header: '## Documentation',
                description: 'PR description must include a "## Documentation" section. Please add this section and provide information about the documentation changes made in this PR. It is important to keep the documentation up to date with the code changes.'
              },
              {
                header: '## Jira ticket',
                description: 'PR description must include a "## Jira ticket" section. Please add this section and provide a link to the Jira ticket that corresponds to this PR. General rule should be that if the PR takes you more then a day of work it should have Jira ticket. Otherwise you can always write "N/A" in this section.'
              }
            ];

            const missing = requiredSections.filter(section => !body.includes(section.header));

            if (missing.length > 0) {
              let message = 'PR description is missing the following required section(s):\n';

              const missingDescriptions = missing.map(
                s => `- ${s.header}: ${s.description}`
              );

              message += missingDescriptions.join('\n');
              message += '\n\nPlease add them to your PR description.';

              core.setFailed(message);
            }