docs(changelog): inventory all releases through v1.6.0#32
Merged
danielmeppiel merged 1 commit intomainfrom May 2, 2026
Merged
Conversation
The CHANGELOG.md added in PR #31 only carried an Unreleased section. This commit backfills the historical record by inventorying every merged PR per release tag (v1.0.0 through v1.5.1) and graduates the Unreleased section to a [1.6.0] heading dated 2026-05-02. v1.6.0 delivers the defensive 'bundle-format: apm' default plus the 'setup-only' mode (closes #24), unblocking apm-action consumers ahead of the upstream apm 0.12 release that flips the default 'apm pack' output to the plugin layout. Sources: - gh pr list (--state merged) cross-referenced with git tag dates - existing GitHub release notes for v1.4.2, v1.5.0, v1.5.1 - commit messages in each release window No code change. CHANGELOG-only. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
This docs-only PR backfills CHANGELOG.md with historical release entries from v1.0.0 through v1.5.1 and promotes the previous Unreleased notes into a dated 1.6.0 release entry, aligning the changelog with the repository’s release/tagging workflow.
Changes:
- Adds one changelog section per shipped release from
1.0.0to1.5.1. - Records the
1.6.0release notes for the recently merged feature work from PR #31. - Adds compare/reference links and introductory release-policy context for SemVer and the floating
v1tag.
Show a summary per file
| File | Description |
|---|---|
CHANGELOG.md |
Expands the changelog into a full release history and updates release/reference links for 1.6.0. |
Copilot's findings
Tip
Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comments suppressed due to low confidence (4)
CHANGELOG.md:53
- This overstates what #27 fixed. Restore mode still writes deployed primitive files into the workspace, so callers can end up with new/untracked files; the actual fix was that bundle metadata like
apm.lock.yamlandapm.ymlno longer leak intoworking-directory. Documenting it as leaving 'no untracked files behind' is inaccurate and could mislead users debugginggit statuschanges.
- **`restore` mode no longer dirties the workspace** ([#27]). The action now installs the APM CLI and shells out to `apm unpack` instead of doing its own extraction inside the runner workspace, so the restore step leaves no untracked files behind. Fixes intermittent CI failures when downstream steps inspect `git status`.
CHANGELOG.md:92
audit-reportdoes not upload anything to Code Scanning by itself. The action only generates the SARIF file and setsaudit-report-path; callers still need a separategithub/codeql-action/upload-sarifstep, and the markdown output goes to$GITHUB_STEP_SUMMARY, not the job log. This changelog entry currently describes behavior the action does not perform.
- **`audit-report` input for SARIF audit report generation** ([#14]). Opt-in flag that runs `apm audit` and uploads a SARIF report to the GitHub code-scanning UI, plus a markdown summary in the job log. Lets security teams surface APM dependency findings alongside the rest of their static-analysis signals.
CHANGELOG.md:109
- This section uses two names that don't match the public API shipped in #10: the release itself renamed the install path to 'non-isolated mode', and the restore input is
bundle, whilebundle-pathis a pack output. Keeping the old terms here makes the historical changelog point readers at an input that doesn't exist.
- **Mode-aware directory creation** ([#10]). Pack and restore modes create their working directories on demand with mode-appropriate guards; default mode fails fast when the working directory does not exist.
- **Allow absolute bundle paths in restore mode** ([#10]). `bundle-path:` accepts absolute paths, not only paths relative to `working-directory`.
CHANGELOG.md:47
- This release note describes
bundles-fileas a YAML manifest with per-entry targets and says it complements single-bundlebundle-path:mode, but the current API is different in both places:bundles-fileis a plain UTF-8 text file with one.tar.gzpath per line, and single-bundle restore uses thebundleinput whilebundle-pathis only a pack-mode output. As written, the changelog points readers at a config format and input name the action does not accept.
- **Multi-bundle restore via `bundles-file:` input** ([#30]). Restore multiple APM-format bundles in a single step by providing a YAML manifest listing each bundle path and target. Complements the existing single-bundle `bundle-path:` mode for monorepos and matrix workflows that materialize several plugins at once.
- Files reviewed: 1/1 changed files
- Comments generated: 1
| - **`bundle-format` input** ([#31]). Controls the layout produced by `apm pack`: `apm` (default, restorable by this action) or `plugin` (Claude Code marketplace layout). Defaults to `apm` so existing pack -> restore round-trips keep working regardless of changes to the upstream `apm pack` CLI default. | ||
| - **`apm-version` output** ([#31]). Resolved APM CLI version string. Always set. | ||
| - **`apm-path` output** ([#31]). Absolute path to the resolved `apm` binary. Resolved via tool-cache when the action installed APM, or via `which apm` when reusing a pre-existing CLI on `PATH`. | ||
| - **`bundle-format` output** ([#31]). Format of the produced or restored bundle. Set in pack and single-bundle restore modes. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
TL;DR
Backfills the historical CHANGELOG (which only had an
Unreleasedsection since being introduced in #31) with one entry per shipped release fromv1.0.0throughv1.5.1, and graduates the Unreleased section to[1.6.0] - 2026-05-02. Once merged, taggingv1.6.0triggers the existing release pipeline (CI watchestags: ['v*']and updates the floatingv1tag).This is a docs-only PR. No code changes.
What's in 1.6.0
Everything from PR #31 (already merged on
main):setup-only: truemode (closes Support CLI-only mode #24) -- install APM CLI ontoPATHand exit, likeactions/setup-node.bundle-formatinput -- defaults toapmso existing pack/restore round-trips keep working when the upstreamapm packCLI default flips topluginin apm 0.12. Opt intobundle-format: pluginto publish Claude Code marketplace bundles.apm-version,apm-path,bundle-format.apm-version(always installs into tool cache when pinned, instead of short-circuiting to whatever's already onPATH).How the inventory was built
PRs by release window:
Validation
wc -l CHANGELOG.md-> 192 lines, well within the section rubric ceilings.[#NN]reference-style links resolve to valid PR/issue URLs.[X.Y.Z]: ...compare/...link at the bottom.v1.5.1-> 2026-04-28,v1.4.2-> 2026-04-24.Next steps after merge
git tag v1.6.0 <merge-sha> && git push origin v1.6.0-- thereleasejob inci.yml(triggered onrefs/tags/v*) will publish the release and update the floatingv1tag tov1.6.0.microsoft/apm-action@v1to confirm the floating tag moved.apm0.12 release is cut (carryingapm install <local-bundle>), open a follow-up issue here to migrate restore fromapm unpacktoapm install <bundle-path>-- that would unlock plugin-format restore (currently rejected) and letbundle-formatdefault flip topluginin a future major.Co-authored-by: Copilot 223556219+Copilot@users.noreply.github.com