Releasing#
This page sets out the steps to release Pinstripe, from the CHANGELOG to the npm publish.
-
Move the lines under
## UnreleasedinCHANGELOG.mdto a new## X.Y.Z (YYYY-MM-DD)heading. -
Set the same version in
package.json, in the same release commit:tests/PackageVersionTest.phpfails otherwise. In the same commit, rewrite the front page's "Just off the cutting table" note (site/index.html, thencomposer site:agent-ready) to lead with the new version and what it brought:tests/FrontPageTest.phpfails while it names an older one. And rename the## Unreleaseddraft indocs/upgrading.mdto the same## X.Y.Z (YYYY-MM-DD)heading (write the section if there is no draft: what changed for an app, the steps, how to verify):tests/UpgradingTest.phpfails while a release has no section there. -
composer ciandnpm testgreen locally, then the git.wayne.edu pipeline green for that commit. -
Run a secrets scan of the history and check that nothing internal is in the tree.
-
Tag
X.Y.Z(nov) on git.wayne.edu. The push mirror carries the tag to GitHub, and Packagist picks it up from there. -
npm is published by hand, after the tag, from a clean checkout of the tagged commit, by an owner of the
@waynestatenpm scope with two-factor auth:npm ci --ignore-scripts npm test npm pack --dry-run npm publish --access publicnpm pack --dry-runshould list onlyeslint/,prettier/,LICENSE,README.mdandpackage.json. Publishing cannot be undone, so check the version first withnpm view @waynestate/pinstripe version. -
A release needs a maintainer's approval. Never move or delete a published tag.