You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
@@ -40,4 +40,4 @@ If applicable, add screenshots to help explain your problem.
40
40
41
41
### Additional Context
42
42
43
-
Add any other context about the problem here. Logs, code snippets would be useful here but please also consider attaching a minimal Unity project that reproduces the issue.
43
+
Add any other context about the problem here. Logs, code snippets would be useful here but please also consider attaching a minimal Unity project that reproduces the issue.
Copy file name to clipboardExpand all lines: .github/pull_request_template.md
+9-6Lines changed: 9 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,14 +4,14 @@ Replace this block with what this PR does and why. Describe what you'd like revi
4
4
)
5
5
6
6
### Jira ticket
7
-
_Link to related jira ticket ([Use the smart commits](https://support.atlassian.com/bitbucket-cloud/docs/use-smart-commits/))_
7
+
_Link to related jira ticket ([Use the smart commits](https://support.atlassian.com/bitbucket-cloud/docs/use-smart-commits/)). Short version (e.g. MTT-123) also works and gets auto-linked_
8
8
9
9
### Changelog
10
10
[//]: #(updated with all public facing changes - API changes, UI/UX changes, behaviour changes, bug fixes. Remove if not relevant.)
11
11
12
12
- Added: The package whose Changelog should be added to should be in the header. Delete the changelog section entirely if it's not needed.
13
13
- Fixed: If you update multiple packages, create a new section with a new header for the other package.
14
-
- Removed/Deprecated/Changed: Each bullet should be prefixed with Added, Fixed, Removed, Deprecated, or Changed to indicate where the entry should go
14
+
- Removed/Deprecated/Changed: Each bullet should be prefixed with Added, Fixed, Removed, Deprecated, or Changed to indicate where the entry should go.
15
15
16
16
<!-- Uncomment and mark items off with a * if this PR deprecates any API:
17
17
### Deprecated API
@@ -31,12 +31,14 @@ We should always evaluate if the changes in this PR require any documentation ch
31
31
- Includes documentation for previously-undocumented public API entry points.
32
32
- Includes edits to existing public API documentation.
33
33
34
-
## Testing & QA
34
+
## Testing & QA (How your changes can be verified during release Playtest)
35
35
[//]: # (
36
36
This section is REQUIRED and should describe how the changes were tested and how should they be tested when Playtesting for the release.
37
37
It can range from "edge case covered by unit tests" to "manual testing required and new sample was added".
38
38
Expectation is that PR creator does some manual testing and provides a summary of it here.)
39
39
40
+
<!-- Add any performance testing results here if relevant. -->
41
+
40
42
### Functional Testing
41
43
[//]: #(If checked, List manual tests that have been performed.)
42
44
_Manual testing :_
@@ -50,12 +52,13 @@ _Does the change require QA team to:_
50
52
51
53
-[ ]`Review automated tests`?
52
54
-[ ]`Execute manual tests`?
55
+
-[ ]`Provide feedback about the PR`?
53
56
54
-
If any boxes above are checked, please add QA as a PR reviewer.
57
+
If any boxes above are checked the QA team will be automatically added as a PR reviewer.
55
58
56
-
## Backport
59
+
## Backports
57
60
[//]: # (
58
61
This section is REQUIRED and should link to the PR that targets other NGO version which is either develop or develop-2.0.0 branch
59
62
Add the following to the PR title: "\[Backport\] ..."
60
63
If this is not needed, for example feature specific to NGOv2.X, then just mention this fact.
Copy file name to clipboardExpand all lines: .github/workflows/pr-description-validation.yml
+11-7Lines changed: 11 additions & 7 deletions
Original file line number
Diff line number
Diff line change
@@ -1,12 +1,12 @@
1
-
# This workflow is designed to verify that the pull request description contains a required sections that are important from quality perspective.
1
+
# This workflow is designed to verify that the pull request description contains a required sections that are important from quality perspective.
2
2
# ## 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).
3
3
# ## 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.
4
4
# ## Documentation section is important to ensure that the documentation is updated with the changes made in the PR.
5
5
6
6
# 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.
7
7
# The workflow is configured to run when PR is created as well as when it is edited which also counts simple description edits.
8
8
9
-
name: "NGO - PR Verification"
9
+
name: "NGO - PR description validation"
10
10
11
11
on:
12
12
pull_request:
@@ -17,14 +17,14 @@ on:
17
17
- release/*
18
18
19
19
jobs:
20
-
pr-verification:
20
+
pr-description-validation:
21
21
runs-on: ubuntu-latest
22
22
steps:
23
23
- name: Checkout code
24
24
uses: actions/checkout@v5
25
25
26
26
- name: Check PR description
27
-
uses: actions/github-script@v7
27
+
uses: actions/github-script@v8
28
28
with:
29
29
script: |
30
30
const pr = context.payload.pull_request;
@@ -33,8 +33,8 @@ jobs:
33
33
// List of mandatory PR sections
34
34
const requiredSections = [
35
35
{
36
-
header: '## Backport',
37
-
description: 'PR description must include a "## Backport" 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.'
36
+
header: '## Backports',
37
+
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.'
38
38
},
39
39
{
40
40
header: '## Testing & QA',
@@ -43,6 +43,10 @@ jobs:
43
43
{
44
44
header: '## Documentation',
45
45
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.'
46
+
},
47
+
{
48
+
header: '## Jira ticket',
49
+
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.'
46
50
}
47
51
];
48
52
@@ -59,4 +63,4 @@ jobs:
59
63
message += '\n\nPlease add them to your PR description.';
# This workflow depend on the content of .github/pull_request_template.md file, which should contain the required sections that the script checks for
2
+
# This also works in parallel with .github/workflows/pr-description-validation.yml which validates PR format
3
+
# In contrast to .github/workflows/pr-description-validation.yml, this workflow is conditional and aims to ease the process of requesting QA review by automatically assigning the QA team whenever a checkbox is marked
4
+
5
+
# In case that the given checkboxes are marked the script will automatically add netcode-qa team as a reviewer.
6
+
7
+
name: 'Assign QA Reviewer'
8
+
9
+
on:
10
+
pull_request:
11
+
types: [opened, edited, synchronize, reopened]
12
+
13
+
jobs:
14
+
assign-qa:
15
+
# This job only runs if the checkbox in the PR description exist and is checked.
# This test validates Standards, Package tests, Project tests and Desktop standalone tests to ensure that main platforms are covered
14
-
# Triggers on PRs to develop, develop, and release branches
15
-
# Focuses on critical validation paths that we should validate before merging PRs
16
-
# Cancels previous runs on new commits
17
-
# Excludes draft PRs
14
+
# This test validates Standards, Package tests, Project tests and Desktop standalone tests to ensure that main platforms are covered
15
+
# Focuses on critical validation paths that we should validate before merging PRs. It also cancels previous runs on new commits
16
+
# By default it's triggered if
17
+
# 1) PR targets develop, develop-2.0.0 or release branches
18
+
# 2) PR is not a draft
19
+
# 3) PR changes files in package or testproject folders (doesn't run on for example DOCS only changes)
20
+
21
+
# Note that in other cases you can trigger it by writing a comment "/ci ngo" in the PR thread
18
22
19
23
# Nightly:
20
-
# This test validates same subset as pull_request_trigger with addition of mobile/console tests and webgl builds
21
-
# Runs daily on develop (local configuration)
22
-
# Includes all test types but only on trunk.
23
-
# Adds platform-specific and APV validation
24
+
# This test validates same subset as pull_request_trigger with addition of mobile/console tests and webgl builds
25
+
# Runs daily on develop (local configuration)
26
+
# Includes all test types but only on trunk.
27
+
# Adds platform-specific and APV validation
24
28
25
29
# Weekly:
26
-
# This test validates same subset as develop_nightly but runs per all supported editors as well as executes code coverage test and runs project standards per project
27
-
# Runs across all supported editor versions
28
-
# Includes code coverage analysis
29
-
# Validates all projects and standards
30
+
# This test validates same subset as develop_nightly but runs per all supported editors as well as executes code coverage test and runs project standards per project
# It's important to ensure that all dependencies exist (this can be verified in Yamato) since a modification in parameters may result in a given job not being generated, and thus we will not be able to run such erroneous job.
40
+
# It's important to ensure that all dependencies exist (this can be verified in Yamato) since a modification in parameters may result in a given job not being generated, and thus we will not be able to run such erroneous job.
# Run all relevant tasks when a pull request targeting the develop or release branch is created or updated.
42
47
# In order to have better coverage we run desktop standalone tests with different configurations which allows to mostly cover for different platforms, scripting backends and editor versions.
43
48
# This job will FIRST run "run_quick_checks" jobs (defined in _run-all.yml) since it's the dependency of project pack jobs which is on the lowest dependency tier. This runs the fastest checks (like PVP or code standards) and ONLY IF those pass it will run the rest of the tests.
0 commit comments