Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fornever/changelogautomation
A handy tool to automate changelog processing in CI.
https://github.com/fornever/changelogautomation
Last synced: 21 days ago
JSON representation
A handy tool to automate changelog processing in CI.
- Host: GitHub
- URL: https://github.com/fornever/changelogautomation
- Owner: ForNeVeR
- License: mit
- Created: 2021-04-10T15:35:39.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2024-03-23T19:26:21.000Z (8 months ago)
- Last Synced: 2024-10-04T16:29:45.843Z (about 1 month ago)
- Language: C#
- Size: 102 KB
- Stars: 12
- Watchers: 3
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
ChangelogAutomation [![NuGet Package][nuget.badge]][nuget.package] [![Status Aquana][status-aquana]][andivionian-status-classifier]
===================
When preparing a software release, a common task is to parse [the changelog file][keep-a-changelog], and extract the latest changes section from it. For certain purposes, Markdown format is acceptable, but in some cases a text format is also useful.
ChangelogAutomation is a tool for this exact purpose. It will extract the first second-level section from a Markdown file either in a text or in a Markdown format, and will print it to a file or to its stdout.
"Second-level section" is a section preceded by a level 2 header; any of these:
```markdown
## Level 2 header
…some section content…
Also level 2 header
-------------------
…some section content…
```
Prerequisites
-------------
Since ChangelogAutomation is distributed as a self-contained .NET 6 application, it requires the .NET 6 dependencies (but not the .NET 6 runtime itself) to be available on the user machine to run. See more information on the dependencies for various operating systems:
- [Linux][deps.linux] (see distribution-specific sections for dependencies)
- [Windows][deps.windows]
- [macOS][deps.macos]
Installation (console tool)
---------------------------
1. Download the latest stable distribution binaries for your operating system from [GitHub releases page][releases].
2. Unpack the archive, and run `ChangelogAutomation` (or `ChangelogAutomation.exe`) binary from it.
Usage
-----
### GitHub Actions
There's a separate repository with GitHub Action integration of this tool. Check out [the documentation][github-actions].
### Console tool
This invocation will extract the first second-level section of the file, and write it to the output (either the standard one, or an optional output file):
```console
$ ChangelogAutomation [options…]
```
The available options are:
- `(-o|--outputFilePath) ` (if not specified, then will print to stdout)
- `(-t|--contentType) (Markdown|PlainText)`: output content type
### MSBuild
There's an MSBuild task package available. The package will automatically integrate with `dotnet pack`, and extract the latest changelog entry into the `` element in the `.nuspec` file.
Just add a package reference to `ChangelogAutomation.MSBuild` package, and the task will automatically be enabled. It will set the `PackageReleaseNotes` property to the latest version section contents (this is a standard property, will then be used by NuGet integration automatically).
There are MSBuild properties to tune its behavior:
- `DisableChangelogAutomationTask`: set this to `true` to disable the automatic task invocation (if you want to register it with the custom parameters).
- `ChangelogFilePath`: point it to the `CHANGELOG.md` file. By default, will be set to `../CHANGELOG.md` (resolved relatively to the project file location).
- `ReleaseNotesOutputType`: either `Markdown` or `PlainText`. If not set, defaults to `PlainText`.
Development
-----------
ChangelogAutomation is a .NET 6 application, so it requires [.NET 6 SDK][dotnet-sdk] (or a later version) for build.
To build the application, run the following command:
```console
$ dotnet build --configuration Release
```
To run the unit test suite, run the following command:
```console
$ dotnet test --configuration Release
```
To run the integration test for the MSBuild task package, run the following command:
```console
$ pwsh ./ChangelogAutomation.MSBuild.Tests/Run-Test.ps1
```
To verify the NuGet package produced for ChangelogAutomation.MSBuild, run the following command:
```console
$ pwsh ./ChangelogAutomation.MSBuild.Tests/Run-PackageValidation.ps1
```
To run the developer version, execute the following command (usual application arguments follow after `--`):
```console
$ dotnet run --project ChangelogAutomation -- …
```
Documentation
-------------
- [Changelog][changelog]
- [Maintainership][maintainership]
- [License][license] (MIT)
- Markdig library license (which is bundled into the ChangelogAutomation distributions) should be in the same directory as this file (`README.md`) with the name `license_Markdig.txt`.
[andivionian-status-classifier]: https://github.com/ForNeVeR/andivionian-status-classifier#status-aquana-
[changelog]: ./CHANGELOG.md
[deps.linux]: https://docs.microsoft.com/en-us/dotnet/core/install/linux
[deps.macos]: https://docs.microsoft.com/en-us/dotnet/core/install/macos#dependencies
[deps.windows]: https://docs.microsoft.com/en-us/dotnet/core/install/windows?tabs=net50#dependencies
[dotnet-sdk]: https://dotnet.microsoft.com/
[keep-a-changelog]: http://keepachangelog.com/
[license]: ./LICENSE.md
[maintainership]: ./MAINTAINERSHIP.md
[nuget.package]: https://www.nuget.org/packages/ChangelogAutomation.MSBuild/
[releases]: https://github.com/ForNeVeR/ChangelogAutomation/releases
[github-actions]: https://github.com/marketplace/actions/changelogautomation-action
[nuget.badge]: https://img.shields.io/nuget/v/ChangelogAutomation.MSBuild
[status-aquana]: https://img.shields.io/badge/status-aquana-yellowgreen.svg