✨ Add short SHA output

README.md

@@ -34,12 +34,13 @@ All inputs are optional, and sensible defaults will be used if they are not set.
 
 The following outputs can be used by subsequent workflow steps.
 
-| Name     | Description                                                | Example                                    |
-| -------- | ---------------------------------------------------------- | ------------------------------------------ |
-| describe | `git describe --tags`-like description.                    | `v1.5.4-2-g4fdf9d0`                        |
-| tag      | The most recent tag.                                       | `v1.5.4`                                   |
-| distance | The number of additional commits from the most recent tag. | `2`                                        |
-| sha      | The object name for the commit itself.                     | `4fdf9d0b88fe5f55e465ae947bca6b6b55c39415` |
+| Name      | Description                                                | Example                                    |
+| --------- | ---------------------------------------------------------- | ------------------------------------------ |
+| describe  | `git describe --tags`-like description.                    | `v1.5.4-2-g4fdf9d0`                        |
+| tag       | The most recent tag.                                       | `v1.5.4`                                   |
+| distance  | The number of additional commits from the most recent tag. | `2`                                        |
+| sha       | The object name for the commit itself.                     | `4fdf9d0b88fe5f55e465ae947bca6b6b55c39415` |
+| short-sha | The object name for the commit itself.                     | `4fdf9d0`                                  |
 
 Step outputs can be accessed using the following example.\
 Note that in order to read the step outputs, the action step must have an ID.

action.yml

@@ -41,6 +41,10 @@ outputs:
     description: >
       The object name for the commit itself.
       ex) 2414721
+  short-sha:
+    description: >
+      The object name for the commit itself.
+      ex) 2414721
 
 runs:
   using: node16

actions/main.ts

@@ -16,7 +16,7 @@ async function run() {
 
   try {
     Deno.env.set("GITHUB_TOKEN", token);
-    const { describe, tag, distance, sha } = await ghDescribe({
+    const { describe, tag, distance, sha, shortSha } = await ghDescribe({
       repo,
       commitish,
       defaultTag,
@@ -29,6 +29,7 @@ async function run() {
     setOutput("tag", tag);
     setOutput("distance", distance);
     setOutput("sha", sha);
+    setOutput("short-sha", shortSha);
   } catch (e: unknown) {
     if (e instanceof GhDescribeError) {
       setFailed(`fatal: ${e.message}`);

core/gh_describe.ts

@@ -65,6 +65,11 @@ export interface GhDescribeOutput {
    * Object name for the commit itself.
    */
   sha: string;
+
+  /**
+   * Abbreviated object name for the commit itself.
+   */
+  shortSha: string;
 }
 
 export function createDescribe(tag: string, distance: number, sha: string) {
@@ -106,5 +111,11 @@ export async function ghDescribe(options?: GhDescribeOptions): Promise<GhDescrib
   }
 
   const describe = createDescribe(tag, distance, sha);
-  return { describe, tag, distance, sha };
+  return {
+    describe,
+    tag,
+    distance,
+    sha,
+    shortSha: sha.substring(0, 7),
+  };
 }

dist/actions.js

@@ -25254,7 +25254,13 @@ async function ghDescribe(options) {
     throw new GhDescribeError("No names found, cannot describe anything.");
   }
   const describe = createDescribe(tag, distance, sha);
-  return { describe, tag, distance, sha };
+  return {
+    describe,
+    tag,
+    distance,
+    sha,
+    shortSha: sha.substring(0, 7)
+  };
 }
 
 // dist/dnt/esm/actions/main.js

dist/cli.js

@@ -10549,7 +10549,13 @@ async function ghDescribe(options) {
     throw new GhDescribeError("No names found, cannot describe anything.");
   }
   const describe2 = createDescribe(tag, distance2, sha);
-  return { describe: describe2, tag, distance: distance2, sha };
+  return {
+    describe: describe2,
+    tag,
+    distance: distance2,
+    sha,
+    shortSha: sha.substring(0, 7)
+  };
 }
 
 // dist/dnt/esm/cli/cli.js