Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/sakapon/build-release

A set of tools to build .NET projects.
https://github.com/sakapon/build-release

build msbuild nuget powershell versioning zip

Last synced: about 6 hours ago
JSON representation

A set of tools to build .NET projects.

Host: GitHub
URL: https://github.com/sakapon/build-release
Owner: sakapon
License: mit
Created: 2018-01-18T10:56:30.000Z (almost 7 years ago)
Default Branch: master
Last Pushed: 2020-04-15T09:06:53.000Z (over 4 years ago)
Last Synced: 2024-05-29T13:31:54.192Z (6 months ago)
Topics: build, msbuild, nuget, powershell, versioning, zip
Language: C#
Homepage:
Size: 2.19 MB
Stars: 2
Watchers: 3
Forks: 1
Open Issues: 5
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # Build Release

A set of tools to build .NET projects.

[![license](https://img.shields.io/github/license/sakapon/Build-Release.svg)](https://github.com/sakapon/Build-Release/blob/master/LICENSE)

The following tools are contained:

- [**Initial Set**](#initial-set)

- [**Version 1up**](#version-1up)

- [**Zip Release**](#zip-release)

- [**NuGet Packup**](#nuget-packup)

See [Specification](docs/Specification.md) for details.

There are options to use the tools:

- Download [the PowerShell script files](https://github.com/sakapon/Build-Release/tree/master/Downloads) and extract them to any folder

- Add the PowerShell scripts above to `External Tools` in Visual Studio (**recommended**)

- Install the PowerShell script files to a .NET project by NuGet

See [Usage](#usage) for details.

## Initial Set

The PowerShell script to add initial settings to the project that will be released.

![](docs/images/InitialSet-Change.png)

## Version 1up

[![NuGet](https://img.shields.io/nuget/v/KTools.Version1up.svg)](https://www.nuget.org/packages/KTools.Version1up/)

[![NuGet](https://img.shields.io/nuget/dt/KTools.Version1up.svg)](https://www.nuget.org/packages/KTools.Version1up/)  

[NuGet Gallery | KTools.Version1up](https://www.nuget.org/packages/KTools.Version1up/) (for the .NET Framework project format)

The PowerShell script to increment the assembly version.

![](docs/images/Version1up-Change.png)

## Zip Release

[![NuGet](https://img.shields.io/nuget/v/KTools.ZipRelease.svg)](https://www.nuget.org/packages/KTools.ZipRelease/)

[![NuGet](https://img.shields.io/nuget/dt/KTools.ZipRelease.svg)](https://www.nuget.org/packages/KTools.ZipRelease/)  

[NuGet Gallery | KTools.ZipRelease](https://www.nuget.org/packages/KTools.ZipRelease/) (for the .NET Framework project format)

The PowerShell script to build the project and create a ZIP file.

![](docs/images/ZipRelease-Explorer.png)

## NuGet Packup

The PowerShell script to build the project and create a NuGet package.

![](docs/images/NuGetPackup-Explorer.png)

## Usage

There are options to use the tools:

- Download the latest version of [the PowerShell script files](https://github.com/sakapon/Build-Release/tree/master/Downloads) and extract them to any folder

  - Execute the scripts on the project folder

- Add the PowerShell scripts above to `External Tools` in Visual Studio (**recommended**)

  - Execute the menu on the project

- Install the PowerShell script files to a .NET project by NuGet

  - Execute the scripts on the project folder

You can customize the PowerShell script to meet your needs.

### How to Add the Scripts to External Tools in Visual Studio

Choose the menu `Tools > External Tools`, and add a new content with the following information:

- Title: any

- Command: `powershell.exe`

- Arguments: `-ExecutionPolicy Unrestricted "C:\scripts_folder\KTools.xxx.ps1"`

- Initial directory: `$(ProjectDir)`

- Use Output window: `On`

![ExternalTools](docs/images/ExternalTools.png)

## Testing Environment

- Visual Studio 2017

- Visual Studio 2019

## Release Notes

- **v2.1.14**

  - Add [**Initial Set**](#initial-set).

  - Update paths to MSBuild.exe for Visual Studio 2019.

- **v2.0.10** For .NET Core.

- **v1.2.6** Find the path to .ps1 files, regardless of the current directory.

- **v1.2.5** Find the path to MSBuild.exe.

- **v1.2.4** Rename .ps1 files.

- **v1.1.3** The first release.

## References

- [.NET Regular Expressions](https://msdn.microsoft.com/library/hs600312.aspx)

- [.nuspec File Reference for NuGet](https://docs.microsoft.com/en-us/nuget/schema/nuspec)

- [NuGet Package Version Reference](https://docs.microsoft.com/en-us/nuget/reference/package-versioning)

- [Manage external tools](https://docs.microsoft.com/en-us/visualstudio/ide/managing-external-tools)

### My Blog (in Japanese)

- [.NET ビルド小技集 (4)](https://sakapon.wordpress.com/2015/10/23/dotnet-build-4/)

- [ビルドして ZIP にする PowerShell スクリプト](https://sakapon.wordpress.com/2018/02/06/zip-release/)

- [ビルド用のスクリプトを Visual Studio の外部ツールに登録する](https://sakapon.wordpress.com/2018/08/20/external-tools-build/)

- [.NET Core 向けビルド スクリプト](https://sakapon.wordpress.com/2018/09/01/build-release-netcore/)