From 9cfe1c1fb5eb2fde09bc8ebd4e3e8c0b773fc19e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?P=C5=99emek=20Vysok=C3=BD?= Date: Wed, 27 Sep 2023 15:28:10 +0200 Subject: [PATCH] [release/8.0.1xx] Add instructions on synchronizing the VMR (#17424) --- src/VirtualMonoRepo/README.template.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/src/VirtualMonoRepo/README.template.md b/src/VirtualMonoRepo/README.template.md index 7e85a0467..f23b92645 100644 --- a/src/VirtualMonoRepo/README.template.md +++ b/src/VirtualMonoRepo/README.template.md @@ -144,6 +144,12 @@ Usually, this means the [dotnet/dotnet repository](https://github.com/dotnet/dot In practice, this means that when calling the main build script, you need to provide additional arguments when building outside of a context of a git repository. Alternatively, you can also provide a manifest file where this information can be read from. This file (`release.json`) can be found attached with the [dotnet/dotnet release](https://github.com/dotnet/dotnet/releases). +### Synchronizing code into the VMR + +Sometimes you want to make a change in a repository and test that change in the VMR. You could of course make the change in the VMR directly (locally, as the VMR is read-only for now) but in case it's already available in your repository, you can synchronize it into the VMR (again locally). + +To do this, you can start a [dotnet/dotnet](https://github.com/dotnet/dotnet) Codespace. You will see instructions right when the Codespace starts. Alternatively, you can clone the repository locally and use the `[eng/vmr-sync.sh](../../eng/vmr-sync.sh)` script to do that. Please refer to the documentation in the script for more details. + ## 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: