commit 03a1b62cb38cf6a60c496c896dbdccd4e4d9b03a · pyrox.dev/nixpkgs

+1 -1

doc/languages-frameworks/dotnet.section.md

···

71

72

To package Dotnet applications, you can use `buildDotnetModule`. This has similar arguments to `stdenv.mkDerivation`, with the following additions:

73

74
-
* `projectFile` has to be used for specifying the dotnet project file relative to the source root. These usually have `.sln` or `.csproj` file extensions. This can be an array of multiple projects as well.

75

* `nugetDeps` takes either a path to a `deps.nix` file, or a derivation. The `deps.nix` file can be generated using the script attached to `passthru.fetch-deps`. This file can also be generated manually using `nuget-to-nix` tool, which is available in nixpkgs. If the argument is a derivation, it will be used directly and assume it has the same output as `mkNugetDeps`.

76

* `packNupkg` is used to pack project as a `nupkg`, and installs it to `$out/share`. If set to `true`, the derivation can be used as a dependency for another dotnet project by adding it to `projectReferences`.

77

* `projectReferences` can be used to resolve `ProjectReference` project items. Referenced projects can be packed with `buildDotnetModule` by setting the `packNupkg = true` attribute and passing a list of derivations to `projectReferences`. Since we are sharing referenced projects as NuGets they must be added to csproj/fsproj files as `PackageReference` as well.

···

71

72

To package Dotnet applications, you can use `buildDotnetModule`. This has similar arguments to `stdenv.mkDerivation`, with the following additions:

73

74
+
* `projectFile` is used for specifying the dotnet project file relative to the source root. These usually have `.sln` or `.csproj` file extensions. This can be an array of multiple projects as well.

75

* `nugetDeps` takes either a path to a `deps.nix` file, or a derivation. The `deps.nix` file can be generated using the script attached to `passthru.fetch-deps`. This file can also be generated manually using `nuget-to-nix` tool, which is available in nixpkgs. If the argument is a derivation, it will be used directly and assume it has the same output as `mkNugetDeps`.

76

* `packNupkg` is used to pack project as a `nupkg`, and installs it to `$out/share`. If set to `true`, the derivation can be used as a dependency for another dotnet project by adding it to `projectReferences`.

77

* `projectReferences` can be used to resolve `ProjectReference` project items. Referenced projects can be packed with `buildDotnetModule` by setting the `packNupkg = true` attribute and passing a list of derivations to `projectReferences`. Since we are sharing referenced projects as NuGets they must be added to csproj/fsproj files as `PackageReference` as well.

+21 -12

pkgs/build-support/dotnet/build-dotnet-module/default.nix

···

       82
        
       , ...

     

       83
        
       } @ args:

     

       84
        
       

     

       85
       -
       assert projectFile == null -> throw "Defining the `projectFile` attribute is required. This is usually an `.csproj`, or `.sln` file.";

     

       86
       -
       

     

       87
        
       # TODO: Automatically generate a dependency file when a lockfile is present.

     

       88
        
       # This file is unfortunately almost never present, as Microsoft recommands not to push this in upstream repositories.

     

       89
        
       assert nugetDeps == null -> throw "Defining the `nugetDeps` attribute is required, as to lock the NuGet dependencies. This file can be generated by running the `passthru.fetch-deps` script.";

     
···

       159
        
               # Because this list is rather long its put in its own store path to maintain readability of the generated script

     

       160
        
               exclusions = writeText "nuget-package-exclusions" (lib.concatStringsSep "\n" (dotnet-sdk.passthru.packages { fetchNuGet = attrs: attrs.pname; }));

     

       161
        
       

     

       162
       -
               runtimeIds = map (system: dotnet-sdk.systemToDotnetRid system) (args.meta.platforms or dotnet-sdk.meta.platforms);

     

       163
       -
       

     

       164
        
               # Derivations may set flags such as `--runtime <rid>` based on the host platform to avoid restoring/building nuget dependencies they dont have or dont need.

     

       165
        
               # This introduces an issue; In this script we loop over all platforms from `meta` and add the RID flag for it, as to fetch all required dependencies.

     

       166
        
               # The script would inherit the RID flag from the derivation based on the platform building the script, and set the flag for any iteration we do over the RIDs.

     
