From 1b485621af9b0aabfc1bfe9562e07545c2d55698 Mon Sep 17 00:00:00 2001 From: uefibot Date: Tue, 1 Oct 2024 09:04:28 +0000 Subject: [PATCH] Repo File Sync: synced file(s) with microsoft/mu_devops Signed-off-by: Project Mu UEFI Bot --- .azurepipelines/MuDevOpsWrapper.yml | 6 +-- .github/pull_request_template.md | 29 ++------------ .github/release-draft-config-n-1.yml | 2 +- .github/release-draft-config-n.yml | 2 +- .github/workflows/auto-approve.yml | 2 +- .github/workflows/auto-merge.yml | 2 +- .github/workflows/codeql.yml | 2 + .github/workflows/issue-assignment.yml | 2 +- .github/workflows/label-issues.yml | 2 +- .github/workflows/label-sync.yml | 2 +- .github/workflows/release-draft.yml | 4 +- .github/workflows/stale.yml | 2 +- .github/workflows/triage-issues.yml | 2 +- CONTRIBUTING.md | 53 +++++++++++++++++++++++++- 14 files changed, 71 insertions(+), 41 deletions(-) diff --git a/.azurepipelines/MuDevOpsWrapper.yml b/.azurepipelines/MuDevOpsWrapper.yml index e838283829..9bd9820824 100644 --- a/.azurepipelines/MuDevOpsWrapper.yml +++ b/.azurepipelines/MuDevOpsWrapper.yml @@ -19,7 +19,7 @@ resources: type: github endpoint: microsoft name: microsoft/mu_devops - ref: refs/tags/v10.0.0 + ref: refs/tags/v12.0.2 parameters: - name: do_ci_build @@ -82,7 +82,7 @@ parameters: jobs: - template: Jobs/PrGate.yml@mu_devops parameters: - linux_container_image: ghcr.io/microsoft/mu_devops/ubuntu-22-build:0e124c1 + linux_container_image: ghcr.io/microsoft/mu_devops/ubuntu-22-build:d1e4ff1 ${{ if eq(parameters.rust_build, true) }}: linux_container_options: --security-opt seccomp=unconfined do_ci_build: ${{ parameters.do_ci_build }} @@ -105,7 +105,7 @@ jobs: container: - image: ghcr.io/microsoft/mu_devops/ubuntu-22-build:0e124c1 + image: ghcr.io/microsoft/mu_devops/ubuntu-22-build:d1e4ff1 options: --user root --name mu_devops_build_container --security-opt seccomp=unconfined steps: diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 0f216b6d50..eb455e3452 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,41 +1,18 @@ -# Preface - -Please ensure you have read the [contribution docs](https://github.com/microsoft/mu/blob/master/CONTRIBUTING.md) prior -to submitting the pull request. In particular, -[pull request guidelines](https://github.com/microsoft/mu/blob/master/CONTRIBUTING.md#pull-request-best-practices). - ## Description -<_Please include a description of the change and why this change was made._> +<_Include a description of the change and why this change was made._> -For each item, place an "x" in between `[` and `]` if true. Example: `[x]`. -_(you can also check items in the GitHub UI)_ +For details on how to complete these options and their meaning refer to [CONTRIBUTING.md](https://github.com/microsoft/mu/blob/HEAD/CONTRIBUTING.md). - [ ] Impacts functionality? - - **Functionality** - Does the change ultimately impact how firmware functions? - - Examples: Add a new library, publish a new PPI, update an algorithm, ... - [ ] Impacts security? - - **Security** - Does the change have a direct security impact on an application, - flow, or firmware? - - Examples: Crypto algorithm change, buffer overflow fix, parameter - validation improvement, ... - [ ] Breaking change? - - **Breaking change** - Will anyone consuming this change experience a break - in build or boot behavior? - - Examples: Add a new library class, move a module to a different repo, call - a function in a new library class in a pre-existing module, ... - [ ] Includes tests? - - **Tests** - Does the change include any explicit test code? - - Examples: Unit tests, integration tests, robot tests, ... - [ ] Includes documentation? - - **Documentation** - Does the change contain explicit documentation additions - outside direct code modifications (and comments)? - - Examples: Update readme file, add feature readme file, link to documentation - on an a separate Web page, ... ## How This Was Tested -<_Please describe the test(s) that were run to verify the changes._> +<_Describe the test(s) that were run to verify the changes._> ## Integration Instructions diff --git a/.github/release-draft-config-n-1.yml b/.github/release-draft-config-n-1.yml index 8609c62bb9..fcf38acfbd 100644 --- a/.github/release-draft-config-n-1.yml +++ b/.github/release-draft-config-n-1.yml @@ -20,7 +20,7 @@ name-template: 'v$RESOLVED_VERSION' tag-template: 'v$RESOLVED_VERSION' -commitish: refs/heads/release/202302 +commitish: refs/heads/release/202311 filter-by-commitish: true template: | diff --git a/.github/release-draft-config-n.yml b/.github/release-draft-config-n.yml index fcf38acfbd..b4fd801fee 100644 --- a/.github/release-draft-config-n.yml +++ b/.github/release-draft-config-n.yml @@ -20,7 +20,7 @@ name-template: 'v$RESOLVED_VERSION' tag-template: 'v$RESOLVED_VERSION' -commitish: refs/heads/release/202311 +commitish: refs/heads/release/202405 filter-by-commitish: true template: | diff --git a/.github/workflows/auto-approve.yml b/.github/workflows/auto-approve.yml index 23b9389ffe..4c5bc6e38c 100644 --- a/.github/workflows/auto-approve.yml +++ b/.github/workflows/auto-approve.yml @@ -29,5 +29,5 @@ jobs: if: | github.event.pull_request.user.login == 'dependabot[bot]' || github.event.pull_request.user.login == 'uefibot' - uses: microsoft/mu_devops/.github/workflows/AutoApprover.yml@v10.0.0 + uses: microsoft/mu_devops/.github/workflows/AutoApprover.yml@v12.0.2 secrets: inherit diff --git a/.github/workflows/auto-merge.yml b/.github/workflows/auto-merge.yml index 4f37dd5f5a..4540ef8a93 100644 --- a/.github/workflows/auto-merge.yml +++ b/.github/workflows/auto-merge.yml @@ -32,5 +32,5 @@ jobs: if: | github.event.pull_request.user.login == 'dependabot[bot]' || github.event.pull_request.user.login == 'uefibot' - uses: microsoft/mu_devops/.github/workflows/AutoMerger.yml@v10.0.0 + uses: microsoft/mu_devops/.github/workflows/AutoMerger.yml@v12.0.2 secrets: inherit diff --git a/.github/workflows/codeql.yml b/.github/workflows/codeql.yml index 46bdd4fbee..52fb6a2258 100644 --- a/.github/workflows/codeql.yml +++ b/.github/workflows/codeql.yml @@ -29,10 +29,12 @@ on: branches: - main - release/* + - dev/* pull_request: branches: - main - release/* + - dev/* paths-ignore: - '!**.c' - '!**.h' diff --git a/.github/workflows/issue-assignment.yml b/.github/workflows/issue-assignment.yml index 79196ea3b2..8c5666a294 100644 --- a/.github/workflows/issue-assignment.yml +++ b/.github/workflows/issue-assignment.yml @@ -23,4 +23,4 @@ jobs: contents: read issues: write - uses: microsoft/mu_devops/.github/workflows/IssueAssignment.yml@v10.0.0 + uses: microsoft/mu_devops/.github/workflows/IssueAssignment.yml@v12.0.2 diff --git a/.github/workflows/label-issues.yml b/.github/workflows/label-issues.yml index ffad0ec08f..658170a7d7 100644 --- a/.github/workflows/label-issues.yml +++ b/.github/workflows/label-issues.yml @@ -36,4 +36,4 @@ jobs: contents: read pull-requests: write - uses: microsoft/mu_devops/.github/workflows/Labeler.yml@v10.0.0 + uses: microsoft/mu_devops/.github/workflows/Labeler.yml@v12.0.2 diff --git a/.github/workflows/label-sync.yml b/.github/workflows/label-sync.yml index c42746422d..3f9599c489 100644 --- a/.github/workflows/label-sync.yml +++ b/.github/workflows/label-sync.yml @@ -28,4 +28,4 @@ jobs: permissions: issues: write - uses: microsoft/mu_devops/.github/workflows/LabelSyncer.yml@v10.0.0 + uses: microsoft/mu_devops/.github/workflows/LabelSyncer.yml@v12.0.2 diff --git a/.github/workflows/release-draft.yml b/.github/workflows/release-draft.yml index 94e45e70f0..a9868f4701 100644 --- a/.github/workflows/release-draft.yml +++ b/.github/workflows/release-draft.yml @@ -23,7 +23,7 @@ name: Update Release Draft on: push: branches: - - release/202311 + - release/202405 jobs: draft: @@ -32,5 +32,5 @@ jobs: contents: write pull-requests: write - uses: microsoft/mu_devops/.github/workflows/ReleaseDrafter.yml@v10.0.0 + uses: microsoft/mu_devops/.github/workflows/ReleaseDrafter.yml@v12.0.2 secrets: inherit diff --git a/.github/workflows/stale.yml b/.github/workflows/stale.yml index 5b94e82283..b4b9fb86cd 100644 --- a/.github/workflows/stale.yml +++ b/.github/workflows/stale.yml @@ -29,4 +29,4 @@ jobs: issues: write pull-requests: write - uses: microsoft/mu_devops/.github/workflows/Stale.yml@v10.0.0 + uses: microsoft/mu_devops/.github/workflows/Stale.yml@v12.0.2 diff --git a/.github/workflows/triage-issues.yml b/.github/workflows/triage-issues.yml index 49780aaedb..2faddd987d 100644 --- a/.github/workflows/triage-issues.yml +++ b/.github/workflows/triage-issues.yml @@ -23,4 +23,4 @@ jobs: permissions: issues: write - uses: microsoft/mu_devops/.github/workflows/IssueTriager.yml@v10.0.0 + uses: microsoft/mu_devops/.github/workflows/IssueTriager.yml@v12.0.2 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c6ff888b87..2199e97489 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -21,7 +21,7 @@ submitted in the issues section. ## Security Vulnerabilities Please review the repos `Security Policy` but in general every Project Mu repo has `Private vulnerability reporting` -enabled. Please use the security tab to report a potential issue. +enabled. Please use the security tab to report a potential issue. ### Identify Where to Report @@ -63,6 +63,57 @@ configuration files. To aid maintainers in reviewing your code, we suggest adher * If the contribution logically be broken up into separate pull requests that independently build and function successfully, do use multiple pull requests. +#### Pull Request Description Checkboxes + +Project Mu pull requests autopopulate a PR description from a template in most repositories. You should: + +1. **Replace** this text with an actual descrption: + + ```txt + <_Include a description of the change and why this change was made._> + ``` + +2. **Remove** this line of instructions so the PR description shows cleanly in release notes: + + `"For details on how to complete these options and their meaning refer to [CONTRIBUTING.md](https://github.com/microsoft/mu/blob/HEAD/CONTRIBUTING.md)."` + +3. For each checkbox in the PR description, **place an "x"** in between `[` and `]` if true. Example: `[x]`. + _(you can also check items in the GitHub UI)_ + + * **[] Impacts functionality?** + * **Functionality** - Does the change ultimately impact how firmware functions? + * Examples: Add a new library, publish a new PPI, update an algorithm, ... + * **[] Impacts security?** + * **Security** - Does the change have a direct security impact on an application, + flow, or firmware? + * Examples: Crypto algorithm change, buffer overflow fix, parameter + validation improvement, ... + * **[] Breaking change?** + * **Breaking change** - Will anyone consuming this change experience a break + in build or boot behavior? + * Examples: Add a new library class, move a module to a different repo, call + a function in a new library class in a pre-existing module, ... + * [] **Includes tests?** + * **Tests** - Does the change include any explicit test code? + * Examples: Unit tests, integration tests, robot tests, ... + * [] **Includes documentation?** + * **Documentation** - Does the change contain explicit documentation additions + outside direct code modifications (and comments)? + * Examples: Update readme file, add feature readme file, link to documentation + on an a separate Web page, ... + +4. **Replace** this text as instructed: + + ```txt + <_Describe the test(s) that were run to verify the changes._> + ``` + +5. **Replace** this text as instructed: + + ```txt + <_Describe how these changes should be integrated. Use N/A if nothing is required._> + ``` + #### Code Categories To keep code digestible, you may consider breaking large pull requests into three categories of commits within the pull