chore: updates tests with publish rollback, adds new demo gif

Author: geotrev

.release-workspaces.json

@@ -1,5 +1,5 @@
 {
   "metadata": {
-    "version": "0.7.14"
+    "version": "0.7.18"
   }
 }

README.md

@@ -5,7 +5,7 @@
   <a href="https://github.com/geotrev/release-workspaces/blob/main/LICENSE"><img src="https://img.shields.io/npm/l/release-workspaces.svg?sanitize=true&style=flat-square" alt="License"></a>
   <a href="https://github.com/geotrev/release-workspaces/actions/workflows/test.yml?query=branch%3Amain"><img src="https://badgen.net/github/checks/geotrev/release-workspaces/main?style=flat-square" alt="CI status" /></a>
   <div align="center">
-    <img width="600px" height="auto" src="https://github.com/geotrev/release-workspaces/raw/main/demo2.gif" />
+    <img width="500px" height="auto" src="https://github.com/geotrev/release-workspaces/raw/main/demo3.gif" />
   </div>
 </p>
 

bin/__tests__/git.spec.js

@@ -2,7 +2,7 @@ import "../../.jest/mocks.js"
 import { ReportSteps } from "../helpers/constants.js"
 import { getCommitCmd, getTagCmd, getPushCmd } from "../helpers/commands.js"
 import { setVersionToString } from "../helpers/transformers.js"
-import { setRollback } from "../helpers/rollback.js"
+import { queueRollback } from "../helpers/rollback.js"
 import { reportCmd } from "../helpers/cmd.js"
 import { runGit } from "../modules/git.js"
 
@@ -12,7 +12,7 @@ jest.mock("../helpers/cmd.js", () => ({
 }))
 
 jest.mock("../helpers/rollback.js", () => ({
-  setRollback: jest.fn(),
+  queueRollback: jest.fn(),
 }))
 
 const baseConfig = {
@@ -91,8 +91,8 @@ describe("runGit()", () => {
       )
     })
 
-    it("calls setRollback", async () => {
-      expect(setRollback).toBeCalledWith(
+    it("calls queueRollback", async () => {
+      expect(queueRollback).toBeCalledWith(
         expect.objectContaining(config),
         expect.objectContaining({
           type: "commit",
@@ -167,8 +167,8 @@ describe("runGit()", () => {
       )
     })
 
-    it("calls setRollback", async () => {
-      expect(setRollback).toBeCalledWith(
+    it("calls queueRollback", async () => {
+      expect(queueRollback).toBeCalledWith(
         expect.objectContaining(config),
         expect.objectContaining({
           type: "tag",

bin/__tests__/npm.spec.js

@@ -4,7 +4,7 @@ import { ReportSteps } from "../helpers/constants.js"
 import { getAddCommand } from "../helpers/commands.js"
 import { report } from "../helpers/reporter.js"
 import { reportCmd, cmd } from "../helpers/cmd.js"
-import { setRollback } from "../helpers/rollback.js"
+import { queueRollback } from "../helpers/rollback.js"
 import { setRootVersion } from "../helpers/set-root-version.js"
 import { runNpm } from "../modules/npm.js"
 import { runIncrement } from "../modules/increment.js"
@@ -21,7 +21,7 @@ jest.mock("../helpers/set-root-version.js", () => ({
   setRootVersion: jest.fn(),
 }))
 jest.mock("../helpers/rollback.js", () => ({
-  setRollback: jest.fn(),
+  queueRollback: jest.fn(),
 }))
 jest.mock("../modules/increment.js", () => ({
   runIncrement: jest.fn(),
@@ -140,14 +140,27 @@ describe("runNpm()", () => {
       // When
       await runNpm(config)
       // Then
-      expect(setRollback).toBeCalledWith(
+      expect(queueRollback).toBeCalledWith(
         expect.objectContaining(config),
         expect.objectContaining({
           type: "increment",
           callback: expect.any(Function),
         })
       )
     })
+
+    it("adds publish action", async () => {
+      // when
+      await runNpm(config)
+      // Then
+      expect(queueRollback).toBeCalledWith(
+        expect.objectContaining(config),
+        expect.objectContaining({
+          type: "publish",
+          callback: expect.any(Function),
+        })
+      )
+    })
   })
 
   describe("hooks", () => {

bin/__tests__/publish.spec.js

@@ -12,7 +12,7 @@ jest.mock("../helpers/reporter.js", () => ({
   report: jest.fn(),
 }))
 jest.mock("../helpers/rollback.js", () => ({
-  setRollback: jest.fn(),
+  queueRollback: jest.fn(),
 }))
 
 const entry = {

bin/helpers/rollback.js

@@ -30,7 +30,7 @@ export function disableRollback() {
   process.off("exit", rollback)
 }
 
-export function setRollback(config, action) {
+export function queueRollback(config, action) {
   if (config.dryRun) return
   rollbackActions.push(action)
 }

bin/modules/git.js

@@ -4,7 +4,7 @@ import { ReportSteps } from "../helpers/constants.js"
 import { getCommitCmd, getTagCmd, getPushCmd } from "../helpers/commands.js"
 import { setVersionToString } from "../helpers/transformers.js"
 import { cmd, reportCmd } from "../helpers/cmd.js"
-import { setRollback } from "../helpers/rollback.js"
+import { queueRollback } from "../helpers/rollback.js"
 
 export async function runGit(config) {
   const {
@@ -31,7 +31,7 @@ export async function runGit(config) {
       step: ReportSteps.COMMIT,
     })
 
-    setRollback(config, {
+    queueRollback(config, {
       type: "commit",
       callback: async () => {
         await cmd("git reset --hard HEAD~1", config)
@@ -52,7 +52,7 @@ export async function runGit(config) {
       await reportCmd(pretag, { ...config, step: ReportSteps.PRETAG })
     }
 
-    setRollback(config, {
+    queueRollback(config, {
       type: "tag",
       callback: async () => {
         await cmd(`git tag --delete v${config.releaseVersion}`, config)

bin/modules/npm.js

@@ -6,7 +6,7 @@ import { getAddCommand } from "../helpers/commands.js"
 import { cmd, reportCmd } from "../helpers/cmd.js"
 import { runIncrement } from "./increment.js"
 import { runPublish } from "./publish.js"
-import { setRollback } from "../helpers/rollback.js"
+import { queueRollback } from "../helpers/rollback.js"
 import { setRootVersion } from "../helpers/set-root-version.js"
 
 export async function runNpm(config) {
@@ -15,7 +15,7 @@ export async function runNpm(config) {
     npm: { increment, publish },
   } = config
 
-  setRollback(config, {
+  queueRollback(config, {
     type: "increment",
     callback: async () => {
       await cmd("git reset --hard HEAD", config)
@@ -49,6 +49,18 @@ export async function runNpm(config) {
       await reportCmd(prepublish, { ...config, step: ReportSteps.PREPUBLISH })
     }
 
+    queueRollback(config, {
+      type: "publish",
+      callback: async () => {
+        for (const pkg of config.packages) {
+          await cmd(
+            `npm deprecate ${pkg.name}@${config.releaseVersion}`,
+            config
+          )
+        }
+      },
+    })
+
     await runPublish(config)
 
     if (postpublish) {