Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update autogen script for profile names on UEFI builds #207

Merged
merged 8 commits into from
Jun 22, 2023

Conversation

kuqin12
Copy link
Contributor

@kuqin12 kuqin12 commented Jun 21, 2023

Preface

Please ensure you have read the contribution docs prior
to submitting the pull request. In particular,
pull request guidelines.

Description

This change updated the autogen script to populate the profile names into profile header. The script will accept -pn as an input argument for the comma separated profile names.

This autogen script is also hooked up to CONF_PROFILE_NAMES build variable to allow UEFI platform build to specify names through variables. If platform elects not to specify such argument, the indices will be used for such names during autogen process.

A header file is also created for PlatformConfigDataLib to indicate what global variables will be produced by the autogen scripts and should serve as a contract between the autogen script and any data library should the consumer choose to implement so.

Fixes #205

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

This was tested on QEMU Q35 and SBSA platforms.

Integration Instructions

Specify the CONF_PROFILE_NAMES build variable as comma separated strings during prebuild phase if need to customize.

@github-actions github-actions bot added the language:python Pull requests that update Python code label Jun 21, 2023
@kuqin12 kuqin12 enabled auto-merge (squash) June 21, 2023 22:05
@codecov-commenter
Copy link

codecov-commenter commented Jun 21, 2023

Codecov Report

❗ No coverage uploaded for pull request base (main@a4a522d). Click here to learn what that means.
The diff coverage is 0.00%.

❗ Current head 411a46e differs from pull request most recent head 3f0b94b. Consider uploading reports for the commit 3f0b94b to get more accurate results

@@           Coverage Diff           @@
##             main     #207   +/-   ##
=======================================
  Coverage        ?   27.74%           
=======================================
  Files           ?       16           
  Lines           ?     4494           
  Branches        ?        0           
=======================================
  Hits            ?     1247           
  Misses          ?     3247           
  Partials        ?        0           
Flag Coverage Δ
Linux 27.74% <0.00%> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
SetupDataPkg/Tools/KnobService.py 0.00% <0.00%> (ø)

