chore(master): release 1.15.0 (#26 )

feat: added clip description at last newline (#25 )
chore(master): release 1.14.0 (#24 )
2026-09-14 20:13:23 +00:00 · 2023-12-14 16:11:51 -05:00 · 2023-12-14 16:10:43 -05:00 · 2023-12-11 11:18:45 -05:00 · 2023-12-11 11:18:02 -05:00 · 2023-09-23 13:32:12 -04:00
31 changed files with 358 additions and 164 deletions
@@ -8,7 +8,9 @@ jobs:
    runs-on: ubuntu-latest
    steps:
      - uses: google-github-actions/release-please-action@v3
+        id: release
        with:
          release-type: node
          package-name: release-please-action
-          token: ${{ secrets.WORKFLOW_TOKEN }}
+          token: ${{ secrets.WORKFLOW_TOKEN }}
+          changelog-types: '[{"type":"feat","section":"Features","hidden":false},{"type":"fix","section":"Bug Fixes","hidden":false},{"type":"revert","section":"Reverts","hidden":false},{"type":"docs","section":"Documentation","hidden":false},{"type":"style","section":"Styles","hidden":false},{"type":"chore","section":"Miscellaneous","hidden":false},{"type":"refactor","section":"Code Refactoring","hidden":false}]'
@@ -3,7 +3,7 @@ on:
    types: [published]
 name: test-action
 jobs:
-  github-release-to-discord:
+  github-releases-to-discord:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
@@ -1,5 +1,45 @@
 # Changelog

+## [1.15.0](https://github.com/SethCohen/github-releases-to-discord/compare/v1.14.0...v1.15.0) (2023-12-14)
+
+
+### Features
+
+* added clip description at last newline ([#25](https://github.com/SethCohen/github-releases-to-discord/issues/25)) ([97a4813](https://github.com/SethCohen/github-releases-to-discord/commit/97a481333d0b902f599b12f03b47c4a6cbfa5e52))
+
+## [1.14.0](https://github.com/SethCohen/github-releases-to-discord/compare/v1.13.1...v1.14.0) (2023-12-11)
+
+
+### Features
+
+* added additional description formatting ([#23](https://github.com/SethCohen/github-releases-to-discord/issues/23)) ([8ca9da2](https://github.com/SethCohen/github-releases-to-discord/commit/8ca9da2ca8e3435ee9b0d387355c0fae255c16b0))
+* added max_description option ([8ca9da2](https://github.com/SethCohen/github-releases-to-discord/commit/8ca9da2ca8e3435ee9b0d387355c0fae255c16b0))
+* added reduce_headings option ([8ca9da2](https://github.com/SethCohen/github-releases-to-discord/commit/8ca9da2ca8e3435ee9b0d387355c0fae255c16b0))
+* description trimming ([8ca9da2](https://github.com/SethCohen/github-releases-to-discord/commit/8ca9da2ca8e3435ee9b0d387355c0fae255c16b0))
+
+
+### Styles
+
+* parse common Github URLs to more appropriate display ([8ca9da2](https://github.com/SethCohen/github-releases-to-discord/commit/8ca9da2ca8e3435ee9b0d387355c0fae255c16b0))
+* reduce consecutive whitespace/newlines into a minimum of 2 to allow separation in paragraphs ([8ca9da2](https://github.com/SethCohen/github-releases-to-discord/commit/8ca9da2ca8e3435ee9b0d387355c0fae255c16b0))
+
+
+### Miscellaneous
+
+* update README.md ([254bf79](https://github.com/SethCohen/github-releases-to-discord/commit/254bf7919618aea9ce0a3db67901010a20426def))
+
+## [1.13.1](https://github.com/SethCohen/github-releases-to-discord/compare/v1.13.0...v1.13.1) (2023-09-23)
+
+
+### Miscellaneous
+
+* updated action info ([c240910](https://github.com/SethCohen/github-releases-to-discord/commit/c240910f8922fb8492346613f67a84811a0fdbac))
+* updated action info ([c888953](https://github.com/SethCohen/github-releases-to-discord/commit/c8889535c4a02efec3e8a6b26e1ee17fcd36ac7b))
+* updated dependencies ([24b80ab](https://github.com/SethCohen/github-releases-to-discord/commit/24b80abb6f9c71123456a908af5d3b92ccc755af))
+* updated README.md ([ba06d83](https://github.com/SethCohen/github-releases-to-discord/commit/ba06d833522e55d3453ee27bea9a7f3655378359))
+* updated README.md ([ce7fc4a](https://github.com/SethCohen/github-releases-to-discord/commit/ce7fc4a3be811af077c4f43dd005851d65204fb1))
+* updated release-please action ([933f3cf](https://github.com/SethCohen/github-releases-to-discord/commit/933f3cffcf2139fcd71dddbb8bc76bc7cfa09170))
+
 ## [1.13.0](https://github.com/SethCohen/github-release-to-discord/compare/v1.12.1...v1.13.0) (2022-08-25)


@@ -1,4 +1,4 @@
-# GitHub Release To Discord Action
+# GitHub Releases To Discord Action
 A GitHub action that parses a GitHub release and posts it to a Discord channel as a stylized Discord webhook.

 ---
@@ -7,34 +7,44 @@ A GitHub action that parses a GitHub release and posts it to a Discord channel a

 ## Configuration

-| Variable   | Required | Default                                                                                                   | Description                                |
-|------------|----------|----------------------------------------------------------------------------------------------------------------|--------------------------------------------|
-| webhook_url | ✔      |                                                                                                                | Discord's webhook url. Use GH repo secrets. |
-| color      | ❌       | "2105893"                                                                                                      | Decimal color value for embed.             |
-| username   | ❌       | "Release Changelog"                                                                                            | String username for webhook.               |
-| avatar_url | ❌       | ["Profile Picture"](https://cdn.discordapp.com/avatars/487431320314576937/bd64361e4ba6313d561d54e78c9e7171.png) | String url to webhook avatar picture.      |
+| Variable        | Required | Default                                                                                               | Description                                     |
+|-----------------|----------|-------------------------------------------------------------------------------------------------------|-------------------------------------------------|
+| webhook_url     | ✔        |                                                                                                       | Discord's webhook url. Use GH repo secrets.     |
+| color           | ❌       | "2105893"                                                                                             | Decimal color value for embed.                  |
+| username        | ❌       |                                                                                                       | String username for webhook.                    |
+| avatar_url      | ❌       |                                                                                                       | String url to webhook avatar picture.           |
+| content         | ❌       |                                                                                                       | String content for webhook.                     |
+| footer_title    | ❌       |                                                                                                       | String title for the webhook footer.            |
+| footer_icon_url | ❌       |                                                                                                       | String url for the webhook footer picture.      |
+| footer_timestamp| ❌       |                                                                                                       | Boolean to enable footer timestamp.             |
+| max_description | ❌       | "4096"                                                                                                | Max length for the description.                 |
+| reduce_headings | ❌       | false                                                                                                 | Converts H3 to bold, h2 to bold & underline.    |

 ## Example Usage

-`.github/workflows/github-release-to-discord.yml`
+`.github/workflows/github-releases-to-discord.yml`
 ```yaml
 on:
  release:
    types: [published]

 jobs:
-  github-release-to-discord:
+  github-releases-to-discord:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v3
      - name: Github Releases To Discord
-        uses: SethCohen/github-release-to-discord@v1.12.0
+        uses: SethCohen/github-releases-to-discord@v1.13.1
        with:
          webhook_url: ${{ secrets.WEBHOOK_URL }}
          color: "2105893"
          username: "Release Changelog"
          avatar_url: "https://cdn.discordapp.com/avatars/487431320314576937/bd64361e4ba6313d561d54e78c9e7171.png"
+          content: "||@everyone||"
+          footer_title: "Changelog"
+          footer_icon_url: "https://cdn.discordapp.com/avatars/487431320314576937/bd64361e4ba6313d561d54e78c9e7171.png"
+          footer_timestamp: true
 ```

 ## Setup Instructions
@@ -43,7 +53,7 @@ jobs:
   ![](https://support.discord.com/hc/article_attachments/1500000463501/Screen_Shot_2020-12-15_at_4.41.53_PM.png)
   ![](https://support.discord.com/hc/article_attachments/360101553853/Screen_Shot_2020-12-15_at_4.51.38_PM.png)
 3. Copy the webhook url
-4. Create a new Github repository secret called WEBHOOK_URL and paste the webhook url into it.
+4. Create a new GitHub repository secret called WEBHOOK_URL and paste the webhook url into it.
   ![](https://i.imgur.com/hAaNOds.png)
 5. Save the secret.
 6. Add the secret to your action configuration.
@@ -1,6 +1,6 @@
 name: Github Releases To Discord
 author: SethCohen
-description: Send automatic styled releases to Discord.
+description: Automatically send a stylized Discord webhook of a GitHub Release description to a specified Discord channel.
 inputs:
  webhook_url:
    description: Discord's webhook url. Use GH repo secrets.
@@ -12,14 +12,32 @@ inputs:
  username:
    description: String username for webhook.
    required: false
-    default: 'Release Changelog'
  avatar_url:
    description: String url to webhook avatar picture.
    required: false
-    default: 'https://cdn.discordapp.com/avatars/487431320314576937/bd64361e4ba6313d561d54e78c9e7171.png'
+  content:
+    description: String content for webhook.
+    required: false
+  footer_title:
+    description: Title for the footer.
+    required: false
+  footer_icon_url:
+    description: Icon url for the footer.
+    required: false
+  footer_timestamp:
+    description: Timestamp for the footer.
+    required: false
+  max_description:
+    description: Max length for the description.
+    required: false
+    default: '4096'
+  reduce_headings:
+    description: Converts H3 to bold, h2 to bold & underline.
+    required: false
+    default: 'false'
 runs:
  using: 'node16'
  main: 'index.js'
 branding:
  icon: file-text
-  color: gray-dark
+  color: blue
@@ -4,72 +4,164 @@ import fetch from 'node-fetch';

 /**
 * Stylizes a markdown body into an appropriate embed message style.
- *  H3s converted to bold and underlined.
- *  H2s converted to bold.
- *  Redundant whitespace and newlines removed.
- * @param description
- * @returns {*}
+ *  Remove Carriage Return character to reduce size
+ *  Remove HTML comments (commonly added by 'Generate release notes' button)
+ *  Better URL linking for common Github links: PRs, Issues, Compare
+ *  Redundant whitespace and newlines removed, keeping at max 2 to provide space between paragraphs
+ *  Trim leading/trailing whitespace
+ *  If reduce_headings:
+ *   H3s converted to bold and underlined
+ *   H2s converted to bold
+ * @param {string} description
 */
 const formatDescription = (description) => {
-    return description
-        .replace(/### (.*?)\n/g,function (substring) {
-            const newString = substring.slice(4).replace(/(\r\n|\n|\r)/gm, "")
-            return `**__${newString}__**`
+    let edit = description
+        .replace(/\r/g, '')
+        .replace(/<!--.*?-->/gs, '')
+        .replace(
+            new RegExp(
+                "https://github.com/(.+)/(.+)/(issues|pull|commit|compare)/(\\S+)",
+                "g"
+            ),
+            (match, user, repo, type, id) => {
+                return `[${getTypePrefix(type) + id}](${match})`
+            }
+        )
+        .replace(/\n\s*\n/g, (ws) => {
+            const nlCount = (ws.match(/\n/g) || []).length
+            return nlCount >= 2 ? '\n\n' : '\n'
        })
-        .replace(/## (.*?)\n/g,function (substring) {
-            const newString = substring.slice(3).replace(/(\r\n|\n|\r)/gm, "")
-            return `**${newString}**`
-        })
-        .replace(/\n\s*\n/g, '\n')
+        .trim()
+
+    if (core.getBooleanInput('reduce_headings')) {
+        edit = edit
+            .replace(/^###\s+(.+)$/gm, '**__$1__**')
+            .replace(/^##\s+(.+)$/gm, '**$1**')
+    }
+
+    return edit
+}
+
+/**
+ * Get a prefix to use for Github link display
+ * @param {'issues' | 'pull' | 'commit' | 'compare'} type 
+ */
+function getTypePrefix (type) {
+    switch (type) {
+        case 'issues':
+            return 'Issue #'
+        case 'pull':
+            return 'PR #'
+        case 'commit':
+            return 'Commit #'
+        case 'compare':
+            return ''
+        default:
+            return '#'
+    }
+}
+
+/**
+ * Gets the max description length if set to a valid number,
+ * otherwise the default of 4096
+ */
+function getMaxDescription () {
+    try {
+        const max = core.getInput('max_description')
+        if (typeof max === 'string' && max.length) {
+            // 4096 is max for Embed Description
+            // https://discord.com/developers/docs/resources/channel#embed-object-embed-limits
+            return Math.min(parseInt(max, 10), 4096)
+        }
+    } catch (err) {
+        core.warning(`max_description not a valid number: ${err}`)
+    }
+    return 4096
 }

 /**
 * Get the context of the action, returns a GitHub Release payload.
- * @returns {Promise<{html_url, body: (*|string), version: string}>}
 */
-async function getContext () {
-    const payload = github.context.payload
+function getContext () {
+    const payload = github.context.payload;

    return {
-        body: payload.release.body.length < 1500
-            ? payload.release.body
-            : payload.release.body.substring(0, 1500) + ` ([...](${payload.release.html_url}))`,
-        version: payload.release.tag_name,
+        body: payload.release.body,
+        name: payload.release.name,
        html_url: payload.release.html_url
    }
 }

 /**
- * Handles the action.
- * Get inputs, creates a stylized response webhook, and sends it to the channel.
- * @returns {Promise<void>}
+ * 
+ * @param {string} str
+ * @param {number} maxLength
+ * @param {string} [url]
+ * @param {boolean} [clipAtLine=false] 
 */
-async function run () {
-    const webhookUrl = core.getInput('webhook_url')
-    const color = core.getInput('color')
-    const username = core.getInput('username')
-    const avatarUrl = core.getInput('avatar_url')
+function limit(str, maxLength, url, clipAtLine) {
+    clipAtLine ??= false
+    if (str.length <= maxLength)
+        return str
+    let replacement = clipAtLine ? '\n…' : '…'
+    if (url) {
+        replacement = `${clipAtLine ? '\n' : ''}([…](${url}))`
+    }
+    maxLength = maxLength - replacement.length
+    str = str.substring(0, maxLength)

-    if (!webhookUrl) return core.setFailed('webhook_url not set. Please set it.')
-
-    const {body, html_url, version} = await getContext()
-
-    const description = formatDescription(body)
-
-    const embedMsg = {
-        title: `Release ${version}`,
-        url: html_url,
-        color: color,
-        description: description
+    const lastNewline = str.search(new RegExp(`[^${clipAtLine ? '\n' : '\s'}]*$`))
+    if (lastNewline > -1) {
+        str = str.substring(0, lastNewline)
    }

-    const requestBody = {
-        username: username,
-        avatar_url: avatarUrl,
+    return str + replacement
+}
+
+/**
+ * Handles the action.
+ * Get inputs, creates a stylized response webhook, and sends it to the channel.
+ */
+async function run () {
+    const webhookUrl = core.getInput('webhook_url');
+    const color = core.getInput('color');
+    const username = core.getInput('username');
+    const avatarUrl = core.getInput('avatar_url');
+    const content = core.getInput('content');
+    const footerTitle = core.getInput('footer_title');
+    const footerIconUrl = core.getInput('footer_icon_url');
+    const footerTimestamp = core.getInput('footer_timestamp');
+
+    if (!webhookUrl) return core.setFailed('webhook_url not set. Please set it.');
+
+    const {body, html_url, name} = getContext();
+
+    const description = formatDescription(body);
+
+    let embedMsg = {
+        title: limit(name, 256),
+        url: html_url,
+        color: color,
+        description: description,
+        footer: {}
+    }
+
+    if (footerTitle != '') embedMsg.footer.text = limit(footerTitle, 2048);
+    if (footerIconUrl != '') embedMsg.footer.icon_url = footerIconUrl;
+    if (footerTimestamp == 'true') embedMsg.timestamp = new Date().toISOString();
+
+    let embedSize = embedMsg.title.length + (embedMsg.footer?.text?.length ?? 0)
+    embedMsg.description = limit(embedMsg.description, Math.min(getMaxDescription(), 6000 - embedSize), embedMsg.url, true)
+
+    let requestBody = {
        embeds: [embedMsg]
    }

-    const url = `${webhookUrl}?wait=true`
+    if (username != '') requestBody.username = username;
+    if (avatarUrl != '') requestBody.avatar_url = avatarUrl;
+    if (content != '') requestBody.content = content;
+
+    const url = `${webhookUrl}?wait=true`;
    fetch(url, {
        method: 'post',
        body: JSON.stringify(requestBody),
@@ -1,22 +1,22 @@
 {
-  "name": "github-release-to-discord",
-  "version": "1.12.1",
-  "lockfileVersion": 2,
+  "name": "github-releases-to-discord",
+  "version": "1.13.0",
+  "lockfileVersion": 3,
  "requires": true,
  "packages": {
    "node_modules/@actions/core": {
-      "version": "1.9.1",
-      "resolved": "https://registry.npmjs.org/@actions/core/-/core-1.9.1.tgz",
-      "integrity": "sha512-5ad+U2YGrmmiw6du20AQW5XuWo7UKN2052FjSV7MX+Wfjf8sCqcsZe62NfgHys4QI4/Y+vQvLKYL8jWtA1ZBTA==",
+      "version": "1.10.1",
+      "resolved": "https://registry.npmjs.org/@actions/core/-/core-1.10.1.tgz",
+      "integrity": "sha512-3lBR9EDAY+iYIpTnTIXmWcNbX3T2kCkAEQGIQx4NVQ0575nk2k3GRZDTPQG+vVtS2izSLmINlxXf0uLtnrTP+g==",
      "dependencies": {
        "@actions/http-client": "^2.0.1",
        "uuid": "^8.3.2"
      }
    },
    "node_modules/@actions/github": {
-      "version": "5.0.3",
-      "resolved": "https://registry.npmjs.org/@actions/github/-/github-5.0.3.tgz",
-      "integrity": "sha512-myjA/pdLQfhUGLtRZC/J4L1RXOG4o6aYdiEq+zr5wVVKljzbFld+xv10k1FX6IkIJtNxbAq44BdwSNpQ015P0A==",
+      "version": "5.1.1",
+      "resolved": "https://registry.npmjs.org/@actions/github/-/github-5.1.1.tgz",
+      "integrity": "sha512-Nk59rMDoJaV+mHCOJPXuvB1zIbomlKS0dmSIqPGxd0enAXBnOfn4VWF+CGtRCwXZG9Epa54tZA7VIRlJDS8A6g==",
      "dependencies": {
        "@actions/http-client": "^2.0.1",
        "@octokit/core": "^3.6.0",
@@ -230,9 +230,9 @@
      }
    },
    "node_modules/node-fetch": {
-      "version": "3.2.10",
-      "resolved": "https://registry.npmjs.org/node-fetch/-/node-fetch-3.2.10.tgz",
-      "integrity": "sha512-MhuzNwdURnZ1Cp4XTazr69K0BTizsBroX7Zx3UgDSVcZYKF/6p0CBe4EUb/hLqmzVhl0UpYfgRljQ4yxE+iCxA==",
+      "version": "3.3.2",
+      "resolved": "https://registry.npmjs.org/node-fetch/-/node-fetch-3.3.2.tgz",
+      "integrity": "sha512-dRB78srN/l6gqWulah9SrxeYnxeddIG30+GOqK/9OlLVyLg3HPnr6SqOWTWOXKRwC2eGYCkZ59NNuSgvSrpgOA==",
      "dependencies": {
        "data-uri-to-buffer": "^4.0.0",
        "fetch-blob": "^3.1.4",
@@ -121,7 +121,7 @@ const result = await core.group('Do something async', async () => {

 This library has 3 methods that will produce [annotations](https://docs.github.com/en/rest/reference/checks#create-a-check-run). 
 ```js
-core.error('This is a bad error. This will also fail the build.')
+core.error('This is a bad error, action may still succeed though.')

 core.warning('Something went wrong, but it\'s not bad enough to fail the build.')

@@ -163,7 +163,7 @@ export interface AnnotationProperties {
  startColumn?: number

  /**
-   * The start column for the annotation. Cannot be sent when `startLine` and `endLine` are different values.
+   * The end column for the annotation. Cannot be sent when `startLine` and `endLine` are different values.
   * Defaults to `startColumn` when `startColumn` is provided.
   */
  endColumn?: number
@@ -21,7 +21,7 @@ export declare enum ExitCode {
    Failure = 1
 }
 /**
- * Optional properties that can be sent with annotatation commands (notice, error, and warning)
+ * Optional properties that can be sent with annotation commands (notice, error, and warning)
 * See: https://docs.github.com/en/rest/reference/checks#create-a-check-run for more information about annotations.
 */
 export interface AnnotationProperties {
@@ -46,7 +46,7 @@ export interface AnnotationProperties {
     */
    startColumn?: number;
    /**
-     * The start column for the annotation. Cannot be sent when `startLine` and `endLine` are different values.
+     * The end column for the annotation. Cannot be sent when `startLine` and `endLine` are different values.
     * Defaults to `startColumn` when `startColumn` is provided.
     */
    endColumn?: number;
@@ -34,7 +34,6 @@ const file_command_1 = require("./file-command");
 const utils_1 = require("./utils");
 const os = __importStar(require("os"));
 const path = __importStar(require("path"));
-const uuid_1 = require("uuid");
 const oidc_utils_1 = require("./oidc-utils");
 /**
 * The code to exit an action
@@ -64,20 +63,9 @@ function exportVariable(name, val) {
    process.env[name] = convertedVal;
    const filePath = process.env['GITHUB_ENV'] || '';
    if (filePath) {
-        const delimiter = `ghadelimiter_${uuid_1.v4()}`;
-        // These should realistically never happen, but just in case someone finds a way to exploit uuid generation let's not allow keys or values that contain the delimiter.
-        if (name.includes(delimiter)) {
-            throw new Error(`Unexpected input: name should not contain the delimiter "${delimiter}"`);
-        }
-        if (convertedVal.includes(delimiter)) {
-            throw new Error(`Unexpected input: value should not contain the delimiter "${delimiter}"`);
-        }
-        const commandValue = `${name}<<${delimiter}${os.EOL}${convertedVal}${os.EOL}${delimiter}`;
-        file_command_1.issueCommand('ENV', commandValue);
-    }
-    else {
-        command_1.issueCommand('set-env', { name }, convertedVal);
+        return file_command_1.issueFileCommand('ENV', file_command_1.prepareKeyValueMessage(name, val));
    }
+    command_1.issueCommand('set-env', { name }, convertedVal);
 }
 exports.exportVariable = exportVariable;
 /**
@@ -95,7 +83,7 @@ exports.setSecret = setSecret;
 function addPath(inputPath) {
    const filePath = process.env['GITHUB_PATH'] || '';
    if (filePath) {
-        file_command_1.issueCommand('PATH', inputPath);
+        file_command_1.issueFileCommand('PATH', inputPath);
    }
    else {
        command_1.issueCommand('add-path', {}, inputPath);
@@ -135,7 +123,10 @@ function getMultilineInput(name, options) {
    const inputs = getInput(name, options)
        .split('\n')
        .filter(x => x !== '');
-    return inputs;
+    if (options && options.trimWhitespace === false) {
+        return inputs;
+    }
+    return inputs.map(input => input.trim());
 }
 exports.getMultilineInput = getMultilineInput;
 /**
@@ -168,8 +159,12 @@ exports.getBooleanInput = getBooleanInput;
 */
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 function setOutput(name, value) {
+    const filePath = process.env['GITHUB_OUTPUT'] || '';
+    if (filePath) {
+        return file_command_1.issueFileCommand('OUTPUT', file_command_1.prepareKeyValueMessage(name, value));
+    }
    process.stdout.write(os.EOL);
-    command_1.issueCommand('set-output', { name }, value);
+    command_1.issueCommand('set-output', { name }, utils_1.toCommandValue(value));
 }
 exports.setOutput = setOutput;
 /**
@@ -298,7 +293,11 @@ exports.group = group;
 */
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 function saveState(name, value) {
-    command_1.issueCommand('save-state', { name }, value);
+    const filePath = process.env['GITHUB_STATE'] || '';
+    if (filePath) {
+        return file_command_1.issueFileCommand('STATE', file_command_1.prepareKeyValueMessage(name, value));
+    }
+    command_1.issueCommand('save-state', { name }, utils_1.toCommandValue(value));
 }
 exports.saveState = saveState;
 /**
@@ -1 +1,2 @@
-export declare function issueCommand(command: string, message: any): void;
+export declare function issueFileCommand(command: string, message: any): void;
+export declare function prepareKeyValueMessage(key: string, value: any): string;
@@ -20,13 +20,14 @@ var __importStar = (this && this.__importStar) || function (mod) {
    return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.issueCommand = void 0;
+exports.prepareKeyValueMessage = exports.issueFileCommand = void 0;
 // We use any as a valid input type
 /* eslint-disable @typescript-eslint/no-explicit-any */
 const fs = __importStar(require("fs"));
 const os = __importStar(require("os"));
+const uuid_1 = require("uuid");
 const utils_1 = require("./utils");
-function issueCommand(command, message) {
+function issueFileCommand(command, message) {
    const filePath = process.env[`GITHUB_${command}`];
    if (!filePath) {
        throw new Error(`Unable to find environment variable for file command ${command}`);
@@ -38,5 +39,20 @@ function issueCommand(command, message) {
        encoding: 'utf8'
    });
 }
-exports.issueCommand = issueCommand;
+exports.issueFileCommand = issueFileCommand;
+function prepareKeyValueMessage(key, value) {
+    const delimiter = `ghadelimiter_${uuid_1.v4()}`;
+    const convertedValue = utils_1.toCommandValue(value);
+    // These should realistically never happen, but just in case someone finds a
+    // way to exploit uuid generation let's not allow keys or values that contain
+    // the delimiter.
+    if (key.includes(delimiter)) {
+        throw new Error(`Unexpected input: name should not contain the delimiter "${delimiter}"`);
+    }
+    if (convertedValue.includes(delimiter)) {
+        throw new Error(`Unexpected input: value should not contain the delimiter "${delimiter}"`);
+    }
+    return `${key}<<${delimiter}${os.EOL}${convertedValue}${os.EOL}${delimiter}`;
+}
+exports.prepareKeyValueMessage = prepareKeyValueMessage;
 //# sourceMappingURL=file-command.js.map
@@ -1 +1 @@
-{"version":3,"file":"file-command.js","sourceRoot":"","sources":["../src/file-command.ts"],"names":[],"mappings":";AAAA,uCAAuC;;;;;;;;;;;;;;;;;;;;;;AAEvC,mCAAmC;AACnC,uDAAuD;AAEvD,uCAAwB;AACxB,uCAAwB;AACxB,mCAAsC;AAEtC,SAAgB,YAAY,CAAC,OAAe,EAAE,OAAY;IACxD,MAAM,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAC,UAAU,OAAO,EAAE,CAAC,CAAA;IACjD,IAAI,CAAC,QAAQ,EAAE;QACb,MAAM,IAAI,KAAK,CACb,wDAAwD,OAAO,EAAE,CAClE,CAAA;KACF;IACD,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE;QAC5B,MAAM,IAAI,KAAK,CAAC,yBAAyB,QAAQ,EAAE,CAAC,CAAA;KACrD;IAED,EAAE,CAAC,cAAc,CAAC,QAAQ,EAAE,GAAG,sBAAc,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,GAAG,EAAE,EAAE;QACjE,QAAQ,EAAE,MAAM;KACjB,CAAC,CAAA;AACJ,CAAC;AAdD,oCAcC"}
+{"version":3,"file":"file-command.js","sourceRoot":"","sources":["../src/file-command.ts"],"names":[],"mappings":";AAAA,uCAAuC;;;;;;;;;;;;;;;;;;;;;;AAEvC,mCAAmC;AACnC,uDAAuD;AAEvD,uCAAwB;AACxB,uCAAwB;AACxB,+BAAiC;AACjC,mCAAsC;AAEtC,SAAgB,gBAAgB,CAAC,OAAe,EAAE,OAAY;IAC5D,MAAM,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAC,UAAU,OAAO,EAAE,CAAC,CAAA;IACjD,IAAI,CAAC,QAAQ,EAAE;QACb,MAAM,IAAI,KAAK,CACb,wDAAwD,OAAO,EAAE,CAClE,CAAA;KACF;IACD,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE;QAC5B,MAAM,IAAI,KAAK,CAAC,yBAAyB,QAAQ,EAAE,CAAC,CAAA;KACrD;IAED,EAAE,CAAC,cAAc,CAAC,QAAQ,EAAE,GAAG,sBAAc,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,GAAG,EAAE,EAAE;QACjE,QAAQ,EAAE,MAAM;KACjB,CAAC,CAAA;AACJ,CAAC;AAdD,4CAcC;AAED,SAAgB,sBAAsB,CAAC,GAAW,EAAE,KAAU;IAC5D,MAAM,SAAS,GAAG,gBAAgB,SAAM,EAAE,EAAE,CAAA;IAC5C,MAAM,cAAc,GAAG,sBAAc,CAAC,KAAK,CAAC,CAAA;IAE5C,4EAA4E;IAC5E,6EAA6E;IAC7E,iBAAiB;IACjB,IAAI,GAAG,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE;QAC3B,MAAM,IAAI,KAAK,CACb,4DAA4D,SAAS,GAAG,CACzE,CAAA;KACF;IAED,IAAI,cAAc,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE;QACtC,MAAM,IAAI,KAAK,CACb,6DAA6D,SAAS,GAAG,CAC1E,CAAA;KACF;IAED,OAAO,GAAG,GAAG,KAAK,SAAS,GAAG,EAAE,CAAC,GAAG,GAAG,cAAc,GAAG,EAAE,CAAC,GAAG,GAAG,SAAS,EAAE,CAAA;AAC9E,CAAC;AApBD,wDAoBC"}
@@ -44,7 +44,7 @@ class OidcClient {
                .catch(error => {
                throw new Error(`Failed to get ID Token. \n 
        Error Code : ${error.statusCode}\n 
-        Error Message: ${error.result.message}`);
+        Error Message: ${error.message}`);
            });
            const id_token = (_a = res.result) === null || _a === void 0 ? void 0 : _a.value;
            if (!id_token) {
@@ -1 +1 @@
-{"version":3,"file":"oidc-utils.js","sourceRoot":"","sources":["../src/oidc-utils.ts"],"names":[],"mappings":";;;;;;;;;;;;AAGA,sDAA+C;AAC/C,wDAAqE;AACrE,iCAAuC;AAKvC,MAAa,UAAU;IACb,MAAM,CAAC,gBAAgB,CAC7B,UAAU,GAAG,IAAI,EACjB,QAAQ,GAAG,EAAE;QAEb,MAAM,cAAc,GAAmB;YACrC,YAAY,EAAE,UAAU;YACxB,UAAU,EAAE,QAAQ;SACrB,CAAA;QAED,OAAO,IAAI,wBAAU,CACnB,qBAAqB,EACrB,CAAC,IAAI,8BAAuB,CAAC,UAAU,CAAC,eAAe,EAAE,CAAC,CAAC,EAC3D,cAAc,CACf,CAAA;IACH,CAAC;IAEO,MAAM,CAAC,eAAe;QAC5B,MAAM,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,gCAAgC,CAAC,CAAA;QAC3D,IAAI,CAAC,KAAK,EAAE;YACV,MAAM,IAAI,KAAK,CACb,2DAA2D,CAC5D,CAAA;SACF;QACD,OAAO,KAAK,CAAA;IACd,CAAC;IAEO,MAAM,CAAC,aAAa;QAC1B,MAAM,UAAU,GAAG,OAAO,CAAC,GAAG,CAAC,8BAA8B,CAAC,CAAA;QAC9D,IAAI,CAAC,UAAU,EAAE;YACf,MAAM,IAAI,KAAK,CAAC,yDAAyD,CAAC,CAAA;SAC3E;QACD,OAAO,UAAU,CAAA;IACnB,CAAC;IAEO,MAAM,CAAO,OAAO,CAAC,YAAoB;;;YAC/C,MAAM,UAAU,GAAG,UAAU,CAAC,gBAAgB,EAAE,CAAA;YAEhD,MAAM,GAAG,GAAG,MAAM,UAAU;iBACzB,OAAO,CAAgB,YAAY,CAAC;iBACpC,KAAK,CAAC,KAAK,CAAC,EAAE;gBACb,MAAM,IAAI,KAAK,CACb;uBACa,KAAK,CAAC,UAAU;yBACd,KAAK,CAAC,MAAM,CAAC,OAAO,EAAE,CACtC,CAAA;YACH,CAAC,CAAC,CAAA;YAEJ,MAAM,QAAQ,SAAG,GAAG,CAAC,MAAM,0CAAE,KAAK,CAAA;YAClC,IAAI,CAAC,QAAQ,EAAE;gBACb,MAAM,IAAI,KAAK,CAAC,+CAA+C,CAAC,CAAA;aACjE;YACD,OAAO,QAAQ,CAAA;;KAChB;IAED,MAAM,CAAO,UAAU,CAAC,QAAiB;;YACvC,IAAI;gBACF,gDAAgD;gBAChD,IAAI,YAAY,GAAW,UAAU,CAAC,aAAa,EAAE,CAAA;gBACrD,IAAI,QAAQ,EAAE;oBACZ,MAAM,eAAe,GAAG,kBAAkB,CAAC,QAAQ,CAAC,CAAA;oBACpD,YAAY,GAAG,GAAG,YAAY,aAAa,eAAe,EAAE,CAAA;iBAC7D;gBAED,YAAK,CAAC,mBAAmB,YAAY,EAAE,CAAC,CAAA;gBAExC,MAAM,QAAQ,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,YAAY,CAAC,CAAA;gBACvD,gBAAS,CAAC,QAAQ,CAAC,CAAA;gBACnB,OAAO,QAAQ,CAAA;aAChB;YAAC,OAAO,KAAK,EAAE;gBACd,MAAM,IAAI,KAAK,CAAC,kBAAkB,KAAK,CAAC,OAAO,EAAE,CAAC,CAAA;aACnD;QACH,CAAC;KAAA;CACF;AAzED,gCAyEC"}
+{"version":3,"file":"oidc-utils.js","sourceRoot":"","sources":["../src/oidc-utils.ts"],"names":[],"mappings":";;;;;;;;;;;;AAGA,sDAA+C;AAC/C,wDAAqE;AACrE,iCAAuC;AAKvC,MAAa,UAAU;IACb,MAAM,CAAC,gBAAgB,CAC7B,UAAU,GAAG,IAAI,EACjB,QAAQ,GAAG,EAAE;QAEb,MAAM,cAAc,GAAmB;YACrC,YAAY,EAAE,UAAU;YACxB,UAAU,EAAE,QAAQ;SACrB,CAAA;QAED,OAAO,IAAI,wBAAU,CACnB,qBAAqB,EACrB,CAAC,IAAI,8BAAuB,CAAC,UAAU,CAAC,eAAe,EAAE,CAAC,CAAC,EAC3D,cAAc,CACf,CAAA;IACH,CAAC;IAEO,MAAM,CAAC,eAAe;QAC5B,MAAM,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,gCAAgC,CAAC,CAAA;QAC3D,IAAI,CAAC,KAAK,EAAE;YACV,MAAM,IAAI,KAAK,CACb,2DAA2D,CAC5D,CAAA;SACF;QACD,OAAO,KAAK,CAAA;IACd,CAAC;IAEO,MAAM,CAAC,aAAa;QAC1B,MAAM,UAAU,GAAG,OAAO,CAAC,GAAG,CAAC,8BAA8B,CAAC,CAAA;QAC9D,IAAI,CAAC,UAAU,EAAE;YACf,MAAM,IAAI,KAAK,CAAC,yDAAyD,CAAC,CAAA;SAC3E;QACD,OAAO,UAAU,CAAA;IACnB,CAAC;IAEO,MAAM,CAAO,OAAO,CAAC,YAAoB;;;YAC/C,MAAM,UAAU,GAAG,UAAU,CAAC,gBAAgB,EAAE,CAAA;YAEhD,MAAM,GAAG,GAAG,MAAM,UAAU;iBACzB,OAAO,CAAgB,YAAY,CAAC;iBACpC,KAAK,CAAC,KAAK,CAAC,EAAE;gBACb,MAAM,IAAI,KAAK,CACb;uBACa,KAAK,CAAC,UAAU;yBACd,KAAK,CAAC,OAAO,EAAE,CAC/B,CAAA;YACH,CAAC,CAAC,CAAA;YAEJ,MAAM,QAAQ,SAAG,GAAG,CAAC,MAAM,0CAAE,KAAK,CAAA;YAClC,IAAI,CAAC,QAAQ,EAAE;gBACb,MAAM,IAAI,KAAK,CAAC,+CAA+C,CAAC,CAAA;aACjE;YACD,OAAO,QAAQ,CAAA;;KAChB;IAED,MAAM,CAAO,UAAU,CAAC,QAAiB;;YACvC,IAAI;gBACF,gDAAgD;gBAChD,IAAI,YAAY,GAAW,UAAU,CAAC,aAAa,EAAE,CAAA;gBACrD,IAAI,QAAQ,EAAE;oBACZ,MAAM,eAAe,GAAG,kBAAkB,CAAC,QAAQ,CAAC,CAAA;oBACpD,YAAY,GAAG,GAAG,YAAY,aAAa,eAAe,EAAE,CAAA;iBAC7D;gBAED,YAAK,CAAC,mBAAmB,YAAY,EAAE,CAAC,CAAA;gBAExC,MAAM,QAAQ,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,YAAY,CAAC,CAAA;gBACvD,gBAAS,CAAC,QAAQ,CAAC,CAAA;gBACnB,OAAO,QAAQ,CAAA;aAChB;YAAC,OAAO,KAAK,EAAE;gBACd,MAAM,IAAI,KAAK,CAAC,kBAAkB,KAAK,CAAC,OAAO,EAAE,CAAC,CAAA;aACnD;QACH,CAAC;KAAA;CACF;AAzED,gCAyEC"}
@@ -1,6 +1,6 @@
 {
  "name": "@actions/core",
-  "version": "1.9.1",
+  "version": "1.10.1",
  "description": "Actions core lib",
  "keywords": [
    "github",
@@ -30,7 +30,7 @@
  "scripts": {
    "audit-moderate": "npm install && npm audit --json --audit-level=moderate > audit.json",
    "test": "echo \"Error: run tests from root\" && exit 1",
-    "tsc": "tsc"
+    "tsc": "tsc -p tsconfig.json"
  },
  "bugs": {
    "url": "https://github.com/actions/toolkit/issues"
@@ -43,4 +43,4 @@
    "@types/node": "^12.0.2",
    "@types/uuid": "^8.3.4"
  }
-}
+}
@@ -1,6 +1,6 @@
 import * as Context from './context';
 import { GitHub } from './utils';
-import { OctokitOptions } from '@octokit/core/dist-types/types';
+import { OctokitOptions, OctokitPlugin } from '@octokit/core/dist-types/types';
 export declare const context: Context.Context;
 /**
 * Returns a hydrated octokit ready to use for GitHub Actions
@@ -8,4 +8,4 @@ export declare const context: Context.Context;
 * @param     token    the repo PAT or GITHUB_TOKEN
 * @param     options  other options to set
 */
-export declare function getOctokit(token: string, options?: OctokitOptions): InstanceType<typeof GitHub>;
+export declare function getOctokit(token: string, options?: OctokitOptions, ...additionalPlugins: OctokitPlugin[]): InstanceType<typeof GitHub>;
@@ -29,8 +29,9 @@ exports.context = new Context.Context();
 * @param     token    the repo PAT or GITHUB_TOKEN
 * @param     options  other options to set
 */
-function getOctokit(token, options) {
-    return new utils_1.GitHub(utils_1.getOctokitOptions(token, options));
+function getOctokit(token, options, ...additionalPlugins) {
+    const GitHubWithPlugins = utils_1.GitHub.plugin(...additionalPlugins);
+    return new GitHubWithPlugins(utils_1.getOctokitOptions(token, options));
 }
 exports.getOctokit = getOctokit;
 //# sourceMappingURL=github.js.map
@@ -1 +1 @@
-{"version":3,"file":"github.js","sourceRoot":"","sources":["../src/github.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;AAAA,mDAAoC;AACpC,mCAAiD;AAKpC,QAAA,OAAO,GAAG,IAAI,OAAO,CAAC,OAAO,EAAE,CAAA;AAE5C;;;;;GAKG;AACH,SAAgB,UAAU,CACxB,KAAa,EACb,OAAwB;IAExB,OAAO,IAAI,cAAM,CAAC,yBAAiB,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC,CAAA;AACtD,CAAC;AALD,gCAKC"}
+{"version":3,"file":"github.js","sourceRoot":"","sources":["../src/github.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;AAAA,mDAAoC;AACpC,mCAAiD;AAKpC,QAAA,OAAO,GAAG,IAAI,OAAO,CAAC,OAAO,EAAE,CAAA;AAE5C;;;;;GAKG;AACH,SAAgB,UAAU,CACxB,KAAa,EACb,OAAwB,EACxB,GAAG,iBAAkC;IAErC,MAAM,iBAAiB,GAAG,cAAM,CAAC,MAAM,CAAC,GAAG,iBAAiB,CAAC,CAAA;IAC7D,OAAO,IAAI,iBAAiB,CAAC,yBAAiB,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC,CAAA;AACjE,CAAC;AAPD,gCAOC"}
@@ -2,6 +2,7 @@ import * as Context from './context';
 import { Octokit } from '@octokit/core';
 import { OctokitOptions } from '@octokit/core/dist-types/types';
 export declare const context: Context.Context;
+export declare const defaults: OctokitOptions;
 export declare const GitHub: typeof Octokit & import("@octokit/core/dist-types/types").Constructor<import("@octokit/plugin-rest-endpoint-methods/dist-types/types").Api & {
    paginate: import("@octokit/plugin-paginate-rest").PaginateInterface;
 }>;
@@ -19,7 +19,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
    return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getOctokitOptions = exports.GitHub = exports.context = void 0;
+exports.getOctokitOptions = exports.GitHub = exports.defaults = exports.context = void 0;
 const Context = __importStar(require("./context"));
 const Utils = __importStar(require("./internal/utils"));
 // octokit + plugins
@@ -28,13 +28,13 @@ const plugin_rest_endpoint_methods_1 = require("@octokit/plugin-rest-endpoint-me
 const plugin_paginate_rest_1 = require("@octokit/plugin-paginate-rest");
 exports.context = new Context.Context();
 const baseUrl = Utils.getApiBaseUrl();
-const defaults = {
+exports.defaults = {
    baseUrl,
    request: {
        agent: Utils.getProxyAgent(baseUrl)
    }
 };
-exports.GitHub = core_1.Octokit.plugin(plugin_rest_endpoint_methods_1.restEndpointMethods, plugin_paginate_rest_1.paginateRest).defaults(defaults);
+exports.GitHub = core_1.Octokit.plugin(plugin_rest_endpoint_methods_1.restEndpointMethods, plugin_paginate_rest_1.paginateRest).defaults(exports.defaults);
 /**
 * Convience function to correctly format Octokit Options to pass into the constructor.
 *
@@ -1 +1 @@
-{"version":3,"file":"utils.js","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;AAAA,mDAAoC;AACpC,wDAAyC;AAEzC,oBAAoB;AACpB,wCAAqC;AAErC,wFAAyE;AACzE,wEAA0D;AAE7C,QAAA,OAAO,GAAG,IAAI,OAAO,CAAC,OAAO,EAAE,CAAA;AAE5C,MAAM,OAAO,GAAG,KAAK,CAAC,aAAa,EAAE,CAAA;AACrC,MAAM,QAAQ,GAAG;IACf,OAAO;IACP,OAAO,EAAE;QACP,KAAK,EAAE,KAAK,CAAC,aAAa,CAAC,OAAO,CAAC;KACpC;CACF,CAAA;AAEY,QAAA,MAAM,GAAG,cAAO,CAAC,MAAM,CAClC,kDAAmB,EACnB,mCAAY,CACb,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAA;AAEpB;;;;;GAKG;AACH,SAAgB,iBAAiB,CAC/B,KAAa,EACb,OAAwB;IAExB,MAAM,IAAI,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,OAAO,IAAI,EAAE,CAAC,CAAA,CAAC,iEAAiE;IAE/G,OAAO;IACP,MAAM,IAAI,GAAG,KAAK,CAAC,aAAa,CAAC,KAAK,EAAE,IAAI,CAAC,CAAA;IAC7C,IAAI,IAAI,EAAE;QACR,IAAI,CAAC,IAAI,GAAG,IAAI,CAAA;KACjB;IAED,OAAO,IAAI,CAAA;AACb,CAAC;AAbD,8CAaC"}
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;AAAA,mDAAoC;AACpC,wDAAyC;AAEzC,oBAAoB;AACpB,wCAAqC;AAErC,wFAAyE;AACzE,wEAA0D;AAE7C,QAAA,OAAO,GAAG,IAAI,OAAO,CAAC,OAAO,EAAE,CAAA;AAE5C,MAAM,OAAO,GAAG,KAAK,CAAC,aAAa,EAAE,CAAA;AACxB,QAAA,QAAQ,GAAmB;IACtC,OAAO;IACP,OAAO,EAAE;QACP,KAAK,EAAE,KAAK,CAAC,aAAa,CAAC,OAAO,CAAC;KACpC;CACF,CAAA;AAEY,QAAA,MAAM,GAAG,cAAO,CAAC,MAAM,CAClC,kDAAmB,EACnB,mCAAY,CACb,CAAC,QAAQ,CAAC,gBAAQ,CAAC,CAAA;AAEpB;;;;;GAKG;AACH,SAAgB,iBAAiB,CAC/B,KAAa,EACb,OAAwB;IAExB,MAAM,IAAI,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,OAAO,IAAI,EAAE,CAAC,CAAA,CAAC,iEAAiE;IAE/G,OAAO;IACP,MAAM,IAAI,GAAG,KAAK,CAAC,aAAa,CAAC,KAAK,EAAE,IAAI,CAAC,CAAA;IAC7C,IAAI,IAAI,EAAE;QACR,IAAI,CAAC,IAAI,GAAG,IAAI,CAAA;KACjB;IAED,OAAO,IAAI,CAAA;AACb,CAAC;AAbD,8CAaC"}
@@ -1,6 +1,6 @@
 {
  "name": "@actions/github",
-  "version": "5.0.3",
+  "version": "5.1.1",
  "description": "Actions github lib",
  "keywords": [
    "github",
@@ -147,7 +147,7 @@ export type RequestRedirect = 'error' | 'follow' | 'manual';
 export type ReferrerPolicy = '' | 'no-referrer' | 'no-referrer-when-downgrade' | 'same-origin' | 'origin' | 'strict-origin' | 'origin-when-cross-origin' | 'strict-origin-when-cross-origin' | 'unsafe-url';
 export type RequestInfo = string | Request;
 export class Request extends BodyMixin {
-	constructor(input: RequestInfo, init?: RequestInit);
+	constructor(input: URL | RequestInfo, init?: RequestInit);

 	/**
 	 * Returns a Headers object consisting of the headers associated with request. Note that headers added in the network layer by the user agent will not be accounted for in this object, e.g., the "Host" header.
@@ -196,6 +196,7 @@ export class Response extends BodyMixin {

 	static error(): Response;
 	static redirect(url: string, status?: number): Response;
+	static json(data: any, init?: ResponseInit): Response;
 }

 export class FetchError extends Error {
@@ -215,4 +216,4 @@ export class AbortError extends Error {
 }

 export function isRedirect(code: number): boolean;
-export default function fetch(url: RequestInfo, init?: RequestInit): Promise<Response>;
+export default function fetch(url: URL | RequestInfo, init?: RequestInit): Promise<Response>;
@@ -269,8 +269,8 @@ It is common to create a helper function to check that the response contains no
 import fetch from 'node-fetch';

 class HTTPResponseError extends Error {
-	constructor(response, ...args) {
-		super(`HTTP Error Response: ${response.status} ${response.statusText}`, ...args);
+	constructor(response) {
+		super(`HTTP Error Response: ${response.status} ${response.statusText}`);
 		this.response = response;
 	}
 }
@@ -400,7 +400,7 @@ console.log(response.headers.raw()['set-cookie']);
 ### Post data using a file

 ```js
-import fetch {
+import fetch, {
  Blob,
  blobFrom,
  blobFromSync,
@@ -539,7 +539,6 @@ If no values are set, the following request headers will be sent automatically:
 | ------------------- | ------------------------------------------------------ |
 | `Accept-Encoding`   | `gzip, deflate, br` (when `options.compress === true`) |
 | `Accept`            | `*/*`                                                  |
-| `Connection`        | `close` _(when no `options.agent` is present)_         |
 | `Content-Length`    | _(automatically calculated, if possible)_              |
 | `Host`              | _(host and port information from the target URI)_      |
 | `Transfer-Encoding` | `chunked` _(when `req.body` is a stream)_              |
@@ -558,6 +557,8 @@ The `agent` option allows you to specify networking related options which are ou

 See [`http.Agent`](https://nodejs.org/api/http.html#http_new_agent_options) for more information.

+If no agent is specified, the default agent provided by Node.js is used. Note that [this changed in Node.js 19](https://github.com/nodejs/node/blob/4267b92604ad78584244488e7f7508a690cb80d0/lib/_http_agent.js#L564) to have `keepalive` true by default. If you wish to enable `keepalive` in an earlier version of Node.js, you can override the agent as per the following code sample. 
+
 In addition, the `agent` option accepts a function that returns `http`(s)`.Agent` instance given current [URL](https://nodejs.org/api/url.html), this is useful during a redirection chain across HTTP and HTTPS protocol.

 ```js
@@ -627,7 +628,7 @@ results in an [opaque-redirect filtered response](https://fetch.spec.whatwg.org/
 node-fetch gives you the typical [basic filtered response](https://fetch.spec.whatwg.org/#concept-filtered-response-basic) instead.

 ```js
-const fetch = require('node-fetch');
+import fetch from 'node-fetch';

 const response = await fetch('https://httpbin.org/status/301', { redirect: 'manual' });

@@ -1,6 +1,6 @@
 {
  "name": "node-fetch",
-  "version": "3.2.10",
+  "version": "3.3.2",
  "description": "A light-weight module that brings Fetch API to node.js",
  "main": "./src/index.js",
  "sideEffects": false,
@@ -288,10 +288,6 @@ export const getNodeRequestOptions = request => {
 		agent = agent(parsedURL);
 	}

-	if (!headers.has('Connection') && !agent) {
-		headers.set('Connection', 'close');
-	}
-
 	// HTTP-network fetch step 4.2
 	// chunked encoding is handled by Node.js

@@ -124,6 +124,25 @@ export default class Response extends Body {
 		return response;
 	}

+	static json(data = undefined, init = {}) {
+		const body = JSON.stringify(data);
+
+		if (body === undefined) {
+			throw new TypeError('data is not JSON serializable');
+		}
+
+		const headers = new Headers(init && init.headers);
+
+		if (!headers.has('content-type')) {
+			headers.set('content-type', 'application/json');
+		}
+
+		return new Response(body, {
+			...init,
+			headers
+		});
+	}
+
 	get [Symbol.toStringTag]() {
 		return 'Response';
 	}
@@ -1,32 +1,32 @@
 {
-  "name": "github-release-to-discord",
-  "version": "1.13.0",
+  "name": "github-releases-to-discord",
+  "version": "1.15.0",
  "lockfileVersion": 2,
  "requires": true,
  "packages": {
    "": {
-      "name": "github-release-to-discord",
-      "version": "1.13.0",
+      "name": "github-releases-to-discord",
+      "version": "1.15.0",
      "license": "MIT",
      "dependencies": {
-        "@actions/core": "^1.9.1",
-        "@actions/github": "^5.0.3",
-        "node-fetch": "^3.2.10"
+        "@actions/core": "^1.10.1",
+        "@actions/github": "^5.1.1",
+        "node-fetch": "^3.3.2"
      }
    },
    "node_modules/@actions/core": {
-      "version": "1.9.1",
-      "resolved": "https://registry.npmjs.org/@actions/core/-/core-1.9.1.tgz",
-      "integrity": "sha512-5ad+U2YGrmmiw6du20AQW5XuWo7UKN2052FjSV7MX+Wfjf8sCqcsZe62NfgHys4QI4/Y+vQvLKYL8jWtA1ZBTA==",
+      "version": "1.10.1",
+      "resolved": "https://registry.npmjs.org/@actions/core/-/core-1.10.1.tgz",
+      "integrity": "sha512-3lBR9EDAY+iYIpTnTIXmWcNbX3T2kCkAEQGIQx4NVQ0575nk2k3GRZDTPQG+vVtS2izSLmINlxXf0uLtnrTP+g==",
      "dependencies": {
        "@actions/http-client": "^2.0.1",
        "uuid": "^8.3.2"
      }
    },
    "node_modules/@actions/github": {
-      "version": "5.0.3",
-      "resolved": "https://registry.npmjs.org/@actions/github/-/github-5.0.3.tgz",
-      "integrity": "sha512-myjA/pdLQfhUGLtRZC/J4L1RXOG4o6aYdiEq+zr5wVVKljzbFld+xv10k1FX6IkIJtNxbAq44BdwSNpQ015P0A==",
+      "version": "5.1.1",
+      "resolved": "https://registry.npmjs.org/@actions/github/-/github-5.1.1.tgz",
+      "integrity": "sha512-Nk59rMDoJaV+mHCOJPXuvB1zIbomlKS0dmSIqPGxd0enAXBnOfn4VWF+CGtRCwXZG9Epa54tZA7VIRlJDS8A6g==",
      "dependencies": {
        "@actions/http-client": "^2.0.1",
        "@octokit/core": "^3.6.0",
@@ -240,9 +240,9 @@
      }
    },
    "node_modules/node-fetch": {
-      "version": "3.2.10",
-      "resolved": "https://registry.npmjs.org/node-fetch/-/node-fetch-3.2.10.tgz",
-      "integrity": "sha512-MhuzNwdURnZ1Cp4XTazr69K0BTizsBroX7Zx3UgDSVcZYKF/6p0CBe4EUb/hLqmzVhl0UpYfgRljQ4yxE+iCxA==",
+      "version": "3.3.2",
+      "resolved": "https://registry.npmjs.org/node-fetch/-/node-fetch-3.3.2.tgz",
+      "integrity": "sha512-dRB78srN/l6gqWulah9SrxeYnxeddIG30+GOqK/9OlLVyLg3HPnr6SqOWTWOXKRwC2eGYCkZ59NNuSgvSrpgOA==",
      "dependencies": {
        "data-uri-to-buffer": "^4.0.0",
        "fetch-blob": "^3.1.4",
@@ -320,18 +320,18 @@
  },
  "dependencies": {
    "@actions/core": {
-      "version": "1.9.1",
-      "resolved": "https://registry.npmjs.org/@actions/core/-/core-1.9.1.tgz",
-      "integrity": "sha512-5ad+U2YGrmmiw6du20AQW5XuWo7UKN2052FjSV7MX+Wfjf8sCqcsZe62NfgHys4QI4/Y+vQvLKYL8jWtA1ZBTA==",
+      "version": "1.10.1",
+      "resolved": "https://registry.npmjs.org/@actions/core/-/core-1.10.1.tgz",
+      "integrity": "sha512-3lBR9EDAY+iYIpTnTIXmWcNbX3T2kCkAEQGIQx4NVQ0575nk2k3GRZDTPQG+vVtS2izSLmINlxXf0uLtnrTP+g==",
      "requires": {
        "@actions/http-client": "^2.0.1",
        "uuid": "^8.3.2"
      }
    },
    "@actions/github": {
-      "version": "5.0.3",
-      "resolved": "https://registry.npmjs.org/@actions/github/-/github-5.0.3.tgz",
-      "integrity": "sha512-myjA/pdLQfhUGLtRZC/J4L1RXOG4o6aYdiEq+zr5wVVKljzbFld+xv10k1FX6IkIJtNxbAq44BdwSNpQ015P0A==",
+      "version": "5.1.1",
+      "resolved": "https://registry.npmjs.org/@actions/github/-/github-5.1.1.tgz",
+      "integrity": "sha512-Nk59rMDoJaV+mHCOJPXuvB1zIbomlKS0dmSIqPGxd0enAXBnOfn4VWF+CGtRCwXZG9Epa54tZA7VIRlJDS8A6g==",
      "requires": {
        "@actions/http-client": "^2.0.1",
        "@octokit/core": "^3.6.0",
@@ -495,9 +495,9 @@
      "integrity": "sha512-/jKZoMpw0F8GRwl4/eLROPA3cfcXtLApP0QzLmUT/HuPCZWyB7IY9ZrMeKw2O/nFIqPQB3PVM9aYm0F312AXDQ=="
    },
    "node-fetch": {
-      "version": "3.2.10",
-      "resolved": "https://registry.npmjs.org/node-fetch/-/node-fetch-3.2.10.tgz",
-      "integrity": "sha512-MhuzNwdURnZ1Cp4XTazr69K0BTizsBroX7Zx3UgDSVcZYKF/6p0CBe4EUb/hLqmzVhl0UpYfgRljQ4yxE+iCxA==",
+      "version": "3.3.2",
+      "resolved": "https://registry.npmjs.org/node-fetch/-/node-fetch-3.3.2.tgz",
+      "integrity": "sha512-dRB78srN/l6gqWulah9SrxeYnxeddIG30+GOqK/9OlLVyLg3HPnr6SqOWTWOXKRwC2eGYCkZ59NNuSgvSrpgOA==",
      "requires": {
        "data-uri-to-buffer": "^4.0.0",
        "fetch-blob": "^3.1.4",
@@ -1,12 +1,9 @@
 {
-  "name": "github-release-to-discord",
-  "version": "1.13.0",
-  "description": "Github Action that parses a release and sends it to a Discord channel",
+  "name": "github-releases-to-discord",
+  "version": "1.15.0",
+  "description": "A GitHub Action that automatically sends a stylized Discord webhook of a GitHub Release description to a specified Discord channel.",
  "type": "module",
  "main": "index.js",
-  "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
-  },
  "keywords": [
    "discord",
    "github",
@@ -20,13 +17,13 @@
  ],
  "author": "SethCohen",
  "bugs": {
-    "url": "https://github.com/SethCohen/github-release-to-discord/issues"
+    "url": "https://github.com/SethCohen/github-releases-to-discord/issues"
  },
-  "homepage": "https://github.com/SethCohen/github-release-to-discord#readme",
+  "homepage": "https://github.com/SethCohen/github-releases-to-discord#readme",
  "license": "MIT",
  "dependencies": {
-    "@actions/core": "^1.9.1",
-    "@actions/github": "^5.0.3",
-    "node-fetch": "^3.2.10"
+    "@actions/core": "^1.10.1",
+    "@actions/github": "^5.1.1",
+    "node-fetch": "^3.3.2"
  }
 }
Author	SHA1	Message	Date
SethCohen	7de2fd1c2a	chore(master): release 1.15.0 (#26 )	2023-12-14 16:11:51 -05:00
Ryan Hullah	97a481333d	feat: added clip description at last newline (#25 )	2023-12-14 16:10:43 -05:00
SethCohen	b7c20771bd	chore(master): release 1.14.0 (#24 )	2023-12-11 11:18:45 -05:00
Ryan Hullah	8ca9da2ca8	feat: added additional description formatting (#23 ) remove: removed HTML comments added by the 'Generate release notes' button feat: description trimming style: reduce consecutive whitespace/newlines into a minimum of 2 to allow separation in paragraphs style: parse common Github URLs to more appropriate display feat: added max_description option feat: added reduce_headings option	2023-12-11 11:18:02 -05:00
SethCohen	254bf79196	chore: update README.md	2023-09-23 13:32:12 -04:00
SethCohen	1ce3bed332	chore(master): release 1.13.1 (#21 )	2023-09-23 13:06:43 -04:00
SethCohen	933f3cffcf	chore: updated release-please action	2023-09-23 13:03:16 -04:00
SethCohen	24b80abb6f	chore: updated dependencies	2023-09-23 12:37:35 -04:00
Shon	f228faeb5e	Implement more functions (#20 ) * Send the release title instead of version & remove the `Release` text * Ability to use the existing Discord user & avatar * fix * Support for adding a footer * Update index.js * Update index.js * Update index.js * Updated docs * Support for footer timestamps * Support for sending normal text above the embed useful for pings	2023-09-23 12:18:00 -04:00
SethCohen	ba06d83352	chore: updated README.md	2022-08-24 21:19:52 -04:00
SethCohen	ce7fc4a3be	chore: updated README.md	2022-08-24 21:17:31 -04:00
SethCohen	c240910f89	chore: updated action info	2022-08-24 21:12:53 -04:00
SethCohen	a12acb913f	Merge remote-tracking branch 'origin/master'	2022-08-24 21:05:09 -04:00
SethCohen	c8889535c4	chore: updated action info	2022-08-24 21:05:04 -04:00