Repo File Sync: Synced file(s) with microsoft/mu_devops (#191)

Synced local file(s) with [microsoft/mu_devops](https://github.com/microsoft/mu_devops). 🤖: View the [Repo File Sync Configuration File](https://github.com/microsoft/mu_devops/blob/main/.sync/Files.yml) to see how files are synced. --- This PR was created automatically by the [repo-file-sync-action](https://github.com/BetaHuhn/repo-file-sync-action) workflow run [#3578665266](https://github.com/microsoft/mu_devops/actions/runs/3578665266) Signed-off-by: Project Mu UEFI Bot <uefibot@microsoft.com>
microsoft · Dec 18, 2023 · 5907955 · 5907955
1 parent 6e4ab3a
commit 5907955
Show file tree

Hide file tree

Showing 23 changed files with 892 additions and 62 deletions.
diff --git a/.azurepipelines/MuDevOpsWrapper.yml b/.azurepipelines/MuDevOpsWrapper.yml
@@ -0,0 +1,119 @@
+## @file
+# Azure Pipeline build file for a build using mu_devops.
+#
+# NOTE: This file is automatically synchronized from Mu DevOps. Update the original file there
+#       instead of the file in this repo.
+#
+# - Mu DevOps Repo: https://github.com/microsoft/mu_devops
+# - File Sync Settings: https://github.com/microsoft/mu_devops/blob/main/.sync/Files.yml
+#
+# Copyright (c) Microsoft Corporation.
+# SPDX-License-Identifier: BSD-2-Clause-Patent
+##
+
+resources:
+  repositories:
+    - repository: mu_devops
+      type: github
+      endpoint: microsoft
+      name: microsoft/mu_devops
+      ref: refs/tags/v7.0.1
+
+parameters:
+- name: do_ci_build
+  displayName: Perform Stuart CI Build
+  type: boolean
+  default: true
+- name: do_ci_setup
+  displayName: Perform Stuart CI Setup
+  type: boolean
+  default: true
+- name: do_non_ci_build
+  displayName: Perform non-CI Stuart Build
+  type: boolean
+  default: false
+- name: do_non_ci_setup
+  displayName: Perform non-CI Stuart Setup
+  type: boolean
+  default: false
+- name: do_pr_eval
+  displayName: Perform Stuart PR Evaluation
+  type: boolean
+  default: true
+- name: container_build
+  displayName: Flag for whether this repo should do stuart_setup
+  type: boolean
+  default: false
+- name: os_type
+  displayName: OS type on the self-hosted agent pools
+  type: string
+  values:
+  - Windows_NT
+  - Linux
+  default: Windows_NT
+- name: build_matrix
+  displayName: Build matrix for this repository
+  type: object
+- name: pool_name
+  displayName: Variable name that hosts pool name to be used for self-hosted agents
+  type: string
+  default: pool_name
+- name: extra_install_step
+  displayName: Extra Install Steps
+  type: stepList
+  default:
+    - script: echo No extra steps provided
+- name: extra_jobs
+  displayName: Extra Jobs to be run after build
+  type: jobList
+  default: []
+- name: rust_build
+  displayName: Whether Rust code is being built
+  type: boolean
+  default: false
+- name: extra_cargo_steps
+  displayName: Extra Steps to Run Before Standard Cargo Steps
+  type: stepList
+  default:
+    - script: echo No extra cargo steps provided
+
+jobs:
+- template: Jobs/PrGate.yml@mu_devops
+  parameters:
+    linux_container_image: ghcr.io/microsoft/mu_devops/ubuntu-22-build:1082f35
+    ${{ if eq(parameters.rust_build, true) }}:
+      linux_container_options: --security-opt seccomp=unconfined
+    do_ci_build: ${{ parameters.do_ci_build }}
+    do_ci_setup: ${{ parameters.do_ci_setup }}
+    do_pr_eval: ${{ parameters.do_pr_eval }}
+    do_non_ci_setup: ${{ parameters.do_non_ci_setup }}
+    do_non_ci_build: ${{ parameters.do_non_ci_build }}
+    build_matrix: ${{ parameters.build_matrix }}
+    os_type: ${{ parameters.os_type }}
+    pool_name: ${{ parameters.pool_name }}
+    extra_install_step: ${{ parameters.extra_install_step }}
+    tool_chain_tag: $(tool_chain_tag)
+    vm_image: $(vm_image)
+    container_build: ${{ parameters.container_build }}
+    rust_build: ${{ parameters.rust_build }}
+
+- ${{ if eq(parameters.rust_build, true) }}:
+  - job: CargoCmds
+    displayName: Workspace Cargo Commands
+
+    container:
+
+      image: ghcr.io/microsoft/mu_devops/ubuntu-22-build:1082f35
+      options: --user root --name mu_devops_build_container --security-opt seccomp=unconfined
+
+    steps:
+    - checkout: self
+      fetchDepth: 1
+      clean: true
+    - ${{ parameters.extra_cargo_steps }}
+    - template: Steps/RustCargoSteps.yml@mu_devops
+      parameters:
+        container_build: true
+
+- ${{ parameters.extra_jobs }}
+
diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json
@@ -1,15 +1,11 @@
 {
-  "image": "ghcr.io/tianocore/containers/fedora-35-dev:latest",
-  "postCreateCommand": "git config --global --add safe.directory * && pip install --upgrade -r pip-requirements.txt",
+  "image": "ghcr.io/microsoft/mu_devops/ubuntu-22-dev:latest",
+  "postCreateCommand": "git config --global --add safe.directory '*' && git config --global --add core.autocrlf false && pip install --upgrade -r pip-requirements.txt",
   "customizations": {
     "vscode": {
       "extensions": [
-        "DavidAnson.vscode-markdownlint",
-        "ms-azuretools.vscode-docker",
-        "ms-vscode-remote.remote-containers",
         "ms-vscode.cpptools",
-        "walonli.edk2-vscode",
-        "zachflower.uncrustify"
+        "DavidAnson.vscode-markdownlint"
       ]
     }
   }

diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
@@ -1,24 +1,16 @@
-## @file
-# GitHub issue configuration file.
+# Project Mu GitHub Issue Configuration File
 #
-# This file is meant to direct contributors familiar with GitHub's issue tracker
-# to the external resources used by TianoCore.
+# NOTE: This file is automatically synchronized from Mu DevOps. Update the original file there
+#       instead of the file in this repo.
+#
+# - Mu DevOps Repo: https://github.com/microsoft/mu_devops
+# - File Sync Settings: https://github.com/microsoft/mu_devops/blob/main/.sync/Files.yml
 #
 # Copyright (c) Microsoft Corporation.
 # SPDX-License-Identifier: BSD-2-Clause-Patent
-##
+#
 
-blank_issues_enabled: false
 contact_links:
-  - name: Bugs and Feature Requests
-    url: https://bugzilla.tianocore.org/
-    about: Submit bug reports and feature requests here
-  - name: Reporting Security Issues
-    url: https://github.com/tianocore/tianocore.github.io/wiki/Reporting-Security-Issues
-    about: Read the wiki page that describes the process here
-  - name: EDK II Development Mailing List
-    url: https://edk2.groups.io/g/devel
-    about: Submit code patches and ask questions on the mailing list (devel@edk2.groups.io)
-  - name: EDK II Discussions
-    url: https://github.com/tianocore/edk2/discussions
-    about: You can also reach out on the Discussion section of this repository
+  - name: 📃 Project Mu Documentation
+    url: https://microsoft.github.io/mu/
+    about: Goals, principles, repo layout, build instructions, and more.
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -2,29 +2,72 @@
 # Dependabot configuration file to enable GitHub services for managing and updating
 # dependencies.
 #
-# Copyright (c) Microsoft Corporation. All rights reserved.
+# NOTE: This file is automatically synchronized from Mu DevOps. Update the original file there
+#       instead of the file in this repo.
+#
+#       This dependabot file is limited to syncing the following type of dependencies. Other files
+#       are already available in Mu DevOps to sync other dependency types.
+#         - Rust Crate Dependencies (`cargo`)
+#         - GitHub Actions (`github-actions`)
+#         - Python PIP Modules (`pip`)
+#
+#       Dependabot does not update the microsoft/mu_devops version because that is updated once in mu_devops
+#       and then synced to all repos when the file sync occurs.
+#
+# - Mu DevOps Repo: https://github.com/microsoft/mu_devops
+# - File Sync Settings: https://github.com/microsoft/mu_devops/blob/main/.sync/Files.yml
+#
+# Copyright (c) Microsoft Corporation.
 # SPDX-License-Identifier: BSD-2-Clause-Patent
 #
-# Please see the documentation for all configuration options:
+# Please see the documentation for all dependabot configuration options:
 # https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
 ##
 
 version: 2
+
 updates:
-  - package-ecosystem: "pip"
+  - package-ecosystem: "cargo"
     directory: "/"
     schedule:
-      interval: "daily"
+      interval: "weekly"
+      day: "monday"
+      timezone: "America/Los_Angeles"
+      time: "03:00"
     commit-message:
-      prefix: "pip"
-
+      prefix: "Rust Dependency"
+    labels:
+      - "type:dependencies"
+      - "type:dependabot"
     rebase-strategy: "disabled"
 
   - package-ecosystem: "github-actions"
     directory: "/"
     schedule:
       interval: "weekly"
       day: "monday"
+      timezone: "America/Los_Angeles"
+      time: "06:00"
+    ignore:
+      - dependency-name: "microsoft/mu_devops"
     commit-message:
       prefix: "GitHub Action"
+    labels:
+      - "type:dependencies"
+      - "type:dependabot"
+    rebase-strategy: "disabled"
+
+  - package-ecosystem: "pip"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+      day: "wednesday"
+      timezone: "America/Los_Angeles"
+      time: "01:00"
+    commit-message:
+      prefix: "pip"
+    labels:
+      - "language:python"
+      - "type:dependencies"
+      - "type:dependabot"
     rebase-strategy: "disabled"
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
@@ -0,0 +1,42 @@
+# 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._>
+
+For each item, 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, ...
+
+## How This Was Tested
+
+<_Please describe the test(s) that were run to verify the changes._>
+
+## Integration Instructions
+
+<_Describe how these changes should be integrated. Use N/A if nothing is required._>
diff --git a/.github/release-draft-config-n-1.yml b/.github/release-draft-config-n-1.yml
@@ -0,0 +1,100 @@
+# Defines the configuration used for drafting new releases.
+#
+# IMPORTANT: Only use labels defined in the .github/Labels.yml file in this repo.
+#
+# NOTE: `semver:major`, `semver:minor`, and `semver:patch` can be used to force that
+#       version to roll regardless of other labels.
+#
+# NOTE: This file is automatically synchronized from Mu DevOps. Update the original file there
+#       instead of the file in this repo.
+#
+# - Mu DevOps Repo: https://github.com/microsoft/mu_devops
+# - File Sync Settings: https://github.com/microsoft/mu_devops/blob/main/.sync/Files.yml
+#
+# Copyright (c) Microsoft Corporation.
+# SPDX-License-Identifier: BSD-2-Clause-Patent
+#
+# For more information, see:
+# https://github.com/release-drafter/release-drafter
+
+name-template: 'v$RESOLVED_VERSION'
+tag-template: 'v$RESOLVED_VERSION'
+
+commitish: refs/heads/release/202208
+filter-by-commitish: true
+
+template: |
+  # What's Changed
+
+  $CHANGES
+
+  **Full Changelog**: https://github.com/$OWNER/$REPOSITORY/compare/$PREVIOUS_TAG...v$RESOLVED_VERSION
+
+categories:
+  - title: '⚠️ Breaking Changes'
+    labels:
+      - 'impact:breaking-change'
+  - title: '🚀 Features & ✨ Enhancements'
+    labels:
+      - 'type:design-change'
+      - 'type:enhancement'
+      - 'type:feature-request'
+  - title: '🐛 Bug Fixes'
+    labels:
+      - 'type:bug'
+  - title: '🔐 Security Impacting'
+    labels:
+      - 'impact:security'
+  - title: '📖 Documentation Updates'
+    labels:
+      - 'type:documentation'
+  - title: '🛠️ Submodule Updates'
+    labels:
+      - 'type:submodules'
+
+change-template: >-
+  <ul>
+    <li>
+      $TITLE @$AUTHOR (#$NUMBER)
+      <br>
+      <details>
+        <summary>Change Details</summary>
+        <blockquote>
+          <!-- Non-breaking space to have content if body is empty -->
+          &nbsp; $BODY
+        </blockquote>
+        <hr>
+      </details>
+    </li>
+  </ul>
+
+change-title-escapes: '\<*_&@' # Note: @ is added to disable mentions
+
+# Maintenance: Keep labels organized in ascending alphabetical order - easier to scan, identify duplicates, etc.
+version-resolver:
+  major:
+    labels:
+      - 'impact:breaking-change'
+      - 'semver:major'
+  minor:
+    labels:
+      - 'semver:minor'
+      - 'type:design-change'
+      - 'type:enhancement'
+      - 'type:feature-request'
+  patch:
+    labels:
+      - 'impact:non-functional'
+      - 'semver:patch'
+      - 'type:bug'
+      - 'type:documentation'
+  default: patch
+
+exclude-labels:
+  - 'type:dependabot'
+  - 'type:file-sync'
+  - 'type:notes'
+  - 'type:question'
+
+exclude-contributors:
+  - 'uefibot'