@kuqin12 kuqin12 merged commit fb5a9e8 into microsoft:main Jun 22, 2023
@kuqin12 kuqin12 deleted the take_name branch June 22, 2023 00:37
ProjectMuBot referenced this pull request in microsoft/mu_tiano_platforms Jun 22, 2023
Introduces 21 new commits in [Features/CONFIG](https://github.com/microsoft/mu_feature_config.git).

<details>
<summary>Commits</summary>
<ul>
<li><a href="https://github.com/microsoft/mu_feature_config/commit/4172ebab015f8aede9c8d8a74256c0f3a80c5ccd">4172eb</a> Repo File Sync: Remove dependabot from release notes (excluding submodules) (<a href="https://github.com/microsoft/mu_feature_config/pull/184">#184</a>)</li>
<li><a href="https://github.com/microsoft/mu_feature_config/commit/c4cf7dc10f806b172ff369062e258c415f87bb76">c4cf7d</a> Repo File Sync: Update to Mu DevOps 3.0.0 and Ubuntu 22 container (<a href="https://github.com/microsoft/mu_feature_config/pull/186">#186</a>)</li>
<li><a href="https://github.com/microsoft/mu_feature_config/commit/81ff0279cd3d043527f6e6d33ed526b4c01e6c3e">81ff02</a> Repo File Sync: Sync MuDevOpsWrapper.yml and update to Mu DevOps v4.0.0 (<a href="https://github.com/microsoft/mu_feature_config/pull/191">#191</a>)</li>
<li><a href="https://github.com/microsoft/mu_feature_config/commit/fdd0e43b90da52eec54d38e6682faf993e9f2f58">fdd0e4</a> Onboarding ARM64 builds on selfhosted Azure pipeline agents (<a href="https://github.com/microsoft/mu_feature_config/pull/180">#180</a>)</li>
<li><a href="https://github.com/microsoft/mu_feature_config/commit/e1ec682479ec365b4ccf05fcdb70ebbb26b4bd38">e1ec68</a> pip: bump edk2-pytool-library from 0.15.0 to 0.15.2 (<a href="https://github.com/microsoft/mu_feature_config/pull/190">#190</a>)</li>
<li><a href="https://github.com/microsoft/mu_feature_config/commit/35badfe771ae99134f98b2796ea00fb59c21432e">35badf</a> Repo File Sync: Update Dependabot PIP schedule from daily to weekly (<a href="https://github.com/microsoft/mu_feature_config/pull/192">#192</a>)</li>
<li><a href="https://github.com/microsoft/mu_feature_config/commit/4478ef8a1822c7263f309157ff864bd1a73d8aff">4478ef</a> pip: bump pyopenssl from 23.1.1 to 23.2.0 (<a href="https://github.com/microsoft/mu_feature_config/pull/189">#189</a>)</li>
<li><a href="https://github.com/microsoft/mu_feature_config/commit/bb1dfa16601fdb65aeb8464c064cfc1509d384b0">bb1dfa</a> pip: bump regex from 2023.5.5 to 2023.6.3 (<a href="https://github.com/microsoft/mu_feature_config/pull/193">#193</a>)</li>
<li><a href="https://github.com/microsoft/mu_feature_config/commit/68b4a71321a776afb69fc7fdb6db42fd91baeeba">68b4a7</a> pip: bump edk2-basetools from 0.1.48 to 0.1.49 (<a href="https://github.com/microsoft/mu_feature_config/pull/195">#195</a>)</li>
<li><a href="https://github.com/microsoft/mu_feature_config/commit/7f1d366b25fd2ef32b2cb93fbb7a34a105d409a6">7f1d36</a> pip: bump edk2-pytool-extensions from 0.23.3 to 0.23.5 (<a href="https://github.com/microsoft/mu_feature_config/pull/194">#194</a>)</li>
<li><a href="https://github.com/microsoft/mu_feature_config/commit/c0ef0cc5251e1ac103a18ae72b94f4f8414795f3">c0ef0c</a> pip: bump pytest-cov from 4.0.0 to 4.1.0 (<a href="https://github.com/microsoft/mu_feature_config/pull/185">#185</a>)</li>
<li><a href="https://github.com/microsoft/mu_feature_config/commit/716ad72c798fd3c89feb62bec528972d42769a6a">716ad7</a> Create GENERIC_PROFILE_INDEX Macro (<a href="https://github.com/microsoft/mu_feature_config/pull/196">#196</a>)</li>
<li><a href="https://github.com/microsoft/mu_feature_config/commit/6f2c5a8489ccbbb5afa5b3a49d00d7a6429902c3">6f2c5a</a> Repo File Sync: synced file(s) with microsoft/mu_devops (<a href="https://github.com/microsoft/mu_feature_config/pull/199">#199</a>)</li>
<li><a href="https://github.com/microsoft/mu_feature_config/commit/f2979393cd6a319551c2f00aad6df4a4d79d74ec">f29793</a> pip: bump edk2-pytool-library from 0.15.2 to 0.15.3 (<a href="https://github.com/microsoft/mu_feature_config/pull/201">#201</a>)</li>
<li><a href="https://github.com/microsoft/mu_feature_config/commit/ef98997fe0b1f10c2215504ee105692f6eaa1a7c">ef9899</a> pip: bump xmlschema from 2.3.0 to 2.3.1 (<a href="https://github.com/microsoft/mu_feature_config/pull/204">#204</a>)</li>
<li><a href="https://github.com/microsoft/mu_feature_config/commit/7b3b08c2a56af085c3b1b8c5e93c3747faa0c4b0">7b3b08</a> pip: bump pytest from 7.3.1 to 7.3.2 (<a href="https://github.com/microsoft/mu_feature_config/pull/203">#203</a>)</li>
<li><a href="https://github.com/microsoft/mu_feature_config/commit/eda20e5ee8162eee99f1e3d79c2a8e3cf591ffb6">eda20e</a> pip: bump edk2-pytool-extensions from 0.23.5 to 0.23.6 (<a href="https://github.com/microsoft/mu_feature_config/pull/202">#202</a>)</li>
<li><a href="https://github.com/microsoft/mu_feature_config/commit/54e781dc8a1e5a34f71b5c1fc3f650af8c6ce466">54e781</a> Repo File Sync: Update to Mu DevOps 4.0.5 (<a href="https://github.com/microsoft/mu_feature_config/pull/206">#206</a>)</li>
<li><a href="https://github.com/microsoft/mu_feature_config/commit/a4a522d4a60a105dcff3494a40cefd59677442b0">a4a522</a> Repo File Sync: Update to Mu DevOps 5.0.0 (<a href="https://github.com/microsoft/mu_feature_config/pull/208">#208</a>)</li>
<li><a href="https://github.com/microsoft/mu_feature_config/commit/fb5a9e8da1ddec389d91f437849d32cfd3bbcbc4">fb5a9e</a> Update autogen script for profile names on UEFI builds (<a href="https://github.com/microsoft/mu_feature_config/pull/207">#207</a>)</li>
<li><a href="https://github.com/microsoft/mu_feature_config/commit/9c59d2ed2f7f51cb106dca507057f0f6f3bede77">9c59d2</a> Repo File Sync: Update to Mu DevOps v5.0.1 (<a href="https://github.com/microsoft/mu_feature_config/pull/209">#209</a>)</li>
</ul>
</details>

Signed-off-by: Project Mu Bot <[email protected]>
ProjectMuBot referenced this pull request in microsoft/mu_tiano_platforms Jun 23, 2023
Introduces 22 new commits in [Features/CONFIG](https://github.com/microsoft/mu_feature_config.git).

<details>
<summary>Commits</summary>
<ul>
<li><a href="https://github.com/microsoft/mu_feature_config/commit/4172ebab015f8aede9c8d8a74256c0f3a80c5ccd">4172eb</a> Repo File Sync: Remove dependabot from release notes (excluding submodules) (<a href="https://github.com/microsoft/mu_feature_config/pull/184">#184</a>)</li>
<li><a href="https://github.com/microsoft/mu_feature_config/commit/c4cf7dc10f806b172ff369062e258c415f87bb76">c4cf7d</a> Repo File Sync: Update to Mu DevOps 3.0.0 and Ubuntu 22 container (<a href="https://github.com/microsoft/mu_feature_config/pull/186">#186</a>)</li>
<li><a href="https://github.com/microsoft/mu_feature_config/commit/81ff0279cd3d043527f6e6d33ed526b4c01e6c3e">81ff02</a> Repo File Sync: Sync MuDevOpsWrapper.yml and update to Mu DevOps v4.0.0 (<a href="https://github.com/microsoft/mu_feature_config/pull/191">#191</a>)</li>
<li><a href="https://github.com/microsoft/mu_feature_config/commit/fdd0e43b90da52eec54d38e6682faf993e9f2f58">fdd0e4</a> Onboarding ARM64 builds on selfhosted Azure pipeline agents (<a href="https://github.com/microsoft/mu_feature_config/pull/180">#180</a>)</li>
<li><a href="https://github.com/microsoft/mu_feature_config/commit/e1ec682479ec365b4ccf05fcdb70ebbb26b4bd38">e1ec68</a> pip: bump edk2-pytool-library from 0.15.0 to 0.15.2 (<a href="https://github.com/microsoft/mu_feature_config/pull/190">#190</a>)</li>
<li><a href="https://github.com/microsoft/mu_feature_config/commit/35badfe771ae99134f98b2796ea00fb59c21432e">35badf</a> Repo File Sync: Update Dependabot PIP schedule from daily to weekly (<a href="https://github.com/microsoft/mu_feature_config/pull/192">#192</a>)</li>
<li><a href="https://github.com/microsoft/mu_feature_config/commit/4478ef8a1822c7263f309157ff864bd1a73d8aff">4478ef</a> pip: bump pyopenssl from 23.1.1 to 23.2.0 (<a href="https://github.com/microsoft/mu_feature_config/pull/189">#189</a>)</li>
<li><a href="https://github.com/microsoft/mu_feature_config/commit/bb1dfa16601fdb65aeb8464c064cfc1509d384b0">bb1dfa</a> pip: bump regex from 2023.5.5 to 2023.6.3 (<a href="https://github.com/microsoft/mu_feature_config/pull/193">#193</a>)</li>
<li><a href="https://github.com/microsoft/mu_feature_config/commit/68b4a71321a776afb69fc7fdb6db42fd91baeeba">68b4a7</a> pip: bump edk2-basetools from 0.1.48 to 0.1.49 (<a href="https://github.com/microsoft/mu_feature_config/pull/195">#195</a>)</li>
<li><a href="https://github.com/microsoft/mu_feature_config/commit/7f1d366b25fd2ef32b2cb93fbb7a34a105d409a6">7f1d36</a> pip: bump edk2-pytool-extensions from 0.23.3 to 0.23.5 (<a href="https://github.com/microsoft/mu_feature_config/pull/194">#194</a>)</li>
<li><a href="https://github.com/microsoft/mu_feature_config/commit/c0ef0cc5251e1ac103a18ae72b94f4f8414795f3">c0ef0c</a> pip: bump pytest-cov from 4.0.0 to 4.1.0 (<a href="https://github.com/microsoft/mu_feature_config/pull/185">#185</a>)</li>
<li><a href="https://github.com/microsoft/mu_feature_config/commit/716ad72c798fd3c89feb62bec528972d42769a6a">716ad7</a> Create GENERIC_PROFILE_INDEX Macro (<a href="https://github.com/microsoft/mu_feature_config/pull/196">#196</a>)</li>
<li><a href="https://github.com/microsoft/mu_feature_config/commit/6f2c5a8489ccbbb5afa5b3a49d00d7a6429902c3">6f2c5a</a> Repo File Sync: synced file(s) with microsoft/mu_devops (<a href="https://github.com/microsoft/mu_feature_config/pull/199">#199</a>)</li>
<li><a href="https://github.com/microsoft/mu_feature_config/commit/f2979393cd6a319551c2f00aad6df4a4d79d74ec">f29793</a> pip: bump edk2-pytool-library from 0.15.2 to 0.15.3 (<a href="https://github.com/microsoft/mu_feature_config/pull/201">#201</a>)</li>
<li><a href="https://github.com/microsoft/mu_feature_config/commit/ef98997fe0b1f10c2215504ee105692f6eaa1a7c">ef9899</a> pip: bump xmlschema from 2.3.0 to 2.3.1 (<a href="https://github.com/microsoft/mu_feature_config/pull/204">#204</a>)</li>
<li><a href="https://github.com/microsoft/mu_feature_config/commit/7b3b08c2a56af085c3b1b8c5e93c3747faa0c4b0">7b3b08</a> pip: bump pytest from 7.3.1 to 7.3.2 (<a href="https://github.com/microsoft/mu_feature_config/pull/203">#203</a>)</li>
<li><a href="https://github.com/microsoft/mu_feature_config/commit/eda20e5ee8162eee99f1e3d79c2a8e3cf591ffb6">eda20e</a> pip: bump edk2-pytool-extensions from 0.23.5 to 0.23.6 (<a href="https://github.com/microsoft/mu_feature_config/pull/202">#202</a>)</li>
<li><a href="https://github.com/microsoft/mu_feature_config/commit/54e781dc8a1e5a34f71b5c1fc3f650af8c6ce466">54e781</a> Repo File Sync: Update to Mu DevOps 4.0.5 (<a href="https://github.com/microsoft/mu_feature_config/pull/206">#206</a>)</li>
<li><a href="https://github.com/microsoft/mu_feature_config/commit/a4a522d4a60a105dcff3494a40cefd59677442b0">a4a522</a> Repo File Sync: Update to Mu DevOps 5.0.0 (<a href="https://github.com/microsoft/mu_feature_config/pull/208">#208</a>)</li>
<li><a href="https://github.com/microsoft/mu_feature_config/commit/fb5a9e8da1ddec389d91f437849d32cfd3bbcbc4">fb5a9e</a> Update autogen script for profile names on UEFI builds (<a href="https://github.com/microsoft/mu_feature_config/pull/207">#207</a>)</li>
<li><a href="https://github.com/microsoft/mu_feature_config/commit/9c59d2ed2f7f51cb106dca507057f0f6f3bede77">9c59d2</a> Repo File Sync: Update to Mu DevOps v5.0.1 (<a href="https://github.com/microsoft/mu_feature_config/pull/209">#209</a>)</li>
<li><a href="https://github.com/microsoft/mu_feature_config/commit/8ec2959343b76a0c60f0a363f1fd26d29146c4fe">8ec295</a> The profile name variable should be a string array (<a href="https://github.com/microsoft/mu_feature_config/pull/210">#210</a>)</li>
</ul>
</details>

Signed-off-by: Project Mu Bot <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
language:python Pull requests that update Python code
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Bug]: Contract of autogen header data variables and the consumers
4 participants