Skip to content

release/RELEASE-NOTES-TEMPLATE.md 'Included Packages' table is stale — missing sc-sha (crates.io + PyPI) and Scoop #502

Description

@randlee

Summary

The release-notes template's Included Packages table does not match the actual publish surface defined in release/publish-artifacts.toml and RELEASING.md. Anyone filling it out for 1.4.2 would under-report what shipped.

Current template

| Package | Version | Channel |
|---------|---------|---------|
| `sc-composer` | <VERSION> | crates.io |
| `sc-compose` | <VERSION> | crates.io · Homebrew · Winget · GitHub Releases |
| `sc-compose` (Python) | <VERSION> | PyPI |

Actual surface

release/publish-artifacts.toml declares three crates and two Python distributions:

  • crates: sc-sha (publish_order 1), sc-composer (2), sc-compose (3)
  • python_distributions: sc-sha, sc-compose
  • channels: pypi, homebrew, scoop (randlee/scoop-bucket), winget

RELEASING.md's Overview table lists six channels including Scoop.

Missing from the template: sc-sha on crates.io, sc-sha on PyPI, and the Scoop channel on sc-compose.

Required fix

Update the table in release/RELEASE-NOTES-TEMPLATE.md to match the manifest:

| `sc-sha` | <VERSION> | crates.io · PyPI |
| `sc-composer` | <VERSION> | crates.io |
| `sc-compose` | <VERSION> | crates.io · PyPI · Homebrew · Scoop · Winget · GitHub Releases |

Ideally this table should be generated from release/publish-artifacts.toml rather than hand-maintained, since the manifest is the declared SSoT and this is the second doc found drifting from it (see also #500).

Found during 1.4.2 release verification by publisher.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions