From dd8b07756f6a37799df65c096c94aa14b850b7a7 Mon Sep 17 00:00:00 2001 From: Martijn Laarman Date: Wed, 11 Nov 2026 22:20:26 +0100 Subject: [PATCH] Give the README and package READMEs the shared nullean shape The root README gets the org lockup, a tagline, one badge row, the real release notes the tool generates for elastic/apm-agent-dotnet 1.11.0, install, quick start with the commands and shared options, the GitHub Action and container usage, the upgrade notes, a packages table and links. The package README, packed into the root, any and per-RID packages, follows the package template and stays nuget.org-safe. Corrects the upgrade note: the Argh CLI shipped in 0.11.0, not 1.0.0. Adds what --format asciidoc does: --output becomes a directory and nothing is printed to standard out. Co-Authored-By: Claude Opus 5.5 --- README.md | 205 ++++++++++++++++++------------------ src/release-notes/README.md | 46 ++++++-- 2 files changed, 138 insertions(+), 113 deletions(-) diff --git a/README.md b/README.md index 63052a9..205b1a7 100644 --- a/README.md +++ b/README.md @@ -1,140 +1,137 @@ -

- - -# release-notes +

+ + + nullean +

-Generate release notes for a release based on github labels and closed issues and PR's +

release-notes

-## Installation +

Write release notes for a GitHub repository from the issues and pull requests labelled with the version you are releasing, grouped by their other labels.

-Distributed as a .NET tool so install using the following +

+ NuGet + CI +

-``` -dotnet tool install release-notes -``` +The release notes for elastic/apm-agent-dotnet 1.11.0, from the three pull requests labelled `v1.11.0`. The previous +release is found on its own: -On Linux, Windows and macOS/arm64, this resolves to a self-contained native-AOT executable — no -shared .NET runtime required, and no first-run JIT warmup. Everywhere else, it falls back to a -framework-dependent build (requires the .NET runtime the tool targets to already be installed). +```console +$ release-notes generate elastic apm-agent-dotnet --version 1.11.0 --uncategorized-header "Other changes" +https://github.com/elastic/apm-agent-dotnet/compare/1.10.0...1.11.0 -## GitHub Action +## New Features -```yaml -- uses: nullean/release-notes@main - with: - command: generate - owner: nullean - repo: release-notes - args: --version 1.0.0 -``` +- #1239 Add Cosmos DB support (issue: #1154) +- #1310 Implement config to ignore the sampled flag in traceparent -Runs `release-notes` from a pre-built, distroless container (`ghcr.io/nullean/release-notes`) — no .NET -SDK install needed in the workflow. `command` is one of `generate`, `apply-labels`, `find-previous`, -`current-version`, or `create-release`; extra flags pass through verbatim via `args`. Linux runners only -(`ubuntu-latest` and similar) — container actions can't run on Windows or macOS runners. +## Other changes -## Container image +- #1302 Prefer W3C traceparent over elastic-apm-traceparent + +### [View the full list of issues and PRs](https://github.com/elastic/apm-agent-dotnet/issues?utf8=%E2%9C%93&q=label%3Av1.11.0) +``` -`ghcr.io/nullean/release-notes` also works as a general-purpose container, outside GitHub Actions — -GitLab CI, a local machine without the .NET SDK, anywhere `docker run` works: +## Install ```sh -docker run --rm ghcr.io/nullean/release-notes:edge generate nullean release-notes --version 1.0.0 --token "$GITHUB_TOKEN" +dotnet tool install --global release-notes ``` -Distroless: native-AOT, chiseled `runtime-deps` base, no shell, runs as a non-root user. Tags follow -`release-notes`'s own releases — `edge` tracks the latest commit on `main`, `latest` and a semver tag -(e.g. `0.10.0`) follow tagged releases. +On Linux (x64, arm64), Windows (x64, arm64) and macOS (arm64) this installs a self-contained native-AOT executable: no +shared .NET runtime, no JIT warm-up. Everywhere else it falls back to a framework-dependent build, which needs the .NET +runtime installed. -## Run +## Quick start -```bat -dotnet release-notes --version [options] +```sh +release-notes generate nullean my-repo --version 1.2.3 --token "$GITHUB_TOKEN" \ + --label "bug=Bug Fixes" --label "enhancement=New Features" --output release-notes-VERSION.md ``` -You can omit `dotnet` if you install this as a global tool. - -> [!IMPORTANT] -> Starting from `1.0.0`, every invocation requires an explicit command name (`generate`, -> `apply-labels`, `find-previous`, `current-version` or `create-release`) — there is no longer a bare -> `release-notes ...` shorthand for `generate`. `--label` also changes from two tokens -> (`--label