···

       171
        
                 in

     

       172
        
                 builtins.filter (flag: !(hasRid flag)) (dotnetFlags ++ dotnetRestoreFlags);

     

       173
        
       

     

       0
        
       
     

       174
        
             in

     

       175
        
             writeShellScript "fetch-${pname}-deps" ''

     

       176
        
               set -euo pipefail

     
···

       202
        
               export DOTNET_NOLOGO=1

     

       203
        
               export DOTNET_CLI_TELEMETRY_OPTOUT=1

     

       204
        
       

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       205
        
               for rid in "${lib.concatStringsSep "\" \"" runtimeIds}"; do

     

       206
       -
                   for project in "${lib.concatStringsSep "\" \"" ((lib.toList projectFile) ++ lib.optionals (testProjectFile != "") (lib.toList testProjectFile))}"; do

     

       207
       -
                       dotnet restore "$project" \

     

       208
       -
                           -p:ContinuousIntegrationBuild=true \

     

       209
       -
                           -p:Deterministic=true \

     

       210
       -
                           --packages "$HOME/nuget_pkgs" \

     

       211
       -
                           --runtime "$rid" \

     

       212
       -
                           ${lib.optionalString (!enableParallelBuilding) "--disable-parallel"} \

     

       213
       -
                           ${lib.optionalString (flags != []) (toString flags)}

     

       214
        
                   done

     

       215
        
               done

     

       216

···

       82
        
       , ...

     

       83
        
       } @ args:

     

       84
        
       

     

       0
        
       
     

       0
        
       
     

       85
        
       # TODO: Automatically generate a dependency file when a lockfile is present.

     

       86
        
       # This file is unfortunately almost never present, as Microsoft recommands not to push this in upstream repositories.

     

       87
        
       assert nugetDeps == null -> throw "Defining the `nugetDeps` attribute is required, as to lock the NuGet dependencies. This file can be generated by running the `passthru.fetch-deps` script.";

     
···

       157
        
               # Because this list is rather long its put in its own store path to maintain readability of the generated script

     

       158
        
               exclusions = writeText "nuget-package-exclusions" (lib.concatStringsSep "\n" (dotnet-sdk.passthru.packages { fetchNuGet = attrs: attrs.pname; }));

     

       159
        
       

     

       0
        
       
     

       0
        
       
     

       160
        
               # Derivations may set flags such as `--runtime <rid>` based on the host platform to avoid restoring/building nuget dependencies they dont have or dont need.

     

       161
        
               # This introduces an issue; In this script we loop over all platforms from `meta` and add the RID flag for it, as to fetch all required dependencies.

     

       162
        
               # The script would inherit the RID flag from the derivation based on the platform building the script, and set the flag for any iteration we do over the RIDs.

     
···

       167
        
                 in

     

       168
        
                 builtins.filter (flag: !(hasRid flag)) (dotnetFlags ++ dotnetRestoreFlags);

     

       169
        
       

     

       170
       +
               runtimeIds = map (system: dotnet-sdk.systemToDotnetRid system) (args.meta.platforms or dotnet-sdk.meta.platforms);

     

       171
        
             in

     

       172
        
             writeShellScript "fetch-${pname}-deps" ''

     

       173
        
               set -euo pipefail

     
