Merge pull request #240 from actions/joshmgross/document-esm

Add an example using ESM `import`
Merge pull request #239 from actions/joshmgross/v6
2026-10-15 20:06:55 +00:00 · 2022-02-11 10:21:32 -05:00 · 2022-02-11 10:21:20 -05:00 · 2022-02-11 10:19:36 -05:00 · 2022-02-11 10:19:26 -05:00 · 2022-02-09 16:17:11 -05:00
11 changed files with 252 additions and 1961 deletions
@@ -32,7 +32,15 @@ defined, so you don't have to import them (see examples below).
 See [octokit/rest.js](https://octokit.github.io/rest.js/) for the API client
 documentation.

-## Breaking changes in V5
+## Breaking Changes
+
+### Breaking changes in V6
+
+Version 6 of this action updated the runtime to Node 16 - https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions#example-using-nodejs-v16
+
+All scripts are now run with Node 16 instead of Node 12 and are affected by any breaking changes between Node 12 and 16.
+
+### Breaking changes in V5

 Version 5 of this action includes the version 5 of `@actions/github` and `@octokit/plugin-rest-endpoint-methods`. As part of this update, the Octokit context available via `github` no longer has REST methods directly. These methods are available via `github.rest.*` - https://github.com/octokit/plugin-rest-endpoint-methods.js/releases/tag/v5.0.0

@@ -50,7 +58,7 @@ The return value of the script will be in the step's outputs under the
 "result" key.

 ```yaml
- uses: actions/github-script@v5
+- uses: actions/github-script@v6
  id: set-result
  with:
    script: return "Hello!"
@@ -69,7 +77,7 @@ output of a github-script step. For some workflows, string encoding is preferred
 `result-encoding` input:

 ```yaml
- uses: actions/github-script@v5
+- uses: actions/github-script@v6
  id: my-script
  with:
    result-encoding: string
@@ -87,7 +95,7 @@ By default, github-script will use the token provided to your workflow.

 ```yaml
 - name: View context attributes
-  uses: actions/github-script@v5
+  uses: actions/github-script@v6
  with:
    script: console.log(context)
 ```
@@ -103,7 +111,7 @@ jobs:
  comment:
    runs-on: ubuntu-latest
    steps:
-      - uses: actions/github-script@v5
+      - uses: actions/github-script@v6
        with:
          script: |
            github.rest.issues.createComment({
@@ -125,7 +133,7 @@ jobs:
  apply-label:
    runs-on: ubuntu-latest
    steps:
-      - uses: actions/github-script@v5
+      - uses: actions/github-script@v6
        with:
          script: |
            github.rest.issues.addLabels({
@@ -145,7 +153,7 @@ jobs:
  welcome:
    runs-on: ubuntu-latest
    steps:
-      - uses: actions/github-script@v5
+      - uses: actions/github-script@v6
        with:
          script: |
            // Get a list of all issues created by the PR opener
@@ -188,7 +196,7 @@ jobs:
  diff:
    runs-on: ubuntu-latest
    steps:
-      - uses: actions/github-script@v5
+      - uses: actions/github-script@v6
        with:
          script: |
            const diff_url = context.payload.pull_request.diff_url
@@ -212,7 +220,7 @@ jobs:
  list-issues:
    runs-on: ubuntu-latest
    steps:
-      - uses: actions/github-script@v5
+      - uses: actions/github-script@v6
        with:
          script: |
            const query = `query($owner:String!, $name:String!, $label:String!) {
@@ -246,7 +254,7 @@ jobs:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
-      - uses: actions/github-script@v5
+      - uses: actions/github-script@v6
        with:
          script: |
            const script = require('./path/to/script.js')
@@ -284,7 +292,7 @@ jobs:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
-      - uses: actions/github-script@v5
+      - uses: actions/github-script@v6
        env:
          SHA: '${{env.parentSHA}}'
        with:
@@ -328,7 +336,7 @@ jobs:
      - run: npm ci
      # or one-off:
      - run: npm install execa
-      - uses: actions/github-script@v5
+      - uses: actions/github-script@v6
        with:
          script: |
            const execa = require('execa')
@@ -338,6 +346,31 @@ jobs:
            console.log(stdout)
 ```

+### Use ESM `import`
+
+To import an ESM file, you'll need to reference your script by an absolute path and ensure you have a `package.json` file with `"type": "module"` specified.
+
+For a script in your repository `src/print-stuff.js`:
+```js
+export default function printStuff() { console.log('stuff') }
+```
+
+```yaml
+on: push
+
+jobs:
+  print-stuff:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/github-script@v6
+        with:
+          script: |
+            const { default: printStuff } = await import('${{ github.workspace }}/src/print-stuff.js')
+
+            await printStuff()
+```
+
 ### Use env as input

 You can set env vars to use them in your script:
@@ -349,7 +382,7 @@ jobs:
  echo-input:
    runs-on: ubuntu-latest
    steps:
-      - uses: actions/github-script@v5
+      - uses: actions/github-script@v6
        env:
          FIRST_NAME: Mona
          LAST_NAME: Octocat
@@ -377,7 +410,7 @@ jobs:
  apply-label:
    runs-on: ubuntu-latest
    steps:
-      - uses: actions/github-script@v5
+      - uses: actions/github-script@v6
        with:
          github-token: ${{ secrets.MY_PAT }}
          script: |
@@ -27,5 +27,5 @@ outputs:
  result:
    description: The return value of the script, stringified with `JSON.stringify`
 runs:
-  using: node12
+  using: node16
  main: dist/index.js
@@ -1,15 +1,15 @@
 {
  "name": "github-script",
-  "version": "5.2.0",
+  "version": "5.1.0",
  "lockfileVersion": 2,
  "requires": true,
  "packages": {
    "": {
      "name": "github-script",
-      "version": "5.2.0",
+      "version": "5.1.0",
      "license": "MIT",
      "dependencies": {
-        "@actions/core": "^1.10.0",
+        "@actions/core": "^1.6.0",
        "@actions/exec": "^1.1.0",
        "@actions/github": "^5.0.0",
        "@actions/glob": "^0.2.0",
@@ -34,20 +34,11 @@
      }
    },
    "node_modules/@actions/core": {
-      "version": "1.10.0",
-      "resolved": "https://registry.npmjs.org/@actions/core/-/core-1.10.0.tgz",
-      "integrity": "sha512-2aZDDa3zrrZbP5ZYg159sNoLRb61nQ7awl5pSvIq5Qpj81vwDzdMRKzkWJGJuwVvWpvZKx7vspJALyvaaIQyug==",
+      "version": "1.6.0",
+      "resolved": "https://registry.npmjs.org/@actions/core/-/core-1.6.0.tgz",
+      "integrity": "sha512-NB1UAZomZlCV/LmJqkLhNTqtKfFXJZAUPcfl/zqG7EfsQdeUJtaWO98SGbuQ3pydJ3fHl2CvI/51OKYlCYYcaw==",
      "dependencies": {
-        "@actions/http-client": "^2.0.1",
-        "uuid": "^8.3.2"
-      }
-    },
-    "node_modules/@actions/core/node_modules/@actions/http-client": {
-      "version": "2.0.1",
-      "resolved": "https://registry.npmjs.org/@actions/http-client/-/http-client-2.0.1.tgz",
-      "integrity": "sha512-PIXiMVtz6VvyaRsGY268qvj57hXQEpsYogYOu2nrQhlf+XCGmZstmuZBbAybUl1nQGnvS1k1eEsQ69ZoD7xlSw==",
-      "dependencies": {
-        "tunnel": "^0.0.6"
+        "@actions/http-client": "^1.0.11"
      }
    },
    "node_modules/@actions/exec": {
@@ -4739,14 +4730,22 @@
      "dev": true
    },
    "node_modules/node-fetch": {
-      "version": "2.6.5",
-      "resolved": "https://registry.npmjs.org/node-fetch/-/node-fetch-2.6.5.tgz",
-      "integrity": "sha512-mmlIVHJEu5rnIxgEgez6b9GgWXbkZj5YZ7fx+2r94a2E+Uirsp6HsPTPlomfdHtpt/B0cdKviwkoaM6pyvUOpQ==",
+      "version": "2.6.7",
+      "resolved": "https://registry.npmjs.org/node-fetch/-/node-fetch-2.6.7.tgz",
+      "integrity": "sha512-ZjMPFEfVx5j+y2yF35Kzx5sF7kDzxuDj6ziH4FFbOp87zKDZNx8yExJIb05OGF4Nlt9IHFIMBkRl41VdvcNdbQ==",
      "dependencies": {
        "whatwg-url": "^5.0.0"
      },
      "engines": {
        "node": "4.x || >=6.0.0"
+      },
+      "peerDependencies": {
+        "encoding": "^0.1.0"
+      },
+      "peerDependenciesMeta": {
+        "encoding": {
+          "optional": true
+        }
      }
    },
    "node_modules/node-fetch/node_modules/tr46": {
@@ -5934,14 +5933,6 @@
        "punycode": "^2.1.0"
      }
    },
-    "node_modules/uuid": {
-      "version": "8.3.2",
-      "resolved": "https://registry.npmjs.org/uuid/-/uuid-8.3.2.tgz",
-      "integrity": "sha512-+NYs2QeMWy+GWFOEm9xnn6HCDp0l7QBD7ml8zLUmJ+93Q5NF0NocErnwkTkXVFNiX3/fpC6afS8Dhb/gz7R7eg==",
-      "bin": {
-        "uuid": "dist/bin/uuid"
-      }
-    },
    "node_modules/v8-compile-cache": {
      "version": "2.1.1",
      "resolved": "https://registry.npmjs.org/v8-compile-cache/-/v8-compile-cache-2.1.1.tgz",
@@ -6182,22 +6173,11 @@
  },
  "dependencies": {
    "@actions/core": {
-      "version": "1.10.0",
-      "resolved": "https://registry.npmjs.org/@actions/core/-/core-1.10.0.tgz",
-      "integrity": "sha512-2aZDDa3zrrZbP5ZYg159sNoLRb61nQ7awl5pSvIq5Qpj81vwDzdMRKzkWJGJuwVvWpvZKx7vspJALyvaaIQyug==",
+      "version": "1.6.0",
+      "resolved": "https://registry.npmjs.org/@actions/core/-/core-1.6.0.tgz",
+      "integrity": "sha512-NB1UAZomZlCV/LmJqkLhNTqtKfFXJZAUPcfl/zqG7EfsQdeUJtaWO98SGbuQ3pydJ3fHl2CvI/51OKYlCYYcaw==",
      "requires": {
-        "@actions/http-client": "^2.0.1",
-        "uuid": "^8.3.2"
-      },
-      "dependencies": {
-        "@actions/http-client": {
-          "version": "2.0.1",
-          "resolved": "https://registry.npmjs.org/@actions/http-client/-/http-client-2.0.1.tgz",
-          "integrity": "sha512-PIXiMVtz6VvyaRsGY268qvj57hXQEpsYogYOu2nrQhlf+XCGmZstmuZBbAybUl1nQGnvS1k1eEsQ69ZoD7xlSw==",
-          "requires": {
-            "tunnel": "^0.0.6"
-          }
-        }
+        "@actions/http-client": "^1.0.11"
      }
    },
    "@actions/exec": {
@@ -9807,9 +9787,9 @@
      "dev": true
    },
    "node-fetch": {
-      "version": "2.6.5",
-      "resolved": "https://registry.npmjs.org/node-fetch/-/node-fetch-2.6.5.tgz",
-      "integrity": "sha512-mmlIVHJEu5rnIxgEgez6b9GgWXbkZj5YZ7fx+2r94a2E+Uirsp6HsPTPlomfdHtpt/B0cdKviwkoaM6pyvUOpQ==",
+      "version": "2.6.7",
+      "resolved": "https://registry.npmjs.org/node-fetch/-/node-fetch-2.6.7.tgz",
+      "integrity": "sha512-ZjMPFEfVx5j+y2yF35Kzx5sF7kDzxuDj6ziH4FFbOp87zKDZNx8yExJIb05OGF4Nlt9IHFIMBkRl41VdvcNdbQ==",
      "requires": {
        "whatwg-url": "^5.0.0"
      },
@@ -10704,11 +10684,6 @@
        "punycode": "^2.1.0"
      }
    },
-    "uuid": {
-      "version": "8.3.2",
-      "resolved": "https://registry.npmjs.org/uuid/-/uuid-8.3.2.tgz",
-      "integrity": "sha512-+NYs2QeMWy+GWFOEm9xnn6HCDp0l7QBD7ml8zLUmJ+93Q5NF0NocErnwkTkXVFNiX3/fpC6afS8Dhb/gz7R7eg=="
-    },
    "v8-compile-cache": {
      "version": "2.1.1",
      "resolved": "https://registry.npmjs.org/v8-compile-cache/-/v8-compile-cache-2.1.1.tgz",
@@ -1,7 +1,7 @@
 {
  "name": "github-script",
  "description": "A GitHub action for executing a simple script",
-  "version": "5.2.0",
+  "version": "6.0.0",
  "author": "GitHub",
  "license": "MIT",
  "main": "dist/index.js",
@@ -31,7 +31,7 @@
    }
  },
  "dependencies": {
-    "@actions/core": "^1.10.0",
+    "@actions/core": "^1.6.0",
    "@actions/exec": "^1.1.0",
    "@actions/github": "^5.0.0",
    "@actions/glob": "^0.2.0",
@@ -54,4 +54,4 @@
    "ts-jest": "^27.0.5",
    "typescript": "^4.3.5"
  }
-}
+}
Author	SHA1	Message	Date
Josh Gross	9ac08808f9	Merge pull request #240 from actions/joshmgross/document-esm Add an example using ESM `import`	2022-02-11 10:21:32 -05:00
Josh Gross	53cdbb4a1b	Merge pull request #239 from actions/joshmgross/v6 Release version 6.0.0	2022-02-11 10:21:20 -05:00
Josh Gross	6b8d8aaad4	Merge pull request #238 from actions/joshmgross/update-actions-core Update `@actions/core` to 1.6.0	2022-02-11 10:19:36 -05:00
Josh Gross	6689be4f99	Merge pull request #237 from actions/joshmgross/audit-fix Update `node-fetch`	2022-02-11 10:19:26 -05:00
Josh Gross	5541733ecf	Add an example using ESM `import`	2022-02-09 16:17:11 -05:00
Josh Gross	cd8eebf4a5	Release version 6.0.0	2022-02-09 16:05:04 -05:00
Josh Gross	72fadf4ee8	Update `@actions/core` to 1.6.0	2022-02-09 15:58:07 -05:00
Josh Gross	d526c0463a	Update `node-fetch` license	2022-02-09 15:54:39 -05:00
Josh Gross	2c946f132f	Run `npm audit fix`	2022-02-09 15:47:54 -05:00
Josh Gross	41e1ab4f53	Merge pull request #235 from thboop/patch-1 Update default runtime to node16	2022-02-09 15:46:20 -05:00
Thomas Boop	d2ed94b14f	Update default runtime to node16 Node 12 has an end of life on April 30, 2022. This PR updates the default runtime to [node16](https://github.blog/changelog/2021-12-10-github-actions-github-hosted-runners-now-run-node-js-16-by-default/), rather then node12. This is supported on all Actions Runners v2.285.0 or later.	2022-02-07 14:00:27 -05:00