EasyBuild.Tools 1.1.1

.NET 6.0 This package targets .NET 6.0. The package is compatible with this framework or higher.
There is a newer version of this package available.
See the version list below for details. 
dotnet add package EasyBuild.Tools --version 1.1.1                

                    
                

            
NuGet\Install-Package EasyBuild.Tools -Version 1.1.1
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="EasyBuild.Tools" Version="1.1.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
paket add EasyBuild.Tools --version 1.1.1                

                    
                

            
#r "nuget: EasyBuild.Tools, 1.1.1"
#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 EasyBuild.Tools as a Cake Addin
#addin nuget:?package=EasyBuild.Tools&version=1.1.1

// Install EasyBuild.Tools as a Cake Tool
#tool nuget:?package=EasyBuild.Tools&version=1.1.1

EasyBuild.Tools

NuGet

Sponsors badge link

Tool for generating changelog based on Git history based on Conventional Commits. It is using EasyBuild.CommitParser to parse commit messages check their documentation for more information about configuration.

Installation

dotnet add package EasyBuild.Tools

APIs

Git

<details> <summary> <code>Git.addAll</code>

  • add all files to staging area </summary>
Parameters

None

Returns

unit

Example
open EasyBuild.Tools.Git

Git.addAll()

</details>

<details> <summary> <code>Git.commitRelease</code>

  • commit staged files with release message using conventional commit </summary>
Parameters
name type required description
newVersion string ✅ Version to release
Returns

unit

Example
open EasyBuild.Tools.Git

// Create a commit with message "chore: release 1.0.0"
Git.commitRelease "1.0.0"

</details>

<details> <summary> <code>Git.push</code>

  • push changes to remote repository </summary>
Parameters
name type required description
force bool ❌ Force push to remote branch
Returns

unit

Example
open EasyBuild.Tools.Git

Git.push()

</details>

DotNet

<details> <summary> <code>DotNet.changelogGen</code>

  • generate changelog using <a href="https://github.com/easybuild-org/EasyBuild.ChangelogGen">EasyBuild.ChangelogGen</a> </code> </summary>
Parameters
name type required default description
changelogFile string ✅
allowDirty bool ❌ Allow to run in a dirty repository
allowBranch string list ❌ main List of branches that are allowed to be used to generate the changelog.
tagFilter string list ❌ List of tags to include in the changelog
preRelease string ❌ Indicate that the generated version is a pre-release version.
forceVersion string ❌ Force the version to be used in the changelog
skipInvalidCommit bool ❌ Skip invalid commits instead of failing
dryRun bool ❌ Run the command without writing to the changelog file, output the result in STDOUT instead
githubRepo string ❌ GitHub repository name in format 'owner/repo'
workingDirectory string ❌ Working directory path
forwardArguments string list ❌ List of arguments to forward to the CLI tools as defined in EasyBuild.ChangelogGen
Returns

string - new version generated based on the commits history

Example
open EasyBuild.Tools.DotNet

let newVersion = DotNet.changelogGen "CHANGELOG.md"

</details>

<details> <summary> <code>DotNet.pack</code>

  • commit staged files with release message of format <code>chore: release {version}</code> </summary>
Parameters
name type required default description
workingDirectory string ❌ Working directory path
configuration Configuration ❌ Release Build configuration
Returns

FileInfo - file descriptor to the generated .nupkg file

Example
open EasyBuild.Tools.DotNet

let nupkgFile = DotNet.pack()

</details>

<details> <summary> <code>DotNet.nugetPush</code>

  • commit staged files with release message using conventional commit </summary>
Parameters
name type required default description
nupkgPath string ✅ Working directory path
nugetKey Configuration ❌ NUGET_KEY env variable NuGet API key
skipDuplicate bool ❌ true If a package and version already exists, skip it
source string ❌ Package source (URL, UNC/folder path or package source name) to use.
forceEcho bool ❌ false Echo the
Returns

unit

Example
open EasyBuild.Tools.DotNet

// In general, you will get the nupkg file from DotNet.pack
let nupkgFile = DotNet.pack()

DotNet.nugetPush nupkgFile

// Or you can customize it
let nugetKey = Environment.GetEnvironmentVariable "NUGET_KEY_CUSTOM"
DotNet.nugetPush (nupkgFile, nugetKey = nugetKey)

</details>

Product Compatible and additional computed target framework versions.
.NET net6.0 is compatible.  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. 
Compatible target framework(s)
Included target framework(s) (in 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
3.1.0 75 11/27/2024
3.0.0 58 11/27/2024
2.0.0 75 11/27/2024
1.1.1 119 11/23/2024
1.1.0 74 11/23/2024
1.0.0 87 11/18/2024

### 🐞 Bug Fixes

* Use the correct prefix  for `tagFilter` argument in `DotNet.changelogGen` ([84eea9b](https://github.com/easybuild-org/EasyBuild.Tools/commit/84eea9be8361d6ecfcd2d6a02350c6ab0f0d3eff))

<strong><small>[View changes on Github](https://github.com/easybuild-org/EasyBuild.Tools/compare/d45d733b306248cf7374abd0016ea8028b1bc93d..84eea9be8361d6ecfcd2d6a02350c6ab0f0d3eff)</small></strong>