feat(semantic-release): adds last-release outputs

This adds outputs for `last-release-version` & `last-release-major-version`. This will allow us to determine if a breaking change has occurred.
open-turo · Sep 14, 2023 · 11fe39f · 11fe39f
1 parent 46ccef6
commit 11fe39f
Show file tree

Hide file tree

Showing 9 changed files with 57 additions and 9 deletions.
diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml
@@ -10,7 +10,9 @@ jobs:
     if: github.ref != 'refs/heads/main'
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
       - uses: ./release-notes-preview
         with:
           github-token: ${{ secrets.GITHUB_TOKEN }}

diff --git a/.github/workflows/update-dependencies.yaml b/.github/workflows/update-dependencies.yaml
@@ -22,7 +22,7 @@ jobs:
     if: false
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - uses: ./
         with:
           github-token: ${{ secrets.OPEN_TURO_GITHUB_TOKEN }}
diff --git a/.run/Template Jest.run.xml b/.run/Template Jest.run.xml
@@ -0,0 +1,9 @@
+<component name="ProjectRunConfigurationManager">
+  <configuration default="true" type="JavaScriptTestRunnerJest">
+    <node-interpreter value="project" />
+    <node-options value="--experimental-vm-modules" />
+    <envs />
+    <scope-kind value="ALL" />
+    <method v="2" />
+  </configuration>
+</component>
diff --git a/semantic-release/README.md b/semantic-release/README.md
@@ -45,10 +45,17 @@ jobs:
 
 ## Outputs
 
-| parameter             | description                                  |
-| --------------------- | -------------------------------------------- |
-| new-release-published | Whether a new release was published          |
-| new-release-notes     | The release notes for the new release if any |
+| parameter                  | description                                                                                                      |
+| -------------------------- | ---------------------------------------------------------------------------------------------------------------- |
+| new-release-published      | Whether a new release was published                                                                              |
+| new-release-notes          | The release notes for the new release if any                                                                     |
+| new-release-version        | Version of the new release                                                                                       |
+| new-release-major-version  | Major version of the new release                                                                                 |
+| new-release-minor-version  | Minor version of the new release                                                                                 |
+| new-release-patch-version  | Patch version of the new release                                                                                 |
+| new-release-type           | Type of the new release: 'prerelease' \| 'prepatch' \| 'patch' \| 'preminor' \| 'minor' \| 'premajor' \| 'major' |
+| last-release-version       | Version of the last release                                                                                      |
+| last-release-major-version | Major version of the last release                                                                                |
 
 ## Runs
 

diff --git a/semantic-release/action.yaml b/semantic-release/action.yaml
@@ -43,6 +43,15 @@ outputs:
   new-release-patch-version:
     description: "Patch version of the new release"
     value: ${{ steps.semantic-release.outputs.new-release-patch-version }}
+  new-release-type:
+    description: "Type of the new release: 'prerelease' | 'prepatch' | 'patch' | 'preminor' | 'minor' | 'premajor' | 'major'"
+    value: ${{ steps.semantic-release.outputs.new-release-type }}
+  last-release-version:
+    description: "Version of the last release"
+    value: ${{ steps.semantic-release.outputs.last-release-version }}
+  last-release-major-version:
+    description: "Major version of the last release"
+    value: ${{ steps.semantic-release.outputs.last-release-major-version }}
 
 runs:
   using: composite

diff --git a/semantic-release/dist/index.js b/semantic-release/dist/index.js
diff --git a/semantic-release/dist/index.js.map b/semantic-release/dist/index.js.map
diff --git a/semantic-release/src/index.ts b/semantic-release/src/index.ts
@@ -15,12 +15,15 @@ const __dirname = path.dirname(__filename);
 
 // enum with the outputs that the action has. this should be the same as action.yaml
 const OUTPUTS = {
+  last_release_major_version: "last-release-major-version",
+  last_release_version: "last-release-version",
   new_release_notes: "new-release-notes",
   new_release_published: "new-release-published",
   new_release_version: "new-release-version",
   new_release_major_version: "new-release-major-version",
   new_release_minor_version: "new-release-minor-version",
   new_release_patch_version: "new-release-patch-version",
+  new_release_type: "new-release-type",
 } as const;
 
 interface Inputs {
@@ -120,9 +123,15 @@ export async function main() {
       ),
     );
     if (result) {
-      const { nextRelease } = result;
+      const { lastRelease, nextRelease } = result;
+      setOutput(OUTPUTS.last_release_version, lastRelease.version);
+      setOutput(
+        OUTPUTS.last_release_major_version,
+        semver.major(lastRelease.version),
+      );
       if (nextRelease) {
         setOutput(OUTPUTS.new_release_published, "true");
+        setOutput(OUTPUTS.new_release_type, nextRelease.type);
         setOutput(OUTPUTS.new_release_notes, nextRelease.notes);
         setOutput(OUTPUTS.new_release_version, nextRelease.version);
         setOutput(

diff --git a/semantic-release/test/index.test.ts b/semantic-release/test/index.test.ts
@@ -107,10 +107,22 @@ describe("semantic-release", () => {
     `);
     expect(setOutputMock.mock.calls).toMatchInlineSnapshot(`
       [
+        [
+          "last-release-version",
+          "1.2.3-test",
+        ],
+        [
+          "last-release-major-version",
+          1,
+        ],
         [
           "new-release-published",
           "true",
         ],
+        [
+          "new-release-type",
+          "prerelease",
+        ],
         [
           "new-release-notes",
           "New Release notes",