|
| 1 | +# Changelog |
| 2 | + |
| 3 | +All notable changes to this project will be documented in this file. |
| 4 | + |
| 5 | +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), |
| 6 | +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). |
| 7 | + |
| 8 | +## [Unreleased] |
| 9 | + |
| 10 | +## [6.0.0] - 2026-02-08 |
| 11 | + |
| 12 | +> **⚠️ WARNING: This is a MAJOR release with breaking changes.** |
| 13 | +> |
| 14 | +> This release includes multiple significant changes that may affect compatibility: |
| 15 | +> |
| 16 | +> 1. **Removed deprecated CLI arguments** - Several CLI flags have been removed. Scripts, CI/CD pipelines, and automation using these flags will break. |
| 17 | +> 2. **Upgraded to .NET 10** - Runtime requirements have changed. |
| 18 | +> 3. **Updated System.CommandLine** - Upgraded from beta4 to v2.0.0 final, which includes breaking API changes that may affect command-line behavior. |
| 19 | +> 4. **Updated dependency versions** - NuGet packages, System.IO.Abstractions, and other dependencies have been upgraded. |
| 20 | +> |
| 21 | +> **Action required:** Test thoroughly in a non-production environment before upgrading. Review all sections below for changes that may affect your use case. |
| 22 | +
|
| 23 | +### Breaking Changes |
| 24 | + |
| 25 | +- **Remove deprecated CLI arguments** (#996, 0ae5d6a) |
| 26 | + - Removed `--json`/`-j` flag (replaced by `--output-format json`) |
| 27 | + - Removed `-f` flag (replaced by `-fn`/`--filename`) |
| 28 | + - Removed `-d` flag (replaced by `-ed`/`--exclude-dev`) |
| 29 | + - Removed `-r` flag (replaced by `-rs`/`--scan-project-references`) |
| 30 | + - Removed `--disable-github-licenses`/`-dgl` flag (already default behavior) |
| 31 | + - Removed `json` property from `RunOptions` model |
| 32 | + - Updated all tests to use `outputFormat` enum instead of boolean `json` flag |
| 33 | + - Cleaned up legacy flag handling logic in `Program.cs` and `Runner.cs` |
| 34 | + - **Note:** `--out` flag was restored before release for backward compatibility (see Fixed section below) |
| 35 | + |
| 36 | +- **Upgraded System.CommandLine to v2.0.0** (#989, e11f8e7) |
| 37 | + - Upgraded from `2.0.0-beta4.22272.1` to `2.0.0` (stable release) |
| 38 | + - This version includes breaking API changes from the beta |
| 39 | + - Command-line parsing behavior may differ in edge cases |
| 40 | + |
| 41 | +- **Minimum .NET runtime requirement** (#989, e11f8e7) |
| 42 | + - Now requires .NET 10 runtime (upgraded from .NET 9) |
| 43 | + - Docker images now use `mcr.microsoft.com/dotnet/sdk:10.0` |
| 44 | + |
| 45 | +### Added |
| 46 | + |
| 47 | +- **Documentation update** (#987, f041ac2) |
| 48 | + - Added `.slnx` format to supported file types in README |
| 49 | + |
| 50 | +### Changed |
| 51 | + |
| 52 | +- **Dockerfile improvements** (#993, edf2bd9) |
| 53 | + - Implemented multi-stage build (build + runtime stages) for smaller images |
| 54 | + - Changed from tool installation to direct publish deployment |
| 55 | + - Added environment variables for non-root execution: `DOTNET_CLI_HOME`, `NUGET_PACKAGES` |
| 56 | + - Made `/tmp/dotnet-home` and `/tmp/nuget-packages` writable for any user (chmod 0755) |
| 57 | + - Changed entrypoint from `CycloneDX` to `dotnet /app/CycloneDX.dll` |
| 58 | + - Fixed handling when no path argument is provided (now shows help instead of error) |
| 59 | + - Made `path` argument optional with `ArgumentArity.ZeroOrOne` |
| 60 | + |
| 61 | +- **Upgrade to .NET 10** (#989, e11f8e7) |
| 62 | + - Updated target framework to `net10.0` |
| 63 | + - Updated SDK image to `mcr.microsoft.com/dotnet/sdk:10.0` |
| 64 | + - Updated System.IO.Abstractions from 21.0.2 to 22.1.0 |
| 65 | + - Updated test runner packages (xunit.runner.visualstudio, coverlet.collector) |
| 66 | + - Fixed devcontainer Ubuntu 22.04 Dockerfile |
| 67 | + |
| 68 | +- **Dependency updates** |
| 69 | + - actions/checkout: 5.0.0 → 6.0.1 (#986, #991) |
| 70 | + - actions/upload-artifact: 4.6.2 → 5.0.0 (#979) |
| 71 | + - actions/setup-dotnet: 5.0.0 → 5.0.1 (#988) |
| 72 | + - danielpalme/ReportGenerator-GitHub-Action (version bump) (#992) |
| 73 | + |
| 74 | +### Fixed |
| 75 | + |
| 76 | +- **Restore `--out` parameter for backward compatibility** |
| 77 | + - Reintroduced `--out` flag as a deprecated alias for `--output`/`-o` to maintain compatibility with existing GitHub Actions and CI/CD pipelines |
| 78 | + - The parameter is marked as deprecated with a message directing users to use `--output` instead |
| 79 | + - If both `--output` and `--out` are provided, `--output` takes precedence |
| 80 | + - Prevents breaking existing automation while encouraging migration to the new flag |
| 81 | + |
| 82 | +- **Restore `--json` parameter for backward compatibility** |
| 83 | + - Reintroduced `--json` flag as a deprecated alias for `--output-format json` to maintain compatibility with existing GitHub Actions and CI/CD pipelines |
| 84 | + - The parameter is marked as deprecated with a message directing users to use `--output-format` instead |
| 85 | + - If `--json` is provided, it sets the output format to JSON |
| 86 | + - Prevents breaking existing automation while encouraging migration to the new flag |
| 87 | + |
| 88 | +- **Missing using statement** (161766f) |
| 89 | + - Added missing `using System;` directive in Program.cs |
| 90 | + |
| 91 | +### Security |
| 92 | + |
| 93 | +- **Workflow security hardening** (#975, 39b8986) |
| 94 | + - Changed global `permissions: contents: read` to `permissions: read-all` |
| 95 | + - Follows principle of least privilege by limiting default permissions |
| 96 | + |
| 97 | +- **Pin GitHub Actions versions** (1145c82) |
| 98 | + - Pinned all GitHub Actions to specific commit SHAs for reproducibility |
| 99 | + |
| 100 | +- **Enable NuGet package locking** (#972, fad44df) |
| 101 | + - Added `packages.lock.json` files for both main and test projects |
| 102 | + - Enabled `RestorePackagesWithLockFile` in Directory.Build.props |
| 103 | + - Updated CI/CD workflows to use locked restore |
| 104 | + |
| 105 | +- **Update NuGet dependencies** (#973, e930da1) |
| 106 | + - Bumped `NuGet.ProjectModel` from 6.9.1 to 6.14.0 |
| 107 | + - Bumped `NuGet.Protocol` from 6.9.1 to 6.14.0 |
| 108 | + |
| 109 | +## [5.5.0] - 2025-10-06 |
| 110 | + |
| 111 | +### Changed |
| 112 | + |
| 113 | +- Initial baseline for changelog tracking |
0 commit comments