From 351592c3af1ddf81e5452dbf14eaaf89aa09b57f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?P=C5=99emek=20Vysok=C3=BD?= Date: Wed, 10 Jan 2024 10:45:00 +0100 Subject: [PATCH] [release/8.0.1xx] Move VMR component list into `Components.md` (#18061) --- .config/dotnet-tools.json | 2 +- eng/Version.Details.xml | 8 ++++---- eng/Versions.props | 2 +- .../templates/steps/vmr-pull-updates.yml | 2 +- eng/vmr-sync.sh | 14 +++++++------- .../content/README.md} | 12 +----------- src/VirtualMonoRepo/Component.template.md | 15 +++++++++++++++ src/VirtualMonoRepo/InitializeVMR.proj | 2 +- .../Tasks/VirtualMonoRepo_Initialize.cs | 4 ++-- 9 files changed, 33 insertions(+), 28 deletions(-) rename src/{VirtualMonoRepo/README.template.md => SourceBuild/content/README.md} (94%) create mode 100644 src/VirtualMonoRepo/Component.template.md diff --git a/.config/dotnet-tools.json b/.config/dotnet-tools.json index 9394fd31e..b8aebb8b0 100644 --- a/.config/dotnet-tools.json +++ b/.config/dotnet-tools.json @@ -3,7 +3,7 @@ "isRoot": true, "tools": { "microsoft.dotnet.darc": { - "version": "1.1.0-beta.23578.2", + "version": "1.1.0-beta.23621.3", "commands": [ "darc" ] diff --git a/eng/Version.Details.xml b/eng/Version.Details.xml index bd4df2042..c62315654 100644 --- a/eng/Version.Details.xml +++ b/eng/Version.Details.xml @@ -227,13 +227,13 @@ https://github.com/dotnet/arcade 0aaeafef60933f87b0b50350313bb2fd77defb5d - + https://github.com/dotnet/arcade-services - 5263b603d90991a0c200aca8b8892c3d7cfe4751 + 702f946f89ace6197fdca2ac309d32187c4bc1bd - + https://github.com/dotnet/arcade-services - 5263b603d90991a0c200aca8b8892c3d7cfe4751 + 702f946f89ace6197fdca2ac309d32187c4bc1bd https://github.com/dotnet/runtime diff --git a/eng/Versions.props b/eng/Versions.props index 625530b63..4b17a6b0d 100644 --- a/eng/Versions.props +++ b/eng/Versions.props @@ -44,7 +44,7 @@ - 1.1.0-beta.23578.2 + 1.1.0-beta.23621.3 diff --git a/eng/pipelines/templates/steps/vmr-pull-updates.yml b/eng/pipelines/templates/steps/vmr-pull-updates.yml index debe748e6..ceeb1981a 100644 --- a/eng/pipelines/templates/steps/vmr-pull-updates.yml +++ b/eng/pipelines/templates/steps/vmr-pull-updates.yml @@ -44,7 +44,7 @@ steps: --repository "installer:${{ parameters.targetRef }}" --recursive --remote "installer:$(pwd)" - --readme-template $(Agent.BuildDirectory)/installer/src/VirtualMonoRepo/README.template.md + --component-template $(Agent.BuildDirectory)/installer/src/VirtualMonoRepo/Component.template.md --tpn-template $(Agent.BuildDirectory)/installer/src/VirtualMonoRepo/THIRD-PARTY-NOTICES.template.txt --debug displayName: Synchronize dotnet/dotnet diff --git a/eng/vmr-sync.sh b/eng/vmr-sync.sh index db0f704e2..92f34d690 100755 --- a/eng/vmr-sync.sh +++ b/eng/vmr-sync.sh @@ -33,10 +33,10 @@ ### --debug ### Optional. Turns on the most verbose logging for the VMR tooling ### -### --readme-template -### Optional. Template for VMRs README.md used for regenerating the file to list the newest versions of +### --component-template +### Optional. Template for VMRs Component.md used for regenerating the file to list the newest versions of ### components. -### Defaults to src/VirtualMonoRepo/README.template.md +### Defaults to src/VirtualMonoRepo/Component.template.md ### ### --recursive ### Optional. Recursively synchronize all the source build dependencies (declared in Version.Details.xml) @@ -103,7 +103,7 @@ repository='' additional_remotes='' recursive=false verbosity=verbose -readme_template="$installer_dir/src/VirtualMonoRepo/README.template.md" +readme_template="$installer_dir/src/VirtualMonoRepo/Component.template.md" tpn_template="$installer_dir/src/VirtualMonoRepo/THIRD-PARTY-NOTICES.template.txt" azdev_pat='' @@ -138,8 +138,8 @@ while [[ $# -gt 0 ]]; do additional_remotes="$additional_remotes $2" shift ;; - --readme-template) - readme_template=$2 + --component-template) + component_template=$2 shift ;; --tpn-template) @@ -266,7 +266,7 @@ fi --$verbosity \ $recursive_arg \ $additional_remotes \ - --readme-template "$readme_template" \ + --component-template "$component_template" \ --tpn-template "$tpn_template" \ "$repository" diff --git a/src/VirtualMonoRepo/README.template.md b/src/SourceBuild/content/README.md similarity index 94% rename from src/VirtualMonoRepo/README.template.md rename to src/SourceBuild/content/README.md index f23b92645..c83ad9a6d 100644 --- a/src/VirtualMonoRepo/README.template.md +++ b/src/SourceBuild/content/README.md @@ -152,17 +152,7 @@ To do this, you can start a [dotnet/dotnet](https://github.com/dotnet/dotnet) Co ## List of components -To enable full offline source-building of the VMR, we have no other choice than to synchronize all the necessary code into the VMR. This also includes any code referenced via git submodules. More details on why and how this is done can be found here: -- [Strategy for managing external source dependencies](src/arcade/Documentation/UnifiedBuild/VMR-Strategy-For-External-Source.md) -- [Source Synchronization Process](src/arcade/Documentation/UnifiedBuild/VMR-Design-And-Operation.md#source-synchronization-process) - -### Detailed list - - - -> Auto-generated list of components will go here - - +The full list of components synchronized into the VMR is [here (Components.md)](./Components.md). The repository also contains a [JSON manifest](https://github.com/dotnet/dotnet/blob/main/src/source-manifest.json) listing all components in a machine-readable format. diff --git a/src/VirtualMonoRepo/Component.template.md b/src/VirtualMonoRepo/Component.template.md new file mode 100644 index 000000000..27b0f7893 --- /dev/null +++ b/src/VirtualMonoRepo/Component.template.md @@ -0,0 +1,15 @@ +# List of components + +To enable full offline source-building of the VMR, we have no other choice than to synchronize all the necessary code into the VMR. This also includes any code referenced via git submodules. More details on why and how this is done can be found here: +- [Strategy for managing external source dependencies](src/arcade/Documentation/UnifiedBuild/VMR-Strategy-For-External-Source.md) +- [Source Synchronization Process](src/arcade/Documentation/UnifiedBuild/VMR-Design-And-Operation.md#source-synchronization-process) + +## Detailed list + + + +> Auto-generated list of components will go here + + + +The repository also contains a [JSON manifest](https://github.com/dotnet/dotnet/blob/main/src/source-manifest.json) listing all components in a machine-readable format. diff --git a/src/VirtualMonoRepo/InitializeVMR.proj b/src/VirtualMonoRepo/InitializeVMR.proj index 09ab72b1c..e3d98fc3c 100644 --- a/src/VirtualMonoRepo/InitializeVMR.proj +++ b/src/VirtualMonoRepo/InitializeVMR.proj @@ -58,7 +58,7 @@ VmrPath="$(VmrDir)" TmpPath="$(TmpDir)" InstallerPath="$(RepoRoot)" - ReadmeTemplatePath="$(MSBuildThisFileDirectory)/README.template.md" + ComponentTemplatePath="$(MSBuildThisFileDirectory)/Component.template.md" TpnTemplatePath="$(MSBuildThisFileDirectory)/THIRD-PARTY-NOTICES.template.txt" SourceMappingsPath="$(MSBuildThisFileDirectory)/source-mappings.json" /> diff --git a/src/VirtualMonoRepo/Tasks/VirtualMonoRepo_Initialize.cs b/src/VirtualMonoRepo/Tasks/VirtualMonoRepo_Initialize.cs index 2a8c1d726..5ab294231 100644 --- a/src/VirtualMonoRepo/Tasks/VirtualMonoRepo_Initialize.cs +++ b/src/VirtualMonoRepo/Tasks/VirtualMonoRepo_Initialize.cs @@ -42,7 +42,7 @@ public class VirtualMonoRepo_Initialize : Build.Utilities.Task, ICancelableTask public string InstallerPath { get; set; } - public string ReadmeTemplatePath { get; set; } + public string ComponentTemplatePath { get; set; } public string TpnTemplatePath { get; set; } @@ -72,7 +72,7 @@ public class VirtualMonoRepo_Initialize : Build.Utilities.Task, ICancelableTask Recursive, new NativePath(SourceMappingsPath), additionalRemotes, - ReadmeTemplatePath, + ComponentTemplatePath, TpnTemplatePath, generateCodeowners: false, discardPatches: true,