chore(master): release 1.14.0 (#24)

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

CHANGELOG.md

@@ -1,5 +1,26 @@
 # Changelog
 
+## [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)
 
 

README.md

@@ -7,16 +7,18 @@ 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        | ❌       |                                                                                                                | 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.        |
+| 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
 
@@ -33,7 +35,7 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v3
       - name: Github Releases To Discord
-        uses: SethCohen/github-releases-to-discord@v1.13.0
+        uses: SethCohen/github-releases-to-discord@v1.13.1
         with:
           webhook_url: ${{ secrets.WEBHOOK_URL }}
           color: "2105893"

action.yml

@@ -27,6 +27,14 @@ inputs:
   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'

index.js

@@ -4,45 +4,119 @@ 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 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(/<!--.*?-->/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), name: string}>}
  */
-async function getContext () {
+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}))`,
-            name: payload.release.name,
+        body: payload.release.body,
+        name: payload.release.name,
         html_url: payload.release.html_url
     }
 }
 
+/**
+ * 
+ * @param {string} str
+ * @param {number} maxLength
+ * @param {string=} url
+ */
+function limit(str, maxLength, url) {
+    if (str.length <= maxLength)
+        return str
+    let replacement = '…'
+    if (url) {
+        replacement = `([${replacement}](${url}))`
+    }
+    maxLength = maxLength - replacement.length
+    str = str.substring(0, maxLength)
+
+    const lastWhitespace = str.search(/[^\s]*$/)
+    if (lastWhitespace > -1) {
+        str = str.substring(0, lastWhitespace)
+    }
+
+    return str + replacement
+}
+
 /**
  * Handles the action.
  * Get inputs, creates a stylized response webhook, and sends it to the channel.
- * @returns {Promise<void>}
  */
 async function run () {
     const webhookUrl = core.getInput('webhook_url');
@@ -56,22 +130,25 @@ async function run () {
 
     if (!webhookUrl) return core.setFailed('webhook_url not set. Please set it.');
 
-    const {body, html_url, name} = await getContext();
+    const {body, html_url, name} = getContext();
 
     const description = formatDescription(body);
 
     let embedMsg = {
-        title: name,
+        title: limit(name, 256),
         url: html_url,
         color: color,
         description: description,
         footer: {}
     }
 
-    if (footerTitle != '') embedMsg.footer.text = footerTitle;
+    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)
+
     let requestBody = {
         embeds: [embedMsg]
     }

package-lock.json

@@ -1,12 +1,12 @@
 {
   "name": "github-releases-to-discord",
-  "version": "1.13.1",
+  "version": "1.14.0",
   "lockfileVersion": 2,
   "requires": true,
   "packages": {
     "": {
       "name": "github-releases-to-discord",
-      "version": "1.13.1",
+      "version": "1.14.0",
       "license": "MIT",
       "dependencies": {
         "@actions/core": "^1.10.1",

package.json

@@ -1,6 +1,6 @@
 {
   "name": "github-releases-to-discord",
-  "version": "1.13.1",
+  "version": "1.14.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",