Basilisque.CommonFrameworkBuild 1.0.0-RC15

This is a prerelease version of Basilisque.CommonFrameworkBuild.

Requires NuGet 4.0 or higher.

dotnet add package Basilisque.CommonFrameworkBuild --version 1.0.0-RC15                
NuGet\Install-Package Basilisque.CommonFrameworkBuild -Version 1.0.0-RC15                
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Basilisque.CommonFrameworkBuild" Version="1.0.0-RC15">
  <PrivateAssets>all</PrivateAssets>
  <IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
</PackageReference>                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Basilisque.CommonFrameworkBuild --version 1.0.0-RC15                
#r "nuget: Basilisque.CommonFrameworkBuild, 1.0.0-RC15"                
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install Basilisque.CommonFrameworkBuild as a Cake Addin
#addin nuget:?package=Basilisque.CommonFrameworkBuild&version=1.0.0-RC15&prerelease

// Install Basilisque.CommonFrameworkBuild as a Cake Tool
#tool nuget:?package=Basilisque.CommonFrameworkBuild&version=1.0.0-RC15&prerelease                

Basilisque - Common Framework Build

Overview

NuGet License
This project provides common build configuration for all parts of the Basilisque framework.
It is NOT recommended to use this unless you're developing a part of the framework.

Description

This project doesn't contain any assemblies that will be deployed with the target project. Instead it only contains build time configuration (.props/.targets-files, ...) to provide all projects of the Basilisque framework with a common basic set of configuration.
It implicitly adds a dependency to Basilisque.CommonBuild to the target project. So the configuration provided by that project will also be applied.

Usage

Install the NuGet package
This will automatically include the contained .props and .targets files in the build.

Provided Configuration

.props / .targets

  • <a name="generalConfig"></a>General (for all project types) | Property | Value | Remark | |-------------- |---------------------------- | --------------------------------------------------------------------------------------------- | | RootNamespace | Basilisque.<ProjectName> | Spaces will be replaced by an underscore | | AssemblyName | Basilisque.<ProjectName> | not for .Benchmarks-projects because of https://github.com/dotnet/BenchmarkDotNet/issues/498 | | PackageId | <AssemblyName> | will only be set when the AssemblyName is also being set (currently not working for ProjectReferences due to https://github.com/NuGet/Home/issues/12544) | | Authors | Alexander Stärk | | | PackageReleaseNotes | <PackageProjectUrl>/releases | will only be set when the PackageProjectUrl starts with https://github.com | | PackageLicenseExpression | Apache-2.0 | | | PackageRequireLicenseAcceptance | true | |

If you don't want a specific property to be set, you can prevent it. For every property there is a corresponding flag that controls, if the property will be set or not.
The flags are named BAS_CFB_Set_<PropertyName>.
For example if you don't want the RootNamespace to be set, add this to your project:

<PropertyGroup>
  <BAS_CFB_Set_RootNamespace>false</BAS_CFB_Set_RootNamespace>
</PropertyGroup>

Logging

If you want to log the properties, that are set by this project, you can set the property BAS_CFB_Log_Properties to true. This will log the current value of all these properties after the PrepareForBuild target.

<PropertyGroup>
  <BAS_CFB_Log_Properties>true</BAS_CFB_Log_Properties>
</PropertyGroup>

License

The Basilisque framework (including this repository) is licensed under the Apache License, Version 2.0.

There are no supported framework assets in this package.

Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.0.0-RC15 109 6/12/2024