Skip to content

Latest commit

 

History

History
195 lines (105 loc) · 3.74 KB

BUILDING.md

File metadata and controls

195 lines (105 loc) · 3.74 KB

Building

Prerequisites

Before building the libraries and samples in this repository, you will need to install .NET Core and the Cake .NET Core Tool:

dotnet tool install -g cake.tool
dotnet tool install -g xamarin.androidbinderator.tool
dotnet tool install -g xamarin.androidx.migration.tool

NOTE: If you previously installed any of these tools, be sure to update them to the latest versions.

For API diffs install api-tools

dotnet tool install -g api-tools

Compiling

You can now build all the packages by running:

dotnet cake

If you are going to make changes to the config.json, then you can run the packages target to re-generate all the necessary files:

dotnet cake --target=packages

Advanced scenarios

Simple build (ci build done on CI Azure DevOps servers):

dotnet cake -t=ci

Clean ci build followed by nuget API diff and then several utility tqrgets:

On MacOSX (and Linux):

dotnet cake -t=clean && dotnet cake -t=ci && dotnet cake nuget-diff.cake && dotnet cake utilities.cake

Build (build.cake)

  • inject-variables

  • check-tools

  • tools-update

  • javadocs

    Prepares javadocs for parameter names.
    
  • binderate

    Runs binderator on config.json data.

  • binderate-config-verify

    Verifies versions in config.json

  • binderate-diff

    Runs diff to see details of the update.

  • binderate-fix

  • binderate-nuget-check

  • metadata-verify

  • libs

    Builds projects (assemblies - libraries - libs)

  • libs-native

    Builds native maven projects with gradle.

  • nuget

    Generates (packaging) NuGet packages for projects.

  • all-packages-tests

    Runs 'AllPackagesTests' test suite without first building packages.

  • build-run-all-packages-tests

    Builds NuGet packages first and then runs 'AllPackagesTests' test suite.

  • api-diff

  • diff

  • clean

    Cleans folders and files.

  • packages

  • full-run

  • ci

    Builds projects on CI (libs, nuget, samples).

  • update-config

    Updates config.json to the latest versions found in Maven.

  • bump-config

    Increments the NuGet patch version of all packages in config.json.

  • sort-config

    Sorts config.json file using the canonical sort.

  • published-config

    Shows which NuGet package versions in config.json have been published to NuGet.org.

Nuget API diff (nuget-diff.cake)

Utilities (utilities.cake)

  • generate-component-governance

    Generates Components Governance cgmanifest.json

  • mappings-artifact-nuget

    Generates mapping maven artifacts to nuget packages.

  • list-artifacts

    Generate list of the maven artifacts and its nuget package.

  • spell-check

    Spell checks namespaces and nuget packages.

  • namespace-check

    Verifies namespaces (names and casing)

  • binderate-diff

    Runs diff to see details of the update.

  • target-sdk-version-check

    Verification of TFMs.

  • api-diff-markdown-info-pr

    Generates Markdown about update info for PRs (weekly stable updates)

  • api-diff-analysis

    Generates Markdown about update info for PRs (weekly stable updates)

  • nuget-structure-analysis

    Unpacks nuget packages, so the structure can be verified.

  • read-analysis-files

    Opens analysis files (API diff, spell checking, etc) VS Code required.

  • generate-markdown-publish-log

    Generates MarkDown based on CI NuGet publish log.

  • dependencies

    WIP: dependency trees generation (Maven and Nuget)

  • generate-namespace-file

  • verify-namespace-file

  • Default

    Default target - ci