···

       199
        
               export DOTNET_NOLOGO=1

     

       200
        
               export DOTNET_CLI_TELEMETRY_OPTOUT=1

     

       201
        
       

     

       202
       +
               declare -a projectFiles=( ${toString (lib.toList projectFile)} )

     

       203
       +
               declare -a testProjectFiles=( ${toString (lib.toList testProjectFile)} )

     

       204
       +
       

     

       205
       +
               dotnetRestore() {

     

       206
       +
                   local -r project="''${1-}"

     

       207
       +
                   local -r rid="''${2-}"

     

       208
       +
       

     

       209
       +
                   dotnet restore ''${project-} \

     

       210
       +
                       -p:ContinuousIntegrationBuild=true \

     

       211
       +
                       -p:Deterministic=true \

     

       212
       +
                       --packages "$HOME/nuget_pkgs" \

     

       213
       +
                       --runtime "$rid" \

     

       214
       +
                       ${lib.optionalString (!enableParallelBuilding) "--disable-parallel"} \

     

       215
       +
                       ${lib.optionalString (flags != []) (toString flags)}

     

       216
       +
               }

     

       217
       +
       

     

       218
        
               for rid in "${lib.concatStringsSep "\" \"" runtimeIds}"; do

     

       219
       +
                   (( ''${#projectFiles[@]} == 0 )) && dotnetRestore "" "$rid"

     

       220
       +
       

     

       221
       +
                   for project in ''${projectFiles[@]-} ''${testProjectFiles[@]-}; do

     

       222
       +
                       dotnetRestore "$project" "$rid"

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       223
        
                   done

     

       224
        
               done

     

       225

+18 -12

pkgs/build-support/dotnet/build-dotnet-module/hooks/dotnet-build-hook.sh

···

       24
        
               local -r versionFlag="-p:Version=${version-}"

     

       25
        
           fi

     

       26
        
       

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       27
        
           for project in ${projectFile[@]} ${testProjectFile[@]-}; do

     

       28
       -
               env \

     

       29
       -
                   dotnet build "$project" \

     

       30
       -
                       -maxcpucount:$maxCpuFlag \

     

       31
       -
                       -p:BuildInParallel=$parallelBuildFlag \

     

       32
       -
                       -p:ContinuousIntegrationBuild=true \

     

       33
       -
                       -p:Deterministic=true \

     

       34
       -
                       -p:UseAppHost=true \

     

       35
       -
                       --configuration "@buildType@" \

     

       36
       -
                       --no-restore \

     

       37
       -
                       ${versionFlag-} \

     

       38
       -
                       ${dotnetBuildFlags[@]}  \

     

       39
       -
                       ${dotnetFlags[@]}

     

       40
        
           done

     

       41
        
       

     

       42
        
           runHook postBuild

···

       24
        
               local -r versionFlag="-p:Version=${version-}"

     

       25
        
           fi

     

       26
        
       

     

       27
       +
           dotnetBuild() {

     

       28
       +
               local -r project="${1-}"

     

       29
       +
               env dotnet build ${project-} \

     

       30
       +
                   -maxcpucount:$maxCpuFlag \

     

       31
       +
                   -p:BuildInParallel=$parallelBuildFlag \

     

       32
       +
                   -p:ContinuousIntegrationBuild=true \

     

       33
       +
                   -p:Deterministic=true \

     

       34
       +
                   -p:UseAppHost=true \

     

       35
       +
                   --configuration "@buildType@" \

     

       36
       +
                   --no-restore \

     

       37
       +
                   ${versionFlag-} \

     

       38
       +
                   ${dotnetBuildFlags[@]}  \

     

       39
       +
                   ${dotnetFlags[@]}

     

       40
       +
           }

     

       41
       +
       

     

       42
       +
           (( "${#projectFile[@]}" == 0 )) && dotnetBuild

     

       43
       +
       

     

       44
        
           for project in ${projectFile[@]} ${testProjectFile[@]-}; do

     

       45
       +
               dotnetBuild "$project"

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       46
        
           done

     

       47
        
       

     

       48
        
           runHook postBuild

+14 -8

pkgs/build-support/dotnet/build-dotnet-module/hooks/dotnet-configure-hook.sh

···

       13
        
               local -r parallelFlag="--disable-parallel"

     

       14
        
           fi

     

       15
        
       

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       16
        
           for project in ${projectFile[@]} ${testProjectFile[@]-}; do

     

       17
       -
               env \

     

       18
       -
                   dotnet restore "$project" \

     

       19
       -
                       -p:ContinuousIntegrationBuild=true \

     

       20
       -
                       -p:Deterministic=true \

     

       21
       -
                       --source "@nugetSource@/lib" \

     

       22
       -
                       ${parallelFlag-} \

     

       23
       -
                       ${dotnetRestoreFlags[@]} \

     

       24
       -
                       ${dotnetFlags[@]}

     

       25
        
           done

     

       26
        
       

     

       27
        
           runHook postConfigure

···

       13
        
               local -r parallelFlag="--disable-parallel"

     

       14
        
           fi

     

       15
        
       

     

       16
       +
           dotnetRestore() {

     

       17
       +
               local -r project="${1-}"

     

       18
       +
               env dotnet restore ${project-} \

     

       19
       +
                   -p:ContinuousIntegrationBuild=true \

     

       20
       +
                   -p:Deterministic=true \

     

       21
       +
                   --source "@nugetSource@/lib" \

     

       22
       +
                   ${parallelFlag-} \

     

       23
       +
                   ${dotnetRestoreFlags[@]} \

     

       24
       +
                   ${dotnetFlags[@]}

     

       25
       +
           }

     

       26
       +
       

     

       27
       +
           (( "${#projectFile[@]}" == 0 )) && dotnetRestore

     

       28
       +
       

     

       29
        
           for project in ${projectFile[@]} ${testProjectFile[@]-}; do

     

       30
       +
               dotnetRestore "$project"

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       31
        
           done

     

       32
        
       

     

       33
        
           runHook postConfigure

+38 -22

pkgs/build-support/dotnet/build-dotnet-module/hooks/dotnet-install-hook.sh

···

       12
        
               dotnetInstallFlags+=("--no-self-contained")

     

       13
        
           fi

     

       14
        
       

     

       15
       -
           for project in ${projectFile[@]}; do

     

       16
       -
               env \

     

       17
       -
                   dotnet publish "$project" \

     

       18
       -
                       -p:ContinuousIntegrationBuild=true \

     

       19
       -
                       -p:Deterministic=true \

     

       20
       -
                       -p:UseAppHost=true \

     

       21
       -
                       --output "$out/lib/${pname}" \

     

       22
       -
                       --configuration "@buildType@" \

     

       23
       -
                       --no-build \

     

       24
       -
                       ${dotnetInstallFlags[@]}  \

     

       25
       -
                       ${dotnetFlags[@]}

     

       26
       -
           done

     

       27
        
       

     

       28
       -
           if [[ "${packNupkg-}" ]]; then

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       29
        
               for project in ${projectFile[@]}; do

     

       30
       -
                   env \

     

       31
       -
                       dotnet pack "$project" \

     

       32
       -
                           -p:ContinuousIntegrationBuild=true \

     

       33
       -
                           -p:Deterministic=true \

     

       34
       -
                           --output "$out/share" \

     

       35
       -
                           --configuration "@buildType@" \

     

       36
       -
                           --no-build \

     

       37
       -
                           ${dotnetPackFlags[@]}  \

     

       38
       -
                           ${dotnetFlags[@]}

     

       39
        
               done

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       40
        
           fi

     

       41
        
       

     

       42
        
           runHook postInstall

···

       12
        
               dotnetInstallFlags+=("--no-self-contained")

     

       13
        
           fi

     

       14
        
       

     

       15
       +
           dotnetPublish() {

     

       16
       +
               local -r project="${1-}"

     

       17
       +
               env dotnet publish ${project-} \

     

       18
       +
                   -p:ContinuousIntegrationBuild=true \

     

       19
       +
                   -p:Deterministic=true \

     

       20
       +
                   -p:UseAppHost=true \

     

       21
       +
                   --output "$out/lib/${pname}" \

     

       22
       +
                   --configuration "@buildType@" \

     

       23
       +
                   --no-build \

     

       24
       +
                   ${dotnetInstallFlags[@]}  \

     

       25
       +
                   ${dotnetFlags[@]}

     

       26
       +
           }

     

       27
        
       

     

       28
       +
           dotnetPack() {

     

       29
       +
               local -r project="${1-}"

     

       30
       +
                env dotnet pack ${project-} \

     

       31
       +
                    -p:ContinuousIntegrationBuild=true \

     

       32
       +
                    -p:Deterministic=true \

     

       33
       +
                    --output "$out/share" \

     

       34
       +
                    --configuration "@buildType@" \

     

       35
       +
                    --no-build \

     

       36
       +
                    ${dotnetPackFlags[@]}  \

     

       37
       +
                    ${dotnetFlags[@]}

     

       38
       +
           }

     

       39
       +
       

     

       40
       +
           if (( "${#projectFile[@]}" == 0 )); then

     

       41
       +
               dotnetPublish

     

       42
       +
           else

     

       43
        
               for project in ${projectFile[@]}; do

     

       44
       +
                   dotnetPublish "$project"

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       45
        
               done

     

       46
       +
           fi

     

       47
       +
       

     

       48
       +
           if [[ "${packNupkg-}" ]]; then

     

       49
       +
               if (( "${#projectFile[@]}" == 0 )); then

     

       50
       +
                   dotnetPack

     

       51
       +
               else

     

       52
       +
                   for project in ${projectFile[@]}; do

     

       53
       +
                       dotnetPack "$project"

     

       54
       +
                   done

     

       55
       +
               fi

     

       56
        
           fi

     

       57
        
       

     

       58
        
           runHook postInstall