8000 GitHub - dibarbet/source-build-externals: This repo contains the source that resides outside of the dotnet organization required to build .NET from source.
[go: up one dir, main page]

Skip to content

This repo contains the source that resides outside of the dotnet organization required to build .NET from source.

License

Notifications You must be signed in to change notification settings

dibarbet/source-build-externals

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

.NET Source Build Externals

This repo contains the source for components that resides outside of the dotnet organization required to build .NET from source. Examples include Newtonsoft.Json and Application Insights for .NET. Git submodules are utilized to reference the external source. This repo contains the infrastructure to build these external repos within the .NET source build. See dotnet/source-build for more details on .NET source build.

How to Build

This repo utilizes the .NET Arcade build infrastructure. Since this repo is intended solely for source build, it usually makes sense to build with the -sb (source build) flag.

./build.sh -sb

Adding a New External Component

  1. Add the repo as a submodule to ./src

    git submodule add <remote_url> ./src/<destination_dir>
    git commit -m "<commit_message>"
  2. Define a project for the new component. The project is responsible for building the submodule with the appropriate configuration for source build. See the existing projects for examples.

  3. Build locally and resolve any build errors. Source changes must be applied via patches. See below for more info on patches.

  4. Validate the version of the NuGet packages and binaries produced by the build. See the contents of ./artifacts/packages/<build_configuration>/NonShipping/Microsoft.SourceBuild.Intermediate.source-build-externals.x.y.z-dev.nupkg.

  5. If the original binaries have strong name signatures, validate the source built ones have them as well.

Updating an External Component to a Newer Version

  1. Update the src/<external_repo_dir> to the desired sha

    cd src/<external_repo_dir>
    git fetch
    git checkout <updated_sha>
    cd ..
    git add .
    git commit -m "<commit_message>"
  2. Build locally

    1. Update any patches as needed.

    2. Review the repo's project to ensure it is appropriate for the new version. There are a number of projects that utilize MSBuild properties to specify the version. These need to be manually updated with each upgrade.

    3. Resolve build errors. Source changes must be applied via patches. See below for more info on patches.

  3. Validate the version of the NuGet packages and binaries produced by the build. See the contents of ./artifacts/packages/<build_configuration>/NonShipping/Microsoft.SourceBuild.Intermediate.source-build-externals.x.y.z-dev.nupkg

Patches

When creating/updating patches, it is desirable to backport the changes whenever feasible as this reduces the maintenance burden when updating a component to a newer version.

Found an Issue?

Source build related issues are tracked in the source build repo.

License

This repo is licensed under the MIT license.

About

This repo contains the source that resides outside of the dotnet organization required to build .NET from source.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • PowerShell 55.0%
  • Shell 40.4%
  • CMake 4.5%
  • Batchfile 0.1%
0