Publish @scality/breakbeat to npm and GitHub Packages

[francoisferrand]

breakbeat is installed straight from a git ref today, so it compiles on every consumer install. That is why typescript sits in dependencies: a compiler has to be present wherever the package lands, which means shipping one into every consumer's production image. Publishing a built artifact removes the whole arrangement — and with it a class of install-time breakage we keep hitting on newer Node.

Same setup as Arsenal (ARSN-605): scoped name, files: ["lib"], build at pack time, and a release workflow dispatched by hand with the tag to publish.

Breaking for consumers

The package is now @scality/breakbeat, so backbeat and scuba have to move their dependency key and every require/import over to the scoped name — roughly 13 call sites, and backbeat carries the dependency on 9 development branches. Follow-up tickets needed; nothing here works for them until that happens. scuba is the one to do first: it imports in TypeScript, so it exercises the type resolution.

That is also why this is 1.1.0 rather than 1.0.4 — a patch number would say "no action needed" while requiring every consumer to be edited. If you would rather land the publishing setup on development/1.0 and decide the version separately, dropping the last commit does exactly that: the workflow refuses to release at 1.0.3 because that tag already exists, so nothing can go out by accident.

declaration: true

Worth flagging, because it is easy to read as tidy-up. Declarations were never emitted — scuba's imports resolve types from the raw .ts sources that a git install happens to include. Those stop shipping with files: ["lib"], so without this the published package would break scuba's build while the diff looked fine.

Before the first release

@scality/breakbeat does not exist on npmjs yet, and npm will not let you configure a trusted publisher for a package that has never been published. The npm job authenticates over OIDC with no token, so the first dispatch will fail on auth until someone publishes one version by hand and sets the trusted publisher up. Noted in the workflow next to the publish step.

If it is dispatched before that, it fails safely: no tag and no release are created, GitHub Packages has already succeeded, and re-dispatching afterwards skips what is already published.

Verified

Packed the tarball and installed it into a clean consumer: no typescript and no tsc anywhere in the tree, require works, and a TypeScript consumer typechecks against the shipped declarations — including under TS 4.8.3, which is the oldest compiler among the consumers, with skipLibCheck: false. Deleting the .d.ts from the tarball reproduces the failure, so the check means something. Git-ref installs still build, so consumers will not break mid-migration.

Issue: BREAK-12

[bert-e]

Hello francoisferrand,

My role is to assist you with the merge of this
pull request. Please type @bert-e help to get information
on this process, or consult the user documentation.

Available options

name	description	privileged	authored
/after_pull_request	Wait for the given pull request id to be merged before continuing with the current one.
/bypass_author_approval	Bypass the pull request author's approval	⭐
/bypass_build_status	Bypass the build and test status	⭐
/bypass_commit_size	Bypass the check on the size of the changeset TBA	⭐
/bypass_incompatible_branch	Bypass the check on the source branch prefix	⭐
/bypass_jira_check	Bypass the Jira issue check	⭐
/bypass_peer_approval	Bypass the pull request peers' approval	⭐
/bypass_leader_approval	Bypass the pull request leaders' approval	⭐
/bypass_source_branch_lineage	Bypass the cross-branch contamination check	⭐
/approve	Instruct Bert-E that the author has approved the pull request.		✍️
/create_pull_requests	Allow the creation of integration pull requests.
/create_integration_branches	Allow the creation of integration branches.
/no_octopus	Prevent Wall-E from doing any octopus merge and use multiple consecutive merge instead
/unanimity	Change review acceptance criteria from one reviewer at least to all reviewers
/wait	Instruct Bert-E not to run until further notice.

Available commands

name	description	privileged
/help	Print Bert-E's manual in the pull request.
/status	Print Bert-E's current status in the pull request.
/clear	Remove all comments from Bert-E from the history TBA
/retry	Re-start a fresh build TBA
/build	Re-start a fresh build TBA
/force_reset	Delete integration branches & pull requests, and restart merge process from the beginning.
/reset	Try to remove integration branches unless there are commits on them which do not appear on the source branch.

Status report is not available.

[SylvainSenechal]

The PR description + commit says 1.1, but the pr targets 1.0

[SylvainSenechal]

Don't we have a setup on other repo where we don't even have to pass the tag now ?

[SylvainSenechal]

Yeah we did it in Arsenal

[francoisferrand]

the problem is package.json is sometimes not updated - especially in packages which are seldom modified; so I'd rather keep it this way, and change everywhere once we have a safer way to handle it (like, not coming the version in package.json :-) )

[bert-e]

Waiting for approval

The following approvals are needed before I can proceed with the merge:

• the author

• 2 peers

[francoisferrand]

/approve

[bert-e]

I have successfully merged the changeset of this pull request
into targetted development branches:

• ✔️ development/1.1

The following branches have NOT changed:

• development/1.0

Please check the status of the associated issue BREAK-12.

Goodbye francoisferrand.

The following options are set: approve