Add support for GitHub container actions

README.md

@@ -14,15 +14,16 @@
 Gets the [Semantic Version](https://semver.org/) of a repository based on the
 type of manifest file located. This action currently supports the following:
 
-| Language | Manifest File    |
-| -------- | ---------------- |
-| Dart     | `pubspec.yaml`   |
-| Node.js  | `package.json`   |
-| Python   | `pyproject.toml` |
-|          | `setup.cfg`      |
-|          | `setup.py`       |
-| Java     | `pom.xml`        |
-| _Other_  | `.version`       |
+| Language                   | Manifest File    |
+| -------------------------- | ---------------- |
+| Dart                       | `pubspec.yaml`   |
+| GitHub Actions (Container) | `action.yml`     |
+| Java                       | `pom.xml`        |
+| Node.js                    | `package.json`   |
+| Python                     | `pyproject.toml` |
+|                            | `setup.cfg`      |
+|                            | `setup.py`       |
+| _Other_                    | `.version`       |
 
 > [!TIP]
 >

__fixtures__/invalid/github/action.yaml

@@ -0,0 +1,17 @@
+name: The name of your action here
+description: Provide a description here
+author: Your name or organization here
+
+inputs:
+  who-to-greet:
+    description: Your input description here
+    required: true
+    default: World
+
+outputs:
+  greeting:
+    description: Your output description here
+
+runs:
+  using: node20
+  main: dist/index.js

__fixtures__/invalid/github/action.yml

@@ -0,0 +1,19 @@
+name: The name of your action here
+description: Provide a description here
+author: Your name or organization here
+
+inputs:
+  who-to-greet:
+    description: Your input description here
+    required: true
+    default: World
+
+outputs:
+  greeting:
+    description: Your output description here
+
+runs:
+  using: docker
+  image: docker://ghcr.io/actions/container-prebuilt-action:latest
+  env:
+    INPUT_WHO_TO_GREET: ${{ inputs.who-to-greet }}

__fixtures__/valid/github/action.yaml

@@ -0,0 +1,22 @@
+name: The name of your action here
+description: Provide a description here
+author: Your name or organization here
+
+# Define your inputs here.
+inputs:
+  who-to-greet:
+    description: Your input description here
+    required: true
+    default: World
+
+# Define your outputs here.
+outputs:
+  greeting:
+    description: Your output description here
+
+# Update the image repository and tag below.
+runs:
+  using: docker
+  image: docker://ghcr.io/actions/container-prebuilt-action:v1.2.3
+  env:
+    INPUT_WHO_TO_GREET: ${{ inputs.who-to-greet }}

__fixtures__/valid/github/action.yml

@@ -0,0 +1,22 @@
+name: The name of your action here
+description: Provide a description here
+author: Your name or organization here
+
+# Define your inputs here.
+inputs:
+  who-to-greet:
+    description: Your input description here
+    required: true
+    default: World
+
+# Define your outputs here.
+outputs:
+  greeting:
+    description: Your output description here
+
+# Update the image repository and tag below.
+runs:
+  using: docker
+  image: docker://ghcr.io/actions/container-prebuilt-action:v1.2.3
+  env:
+    INPUT_WHO_TO_GREET: ${{ inputs.who-to-greet }}

__tests__/version.test.ts

@@ -60,6 +60,18 @@ describe('version.ts', () => {
     expect(
       Version.infer('../__fixtures__/valid/java/pom.xml', __dirname)?.toString()
     ).toEqual('8.0.0')
+    expect(
+      Version.infer(
+        '../__fixtures__/valid/github/action.yaml',
+        __dirname
+      )?.toString()
+    ).toEqual('1.2.3')
+    expect(
+      Version.infer(
+        '../__fixtures__/valid/github/action.yml',
+        __dirname
+      )?.toString()
+    ).toEqual('1.2.3')
     expect(
       Version.infer(
         '../__fixtures__/valid/python/pyproject.toml',
@@ -104,11 +116,17 @@ describe('version.ts', () => {
     ).toEqual('1.2.3-alpha.4+build.5')
   })
 
-  it('does not infer the version from invalid manifests', async () => {
+  it('Does not infer the version from invalid manifests', async () => {
     // Pass each invalid manifest file
     expect(
       Version.infer('../__fixtures__/invalid/java/pom.xml', __dirname)
     ).toEqual(undefined)
+    expect(
+      Version.infer('../__fixtures__/invalid/github/action.yaml', __dirname)
+    ).toEqual(undefined)
+    expect(
+      Version.infer('../__fixtures__/invalid/github/action.yml', __dirname)
+    ).toEqual(undefined)
     expect(
       Version.infer('../__fixtures__/invalid/python/pyproject.toml', __dirname)
     ).toEqual(undefined)
@@ -171,7 +189,7 @@ describe('version.ts', () => {
     ).toBe(undefined)
   })
 
-  it('Rhrows an error if a manifest path is invalid', async () => {
+  it('Throws an error if a manifest path is invalid', async () => {
     try {
       expect(Version.infer('path/to/', __dirname)).toThrow()
     } catch (error) {

package.json

@@ -1,7 +1,7 @@
 {
   "name": "issue-ops-semver",
   "description": "Semantically version GitHub repository tags",
-  "version": "2.1.0",
+  "version": "2.2.0",
   "type": "module",
   "author": "Nick Alteen <ncalteen@github.com>",
   "homepage": "https://github.com/issue-ops/semver#readme",

src/version.ts

@@ -112,12 +112,31 @@ export class Version {
     const manifestFile: string = items[items.length - 1]
     core.info(`Manifest file: ${manifestFile}`)
 
+    // Ref: https://semver.org/#is-there-a-suggested-regular-expression-regex-to-check-a-semver-string
+    const regex =
+      /^v?(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$/gm
+
     if (manifestFile === '')
       throw new Error(`Invalid manifest path: ${manifestPath}`)
 
     // Functions for parsing each type of manifest file
-    // eslint-disable-next-line no-unused-vars
     const parser: { [k: string]: (body: string) => string | undefined } = {
+      'action.yml': (body: string): string | undefined => {
+        return yaml
+          .parse(body)
+          .runs?.image?.split(':')
+          ?.slice(-1)?.[0]
+          .match(regex)?.[0]
+          .replace('v', '')
+      },
+      'action.yaml': (body: string): string | undefined => {
+        return yaml
+          .parse(body)
+          .runs?.image?.split(':')
+          ?.slice(-1)?.[0]
+          .match(regex)?.[0]
+          .replace('v', '')
+      },
       'package.json': (body: string): string | undefined => {
         return JSON.parse(body).version
       },
@@ -141,10 +160,7 @@ export class Version {
         return yamlBody.version
       },
       '.version': (body: string): string | undefined => {
-        // Ref: https://semver.org/#is-there-a-suggested-regular-expression-regex-to-check-a-semver-string
-        return body.match(
-          /^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$/gm
-        )?.[0]
+        return body.match(regex)?.[0]?.replace('v', '')
       }
     }