Skip to content

refactor(releases): use @heroku/sdk - #3888

Merged
erika-wallace merged 3 commits into
v12.0.0from
ew/sdk-migration-releases
Aug 26, 2026
Merged

refactor(releases): use @heroku/sdk#3888
erika-wallace merged 3 commits into
v12.0.0from
ew/sdk-migration-releases

Conversation

@erika-wallace

@erika-wallace erika-wallace commented Aug 26, 2026

Copy link
Copy Markdown
Contributor

Summary

This PR migrates the following releases commands to use @heroku/sdk:

  • releases/index
  • releases/info
  • releases/output
  • releases/retry
  • releases/rollback

Details:

  • Replaced direct API calls with the SDK
  • Rewrote tests to stub the SDK directly instead of using nock

Type of Change

Breaking Changes (major semver update)

  • Add a ! after your change type to denote a change that breaks current behavior

Feature Additions (minor semver update)

  • feat: Introduces a new feature to the codebase

Patch Updates (patch semver update)

  • fix: Bug fix
  • deps: Dependency upgrade
  • revert: Revert a previous commit
  • chore: Change that does not affect production code
  • refactor: Refactoring existing code without changing behavior
  • test: Add/update/remove tests

Testing

Notes:

The SDK uses heroku-fetch to make API calls, which looks for a netrc file. Therefore, we must log in with HEROKU_NETRC_WRITE=true. Requires an app with a release-phase command. The test-app-release-phase app should work.

Setup:

  • Pull down this branch
  • npm i && npm run build
  • heroku logout
  • HEROKU_NETRC_WRITE=true ./bin/run login

Steps:

# List releases
./bin/run releases --app $APP

# View latest release info
./bin/run releases:info --app $APP

# View latest release output
./bin/run releases:output --app $APP

# Retry latest release
./bin/run releases:retry --app $APP

# Confirm retried release
./bin/run releases --app $APP

# Rollback to previous release
./bin/run releases:rollback --app $APP

# Confirm rollback
./bin/run releases --app $APP

Screenshots (if applicable)

Related Issues

GUS work item: W-23387919

@erika-wallace
erika-wallace requested a review from a team as a code owner August 26, 2026 18:10
@erika-wallace
erika-wallace deployed to AcceptanceTests August 26, 2026 18:10 — with GitHub Actions Active
@erika-wallace
erika-wallace deployed to AcceptanceTests August 26, 2026 18:10 — with GitHub Actions Active
@erika-wallace
erika-wallace deployed to AcceptanceTests August 26, 2026 18:10 — with GitHub Actions Active
@erika-wallace
erika-wallace deployed to AcceptanceTests August 26, 2026 18:10 — with GitHub Actions Active
@erika-wallace
erika-wallace force-pushed the ew/sdk-migration-releases branch from 8d82de0 to 78ca80c Compare August 26, 2026 18:11
@erika-wallace
erika-wallace deployed to AcceptanceTests August 26, 2026 18:11 — with GitHub Actions Active
@erika-wallace
erika-wallace deployed to AcceptanceTests August 26, 2026 18:11 — with GitHub Actions Active
@erika-wallace
erika-wallace deployed to AcceptanceTests August 26, 2026 18:11 — with GitHub Actions Active
@erika-wallace
erika-wallace deployed to AcceptanceTests August 26, 2026 18:11 — with GitHub Actions Active
@erika-wallace
erika-wallace deployed to AcceptanceTests August 26, 2026 18:22 — with GitHub Actions Active
@erika-wallace
erika-wallace deployed to AcceptanceTests August 26, 2026 18:22 — with GitHub Actions Active
@erika-wallace
erika-wallace deployed to AcceptanceTests August 26, 2026 18:22 — with GitHub Actions Active
@erika-wallace
erika-wallace deployed to AcceptanceTests August 26, 2026 18:22 — with GitHub Actions Active

@jdodson jdodson left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approved. Notes below.

  • Reviewed personally, looks good.
  • Grok reviewed, no blockers.
  • Manually tested with steps, all passed!

@erika-wallace
erika-wallace merged commit a645c81 into v12.0.0 Aug 26, 2026
22 checks passed
@erika-wallace
erika-wallace deleted the ew/sdk-migration-releases branch August 26, 2026 19:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants