Belp.Build.Packinf
0.2.0
See the version list below for details.
dotnet add package Belp.Build.Packinf --version 0.2.0
NuGet\Install-Package Belp.Build.Packinf -Version 0.2.0
<PackageReference Include="Belp.Build.Packinf" Version="0.2.0"> <PrivateAssets>all</PrivateAssets> <IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets> </PackageReference>
paket add Belp.Build.Packinf --version 0.2.0
#r "nuget: Belp.Build.Packinf, 0.2.0"
// Install Belp.Build.Packinf as a Cake Addin #addin nuget:?package=Belp.Build.Packinf&version=0.2.0 // Install Belp.Build.Packinf as a Cake Tool #tool nuget:?package=Belp.Build.Packinf&version=0.2.0
Belp.Build.Packinf
An MSBuild extension that makes it easier to create and maintain NuGet packages.
Installation
Requirements
- A project written in SDK-style. This includes any project for .NET Core(or newer) or .NET 5(or newer).
Install using an Editor
- Locate the project file(for example,
Project.csproj
,Project.fsproj
). - Open the project file in an editor.
- Locate the an
<ItemGroup>
. - Add a new
PackageReference
element to the item group with theInclude
attribute set toBelp.Build.Packinf
and theVersion
attribute set to0.0.1
. For example,<PackageReference Include="Belp.Build.Packinf" Version="0.0.1" />
. - Run
dotnet restore
.
Uninstallation
- Locate the project file(for example,
Project.csproj
,Project.fsproj
). - Open the project file in an editor.
- Locate the
PackageReference
element with anInclude
attribute set toBelp.Build.Packinf
. - Delete the element.
Install using the .NET CLI
- Open a terminal.
- Navigate to the containing directory of the project file.
- Run the command
dotnet add package Belp.Build.Packinf
.
Uninstallation
- Open a terminal.
- Navigate to the containing directory of the project file.
- Run the command
dotnet remove package Belp.Build.Packinf
.
Install using Visual Studio Package Manager
- Open Visual Studio.
- Right click the project in the Solution Explorer.
- Click on "Manage NuGet Packages".
- Go to the "Browse" tab.
- Search for
Belp.Build.Packinf
. - Install.
Uninstallation
- Open Visual Studio.
- Right click the project in the Solution Explorer.
- Click on "Manage NuGet Packages".
- Go to the "Installed" tab.
- Click on
Belp.Build.Packinf
. - Click on "Uninstall".
Usage
_Package
files
Files that are named _Package
will be automatically renamed to $(PackageId)
when packed. For example, if $(PackageId)
is Belp.Build.XYZ
and a file is named _Package.txt
, it will be packed as Belp.Build.XYZ.txt
. This feature makes it easier for forks to edit and maintain files that are required to be named in that manner.
Assets/
folder
By default, all files inside Assets/
will be packed. This behavior can be disabled by setting $(EnableDefaultPackItems)
to false.
README file
Files that are named README
(case-insensitive) and are placed beside the project will be packed as the package's README file. If no READMEs are present beside the project, and SourceLink is installed in the project, the file named README.md
at the repository's root(if present) will be used instead. Only one README should be defined.
Autoasmver
Autoasmver is enabled by default. It will automatically set the assembly version of compiled assemblies to Major.0.0.0
. Set $(DisableAutoasmver)
to true
to disable Autoasmver.
Autocopyright
Autocopyright is enabled by default. Autocopyright makes it easier to define the copyright. For example, the configuration below will result in the copyright notice Copyright (C) 2023 Arthri.\nAll Rights Reserved
<ItemGroup>
<CopyrightOwner Include="Arthri" Years="2023" />
</ItemGroup>
Development
Prerequisites
- Install the .NET 7.0 SDK version 7.0.100 or newer.
Building with Visual Studio
- Open
Belp.SDK.Packinf.sln
. - Open the Solution Explorer.
- Right click on the project
Belp.SDK.Packinf
in the Solution Explorer. - Click on
Pack
.
Building with .NET CLI
- Open a terminal in the repository root.
- Run
dotnet pack
Output
By default, the output is located in src/Belp.SDK.Packinf/Belp.SDK.Packinf/bin/Release/
.
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net5.0 was computed. net5.0-windows was computed. net6.0 was computed. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. |
.NET Core | netcoreapp2.0 was computed. netcoreapp2.1 was computed. netcoreapp2.2 was computed. netcoreapp3.0 was computed. netcoreapp3.1 was computed. |
.NET Standard | netstandard2.0 is compatible. netstandard2.1 was computed. |
.NET Framework | net461 was computed. net462 was computed. net463 was computed. net47 was computed. net471 was computed. net472 was computed. net48 was computed. net481 was computed. |
MonoAndroid | monoandroid was computed. |
MonoMac | monomac was computed. |
MonoTouch | monotouch was computed. |
Tizen | tizen40 was computed. tizen60 was computed. |
Xamarin.iOS | xamarinios was computed. |
Xamarin.Mac | xamarinmac was computed. |
Xamarin.TVOS | xamarintvos was computed. |
Xamarin.WatchOS | xamarinwatchos was computed. |
-
.NETStandard 2.0
- No dependencies.
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.
## 🆕 Features
- Changed build action of assets inside `Assets/content` to `Content`. Any files that end with `.cs` or `$(DefaultLanguageSourceExtension)` instead are set to `Compile`.
- Changed default path of package assets without a defined path to `content` and `contentFiles`.
- Limited `contentFiles/` fix to items with an `ItemSource` metadata equal to `PackageAsset`.
- Packed assets inside `Assets/content` to `contentFiles/any/{tfm]`.
- Renamed `Autocopyright` to `AutoCopyright`.
- Renamed `PackageAssets` to `PackageAsset`.
## 🐞 Fixes
- Fixed Packinf for multi-targeting builds.
- Renamed `contentfiles` to `contentFiles`.