Skip to content

docs: add 0.17.x to 1.0.0 upgrade notes (TRUNK-23152) - #1329

Merged
trunk-io[bot] merged 7 commits into
mainfrom
tylerbeebe/trunk-23152-upgrade-notes
Nov 17, 2026
Merged

trunk-io[bot] merged 7 commits into
mainfrom
tylerbeebe/trunk-23152-upgrade-notes

Conversation

@acatxnamedvirtue

@acatxnamedvirtue acatxnamedvirtue commented Nov 13, 2026 •

Copy link
Copy Markdown
Contributor

Part of TRUNK-23152

Based on main: #1328, #1313, #1314, #1339 and #1337 have merged.

Adds UPGRADING.md, the 0.17.x → 1.0.0 upgrade notes, and links it from the README's Credentials section. It covers:

  • credentials: a v2 API key with Upload test results; the organization token is refused;
  • the required --test-collection-id;
  • removed flags and variables, with what to use instead;
  • the fork lane, with no v1 fallback;
  • the summary on stdout and --output-format json;
  • GUID test links;
  • telemetry moving from telemetry.trunk.io to api.trunk.io;
  • which analytics-uploader versions pick up 1.0.0, and when:
  • trunk flakytests running 1.x from trunk CLI 0.0.14 (trunk-io/trunk2#8640);
  • the rspec gem failing the run without a collection ID or with an organization token (feat(rspec)!: fail the run when Trunk is configured but can't upload #1337), and how to opt out or stay on 0.17.x.

The user-facing docs (UPGRADING.md, the README's Credentials section and the rspec gem's README) leave out implementation details. Users only pass a v2 API key: the Trunk JWT is how the trunk CLI hands a credential to analytics-cli, so the docs only say that trunk flakytests handles it. They also don't name the channel pointer files, the fork lane's token swap, the telemetry route or the test link paths.

Also fixes CONTRIBUTING.md, which said the trunk CLI reads channel.json. From 0.0.14 (trunk-io/trunk2#8640) it reads channel-1.json. So promote-latest doesn't hold it back, and channel-1.json must never be removed or pointed at another major.

The draft 1.0.0 release body, which links to these notes, will be pasted into the release once it's cut.

Testing

trunk check and trunk fmt are clean. Docs only.

🤖 Generated with Claude Code

@acatxnamedvirtue
acatxnamedvirtue force-pushed the tylerbeebe/trunk-23149-23372-v2-key-or-jwt branch from 761afcb to 103ae54 Compare November 13, 2026 20:21
@acatxnamedvirtue
acatxnamedvirtue force-pushed the tylerbeebe/trunk-23152-upgrade-notes branch from df945fe to d768461 Compare November 13, 2026 20:21
@acatxnamedvirtue
acatxnamedvirtue force-pushed the tylerbeebe/trunk-23149-23372-v2-key-or-jwt branch from 103ae54 to 6ea6c13 Compare November 16, 2026 18:16
@acatxnamedvirtue
acatxnamedvirtue force-pushed the tylerbeebe/trunk-23152-upgrade-notes branch from d768461 to f33fa69 Compare November 16, 2026 18:16
@acatxnamedvirtue
acatxnamedvirtue force-pushed the tylerbeebe/trunk-23149-23372-v2-key-or-jwt branch from 6ea6c13 to 129c31b Compare November 16, 2026 22:26
@acatxnamedvirtue
acatxnamedvirtue force-pushed the tylerbeebe/trunk-23152-upgrade-notes branch from 1dc6f28 to 81f4092 Compare November 16, 2026 22:27
@acatxnamedvirtue
acatxnamedvirtue force-pushed the tylerbeebe/trunk-23149-23372-v2-key-or-jwt branch from 129c31b to 49c473e Compare November 16, 2026 22:55
@acatxnamedvirtue
acatxnamedvirtue force-pushed the tylerbeebe/trunk-23152-upgrade-notes branch 2 times, most recently from 4a9d96b to ca96e11 Compare November 16, 2026 23:07
@acatxnamedvirtue
acatxnamedvirtue force-pushed the tylerbeebe/trunk-23149-23372-v2-key-or-jwt branch from 89f03aa to 639c348 Compare November 17, 2026 13:18
@acatxnamedvirtue
acatxnamedvirtue force-pushed the tylerbeebe/trunk-23152-upgrade-notes branch 3 times, most recently from 20241aa to cdffc42 Compare November 17, 2026 13:29
@acatxnamedvirtue
acatxnamedvirtue force-pushed the tylerbeebe/trunk-23152-upgrade-notes branch from cdffc42 to 2506733 Compare November 17, 2026 15:41
@acatxnamedvirtue
acatxnamedvirtue changed the base branch from tylerbeebe/trunk-23149-23372-v2-key-or-jwt to main November 17, 2026 15:41
@trunk-io

trunk-io Bot commented Nov 17, 2026 •

Copy link
Copy Markdown

😎 Merged successfully - details.

acatxnamedvirtue and others added 6 commits November 17, 2026 18:37
UPGRADING.md lists what a 0.17.x user has to change for 1.0.0: a v2 API key
or JWT, a required test collection, the removed flags and variables, the
fork lane with no v1 fallback, the summary on stdout, GUID links, the
telemetry host, and which analytics-uploader versions pick up 1.0.0.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…-23152)

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…152)

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…otes (TRUNK-23152)

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…ly when promoted to latest (TRUNK-23152)

- The rspec gem 1.0.0 raises RSpec::Trunk::ConfigurationError without a
  collection id or with an organization token (#1337), with
  DISABLE_RSPEC_TRUNK_FLAKY_TESTS=true to opt out and a ~> 0.17.0 pin to stay.
- analytics-uploader v2.1.7 and older follow channel.json or GitHub's latest,
  which move only when 1.0.0 is promoted to latest (#1339).
- trunk CLI 0.0.14 runs analytics-cli 1.x unless pinned (trunk-io/trunk2#8640).

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
trunk-io/trunk2#8640 moves the trunk CLI's flakytests to channel-1.json,
so promote-latest no longer holds it back, and channel-1.json becomes a
pointer that must not be removed.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Users only ever pass a v2 API key: the Trunk JWT is how the trunk CLI
hands a credential to analytics-cli, so the user-facing docs drop it.
Also drop the channel pointer names, the fork lane's token swap, the
telemetry route and format, and the test link paths, keeping what a
user has to do.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@trunk-io
trunk-io Bot merged commit f205cf1 into main Nov 17, 2026
23 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

2 participants