verify.ts 2.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869
  1. /**
  2. * Verify a release family's version baseline, and — when publishing — that the
  3. * run comes from the family's tag and its members are publishable.
  4. *
  5. * Publication happens only from GitHub Actions, so the tag and publishability
  6. * checks are gates on the workflow, not advisory local warnings
  7. * ([rationale](../../.agents/notes/proposed/process/2026-08-10-npm-release-sequences.md)).
  8. */
  9. import { parseArgs } from 'node:util'
  10. import { releaseFamily, type ReleaseFamily, type ReleaseMember } from './families.ts'
  11. /**
  12. * Assert every member may be published: npm refuses a `private` package.
  13. * @param members - the family's members.
  14. */
  15. function verifyPublishable(members: readonly ReleaseMember[]): void {
  16. const priv = members.filter(member => member.manifest.private === true)
  17. if (priv.length > 0) {
  18. throw new Error(`publishing requires removing "private": true from:\n${priv.map(member => member.directory).join('\n')}`)
  19. }
  20. }
  21. /**
  22. * Assert the workflow runs from a tag this family publishes from, and that the
  23. * tag names a version the family actually carries.
  24. * @param family - the release family.
  25. * @param members - the family's members.
  26. * @param ref - the `GITHUB_REF` value.
  27. */
  28. function verifyTag(family: ReleaseFamily, members: readonly ReleaseMember[], ref: string): void {
  29. const prefix = 'refs/tags/'
  30. if (!ref.startsWith(prefix)) {
  31. throw new Error(`publishing release family ${family.id} requires running from a ${family.tagPrefix}* tag, got ${ref || '(no ref)'}`)
  32. }
  33. const tag = ref.slice(prefix.length)
  34. if (!tag.startsWith(family.tagPrefix)) {
  35. throw new Error(`tag ${tag} does not belong to release family ${family.id} (expected ${family.tagPrefix}*)`)
  36. }
  37. const expected = members.map(member => family.tagFor(member))
  38. if (!expected.includes(tag)) {
  39. throw new Error(`tag ${tag} names no version this family carries; its members would tag as:\n${[...new Set(expected)].join('\n')}`)
  40. }
  41. }
  42. /** Run the verification for the family named by `--family`. */
  43. function main(): void {
  44. const { values } = parseArgs({
  45. options: { family: { type: 'string' } },
  46. allowPositionals: false,
  47. })
  48. if (values.family === undefined) throw new Error('usage: verify.ts --family <dsh|vendor>')
  49. const family = releaseFamily(values.family)
  50. const members = family.members(process.cwd())
  51. family.verifyVersions(members)
  52. const publishing = process.env.RELEASE_PUBLISH === 'true'
  53. if (publishing) {
  54. verifyPublishable(members)
  55. verifyTag(family, members, process.env.GITHUB_REF ?? '')
  56. }
  57. const versions = [...new Set(members.map(member => member.version))]
  58. const summary = versions.length === 1 ? versions[0] : `${String(versions.length)} versions`
  59. console.log(`release verify: family ${family.id}, ${String(members.length)} member(s), ${summary}${publishing ? ', publish gates passed' : ''}`)
  60. }
  61. main()