build(ui-scripts): add prerelease option to the bump script for security releases

Author: HerrTopi

docs/contributor-docs/release.md

@@ -110,13 +110,17 @@ git checkout -b release
 
 ##### 3. Run Pnpm Bump Command
 
-- This will propose new version numbers.
+- This will propose new version numbers. It can be forced to generate certain versions: patch, minor, major. Also has a prerelease option that'll produce a security postfixed release for private, security releases.
 
 ```bash
 ---
 type: code
 ---
 pnpm run bump
+pnpm run bump:patch
+pnpm run bump:minor
+pnpm run bump:major
+pnpm run bump:prerelease
 ```
 
 - Check if the proposed version numbers are correct. If they are, accept them.

package.json

@@ -38,6 +38,10 @@
     "export:icons": "pnpm --filter @instructure/ui-icons export",
     "create-component-version": "ui-scripts create-component-version",
     "bump": "ui-scripts bump",
+    "bump:patch": "ui-scripts bump --releaseType=patch",
+    "bump:minor": "ui-scripts bump --releaseType=minor",
+    "bump:major": "ui-scripts bump --releaseType=major",
+    "bump:private": "ui-scripts bump --releaseType=prerelease",
     "release": "ui-scripts publish",
     "publish-private": "ui-scripts publish-private",
     "husky:pre-commit": "lint-staged && node scripts/checkTSReferences.js",

packages/ui-scripts/lib/commands/bump.js

@@ -44,18 +44,18 @@ const calcNextVersionType = () => {
 
 export default {
   command: 'bump',
-  desc: 'bump version in all package.json-s, generate changelogs and commit this change',
+  desc: "bump version in all package.json-s, generate changelogs and commit this change. Use the releaseType param to explicitely tell lerna what version to bump to. (patch, minor, major, prerelease. Prerelease means that it'll publish a security postfixed version)",
   builder: (yargs) => {
     yargs.option('releaseType', {
       type: 'string',
       describe:
-        'optional release type/version argument: major, minor, patch, [version]'
+        'optional release type/version argument: major, minor, patch, prerelease, [version]'
     })
   },
   handler: async (argv) => {
     const pkgJSON = pkgUtils.getPackageJSON(undefined)
-    // optional release type/version argument: major, minor, patch, [version]
-    // e.g. ui-scripts bump major
+    // optional release type/version argument: major, minor, patch, prerelease [version]
+    // e.g. ui-scripts bump --releaseType=major
     await bump(pkgJSON.name, argv.releaseType)
   }
 }

packages/ui-scripts/lib/utils/addNewExportsEntiresToPackageJSONs.js

@@ -35,12 +35,15 @@ import pkgUtils from './pkg-utils/index.js'
  * @param {string} version - Semver string (e.g. "11.9.0")
  */
 export const addNewExportsEntiresToPackageJSONs = async (version) => {
+  if (version.includes('SECURITY')) {
+    return
+  }
   const formattedVersion = `v${version.split('.').slice(0, 2).join('_')}`
   const packages = await pkgUtils.getDetailedPackageList()
 
   const res = packages.map(({ data, path }) => {
     //if no exports field, do nothing
-    if (!data.exports) {
+    if (!data?.exports) {
       return
     }
     //if the currently releasing version is already exists, do nothing

packages/ui-scripts/lib/utils/npm.js

@@ -59,7 +59,7 @@ export async function bumpPackages(packageName, requestedVersion) {
   let bumpVersion = requestedVersion
 
   if (bumpVersion) {
-    if (!['major', 'minor', 'patch'].includes(bumpVersion)) {
+    if (!['major', 'minor', 'patch', 'prerelease'].includes(bumpVersion)) {
       bumpVersion = semver.valid(bumpVersion)
 
       if (!bumpVersion) {
@@ -88,7 +88,8 @@ export async function bumpPackages(packageName, requestedVersion) {
       '--no-push', // do not execute `git push`
       '--no-git-tag-version', // do not add git tag or commit
       '--force-publish=*', // bump all packages even if they have no changes
-      '--conventional-commits' // determines new version and updates Changelog
+      '--conventional-commits', // determines new version and updates Changelog
+      '--preid=SECURITY' // postfixes releases if type is prerelease
     ])
 
     releaseVersion = await syncRootPackageVersion(true)