chore(master): release 1.16.0 (#37)

resolves #32

.github/workflows/test.yml

@@ -11,4 +11,14 @@ jobs:
       - name: Github Releases To Discord
         uses: ./ # Uses an action in the root directory
         with:
-          webhook_url: ${{ secrets.WEBHOOK_URL }}
+          webhook_url: ${{ inputs.WEBHOOK_URL }}
+          color: ${{ inputs.COLOR }}
+          username: ${{ inputs.USERNAME }}
+          avatar_url: ${{ inputs.AVATAR_URL }}
+          content: ${{ inputs.CONTENT }}
+          footer_title: ${{ inputs.FOOTER_TITLE }}
+          footer_icon_url: ${{ inputs.FOOTER_ICON_URL }}
+          footer_timestamp: ${{ inputs.FOOTER_TIMESTAMP }}
+          max_description: ${{ inputs.MAX_DESCRIPTION }}
+          reduce_headings: ${{ inputs.REDUCE_HEADINGS }}
+          

.gitignore

@@ -2,3 +2,9 @@
 *.iml
 out
 gen
+.env
+tests/sample-test-release.json
+release.json
+repository.json
+user.json
+tests/sample-test-release-v2.json

CHANGELOG.md

@@ -1,5 +1,58 @@
 # Changelog
 
+## [1.16.0](https://github.com/SethCohen/github-releases-to-discord/compare/v1.15.3...v1.16.0) (2024-10-18)
+
+
+### Features
+
+* add function to convert PR, issue, and changelog links to markdown format ([07c2e1c](https://github.com/SethCohen/github-releases-to-discord/commit/07c2e1c3e60591d601b5d4b5bd4fc90e599867f8)), closes [#32](https://github.com/SethCohen/github-releases-to-discord/issues/32)
+
+## [1.15.3](https://github.com/SethCohen/github-releases-to-discord/compare/v1.15.2...v1.15.3) (2024-10-18)
+
+
+### Documentation
+
+* add contribution guidelines to README.md ([5fd64bf](https://github.com/SethCohen/github-releases-to-discord/commit/5fd64bf266cea87ab4952ef9a4c6aaf099f266bc))
+* update version reference in README.md ([93d02ce](https://github.com/SethCohen/github-releases-to-discord/commit/93d02ce8714c5f3e201f5b379422e978b837774b))
+
+
+### Miscellaneous
+
+* update .gitignore ([3449e38](https://github.com/SethCohen/github-releases-to-discord/commit/3449e38629b0c40dde5af524e2fef220dab24ead))
+* update package-lock.json ([5dc4108](https://github.com/SethCohen/github-releases-to-discord/commit/5dc41089e63d18b5b191533c34cdddeab34a07e8))
+
+## [1.15.2](https://github.com/SethCohen/github-releases-to-discord/compare/v1.15.1...v1.15.2) (2024-10-18)
+
+
+### Bug Fixes
+
+* improve [@mention](https://github.com/mention) parsing for GitHub usernames ([#33](https://github.com/SethCohen/github-releases-to-discord/issues/33)) ([925765f](https://github.com/SethCohen/github-releases-to-discord/commit/925765f099dcdc3b12316eaa6dc3c17506734b51))
+
+## [1.15.1](https://github.com/SethCohen/github-releases-to-discord/compare/v1.15.0...v1.15.1) (2024-10-04)
+
+
+### Documentation
+
+* updated README.md ([613ba26](https://github.com/SethCohen/github-releases-to-discord/commit/613ba269d7fe40e97040da19de58b0ae00b47aaf))
+
+
+### Miscellaneous
+
+* added test envs to .gitignore ([735cca9](https://github.com/SethCohen/github-releases-to-discord/commit/735cca9de37b345e69b0c74ff761610eab6f1fd1))
+* updated test action ([305fe92](https://github.com/SethCohen/github-releases-to-discord/commit/305fe9299dddb3a514f2b1692773570862c34d46))
+
+
+### Code Refactoring
+
+* code cleanup ([5ca1453](https://github.com/SethCohen/github-releases-to-discord/commit/5ca1453a69f962930450a9f77d4e20cc37e4110f))
+
+## [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)
 
 

README.md

@@ -1,8 +1,24 @@
 # 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.
+
+A GitHub Action that sends a stylized Discord webhook containing the description of a GitHub Release to a specified Discord channel. It formats the description to improve readability and includes various configuration options to customize the message.
+
+## Features
+
+- Formats release descriptions by:
+  - Removing carriage returns and HTML comments.
+  - Styling headers for better readability in Discord (optional).
+  - Cleaning up redundant whitespace and newlines.
+  - Converting common GitHub links (e.g., PRs, Issues) into clickable URLs.
+- Limits description length to avoid exceeding Discord's character limits.
+- Provides customization for the Discord message, including:
+  - Webhook URL, message color, footer text/icon, and timestamp.
+  - Username and avatar for the webhook.
+  - Optional message content outside the embed.
 
 ---
+
 ## Output
+
 ![output](https://i.imgur.com/Zf3TXtb.png)
 
 ## Configuration
@@ -23,6 +39,7 @@ A GitHub action that parses a GitHub release and posts it to a Discord channel a
 ## Example Usage
 
 `.github/workflows/github-releases-to-discord.yml`
+
 ```yaml
 on:
   release:
@@ -35,7 +52,7 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v3
       - name: Github Releases To Discord
-        uses: SethCohen/github-releases-to-discord@v1.13.1
+        uses: SethCohen/github-releases-to-discord@v1
         with:
           webhook_url: ${{ secrets.WEBHOOK_URL }}
           color: "2105893"
@@ -45,17 +62,70 @@ jobs:
           footer_title: "Changelog"
           footer_icon_url: "https://cdn.discordapp.com/avatars/487431320314576937/bd64361e4ba6313d561d54e78c9e7171.png"
           footer_timestamp: true
+          max_description: '4096'
+          reduce_headings: true
 ```
 
 ## Setup Instructions
+
 1. Open your **Server Settings** and head into the **Integrations** tab:
 2. Click the "**Create Webhook**" button to create a new webhook!
-   ![](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)
+   ![create webhook](https://support.discord.com/hc/article_attachments/1500000463501/Screen_Shot_2020-12-15_at_4.41.53_PM.png)
+   ![created webhook](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.
-   ![](https://i.imgur.com/hAaNOds.png)
+   ![repository secret](https://i.imgur.com/hAaNOds.png)
 5. Save the secret.
 6. Add the secret to your action configuration.
 
 And you're done! Whenever you create a new release, the workflow should run and, if properly setup, post to your specified Discord channel.
+
+## Contributing
+
+If you have suggestions for how GitHub Releases To Discord Action could be improved, or want to report a bug, open an issue! We'd love all and any contributions.
+
+1. Fork the repository.
+2. Install node and run `npm install`.
+3. Install [Github Action tester `act`](https://github.com/nektos/act)
+4. Create a sample test Release file to simulate a webhook payload object such as `tests/sample-test-release.json` with the following structure:
+  
+```json
+{
+  "action": "published",
+  "release": {
+      ...
+  },
+  "repository": {
+      ...
+  },
+  "sender": {
+      ...
+  }
+}
+```
+
+This file will be used to test the action locally and simulate a real release event webhook payload. Refer to the [GitHub Webhook documentation](https://docs.github.com/en/webhooks/webhook-events-and-payloads?actionType=published#release) and the [Github API Documentation](https://docs.github.com/en/rest/releases/releases?apiVersion=2022-11-28#get-a-release) for more information on the webhook payload structure.
+
+6. Fill the test json file with the necessary fields to simulate a release event.
+
+5. Create a test file called `.env` in the main root of the project with the following environmental variables:
+
+```bash
+  INPUT_WEBHOOK_URL=
+  INPUT_COLOR=
+  INPUT_USERNAME=
+  INPUT_AVATAR_URL=
+  INPUT_CONTENT=
+  INPUT_FOOTER_TITLE=
+  INPUT_FOOTER_ICON_URL=
+  INPUT_FOOTER_TIMESTAMP=
+  INPUT_MAX_DESCRIPTION=
+  INPUT_REDUCE_HEADINGS=
+```
+
+8. Fill the `.env` file with your chosen environmental variables values.
+9. Create a Discord webhook in your server, making sure to add the webhook url to the `.env` file under `INPUT_WEBHOOK_URL=`.
+10. Run the action locally with `act release -e <your.json>` (e.g. `act release -e tests/sample-test-release.json`) and check the output in your Discord server.
+11. Confirm that the action works as expected.
+12. Make your changes and commit them: `git commit -m '<commit_message>'`. Please follow [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/).
+13. Create the pull request.

index.js

@@ -2,172 +2,236 @@ import core from '@actions/core';
 import github from '@actions/github';
 import fetch from 'node-fetch';
 
+/**
+ * Removes carriage return characters.
+ * @param {string} text The input text.
+ * @returns {string} The text without carriage return characters.
+ */
+const removeCarriageReturn = (text) => text.replace(/\r/g, '');
+
+/**
+ * Removes HTML comments.
+ * @param {string} text The input text.
+ * @returns {string} The text without HTML comments.
+ */
+const removeHTMLComments = (text) => text.replace(/<!--.*?-->/gs, '');
+
+/**
+ * Reduces redundant newlines and spaces.
+ * Keeps a maximum of 2 newlines to provide spacing between paragraphs.
+ * @param {string} text The input text.
+ * @returns {string} The text with reduced newlines.
+ */
+const reduceNewlines = (text) => text.replace(/\n\s*\n/g, (ws) => {
+    const nlCount = (ws.match(/\n/g) || []).length;
+    return nlCount >= 2 ? '\n\n' : '\n';
+});
+
+/**
+ * Converts @mentions to GitHub profile links for valid GitHub usernames.
+ * @param {string} text The input text.
+ * @returns {string} The text with valid @mentions converted to links.
+ */
+const convertMentionsToLinks = (text) => text.replace(
+    /(?<![/@\w])@((?!-)(?!.*?--)[a-zA-Z0-9](?:-?[a-zA-Z0-9]){0,37})(?![.\w/-])(?!.*\])/g,
+    (match, name) => `[@${name}](https://github.com/${name})`
+);
+
+/**
+ * Reduces headings to a smaller format if 'reduce_headings' is enabled.
+ * Converts H3 to bold+underline, H2 to bold.
+ * @param {string} text The input text.
+ * @returns {string} The text with reduced heading sizes.
+ */
+const reduceHeadings = (text) => text
+    .replace(/^###\s+(.+)$/gm, '**__$1__**') // Convert H3 to bold + underline
+    .replace(/^##\s+(.+)$/gm, '**$1**');     // Convert H2 to bold
+
+/**
+ * Converts PR links, issue links, and changelog links to markdown format.
+ * - PR links: `https://github.com/OWNER/REPO/pull/1` -> `[PR #1](https://github.com/OWNER/REPO/pull/1)`
+ * - Issue links: `https://github.com/OWNER/REPO/issues/1` -> `[Issue #30](https://github.com/OWNER/REPO/issues/1)`
+ * - Changelog links: `https://github.com/OWNER/REPO/compare/v1.0.0...v1.1.0` -> `[v1.0.0...v1.1.0](https://github.com/OWNER/REPO/compare/v1.0.0...v1.1.0)`
+ * @param {string} text The input text.
+ * @returns {string} The text with links converted to markdown format.
+ */
+const convertLinksToMarkdown = (text) => {
+    // Convert PR links
+    text = text.replace(
+        /https:\/\/github\.com\/([\w-]+)\/([\w-]+)\/pull\/(\d+)/g,
+        (match, owner, repo, prNumber) => `[PR #${prNumber}](${match})`
+    );
+
+    // Convert issue links
+    text = text.replace(
+        /https:\/\/github\.com\/([\w-]+)\/([\w-]+)\/issues\/(\d+)/g,
+        (match, owner, repo, issueNumber) => `[Issue #${issueNumber}](${match})`
+    );
+
+    // Convert changelog comparison links
+    text = text.replace(
+        /https:\/\/github\.com\/([\w-]+)\/([\w-]+)\/compare\/([v\w.-]+)\.\.\.([v\w.-]+)/g,
+        (match, owner, repo, fromVersion, toVersion) => `[${fromVersion}...${toVersion}](${match})`
+    );
+
+    return text;
+};
+
 /**
  * Stylizes a markdown body into an appropriate embed message style.
- *  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
+ * @param {string} description The description to format.
+ * @returns {string} The formatted description.
  */
 const formatDescription = (description) => {
-    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'
-        })
-        .trim()
+    let edit = removeCarriageReturn(description);
+    edit = removeHTMLComments(edit);
+    edit = reduceNewlines(edit);
+    edit = convertMentionsToLinks(edit);
+    edit = convertLinksToMarkdown(edit);
+    edit = edit.trim();
 
     if (core.getBooleanInput('reduce_headings')) {
-        edit = edit
-            .replace(/^###\s+(.+)$/gm, '**__$1__**')
-            .replace(/^##\s+(.+)$/gm, '**$1**')
+        edit = reduceHeadings(edit);
     }
 
-    return edit
-}
+    return edit;
+};
 
 /**
- * Get a prefix to use for Github link display
- * @param {'issues' | 'pull' | 'commit' | 'compare'} type 
+ * Gets the max description length, defaulting to 4096 if not set or invalid.
+ * @returns {number} The max description length.
  */
-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 () {
+const 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)
+        const max = core.getInput('max_description');
+        if (max && !isNaN(max)) {
+            return Math.min(parseInt(max, 10), 4096);
         }
     } catch (err) {
-        core.warning(`max_description not a valid number: ${err}`)
+        core.warning(`Invalid max_description: ${err}`);
     }
-    return 4096
-}
+    return 4096;
+};
 
 /**
- * Get the context of the action, returns a GitHub Release payload.
+ * Get the context of the action, returning a GitHub Release payload.
+ * @returns {object} The context with release details.
  */
-function getContext () {
-    const payload = github.context.payload;
-
+const getContext = () => {
+    const { release } = github.context.payload;
     return {
-        body: payload.release.body,
-        name: payload.release.name,
-        html_url: payload.release.html_url
-    }
-}
+        body: release.body,
+        name: release.name,
+        html_url: release.html_url
+    };
+};
 
 /**
- * 
- * @param {string} str
- * @param {number} maxLength
- * @param {string=} url
+ * Limits the string to a maximum length, optionally adding a URL or clipping at a newline.
+ * @param {string} str The string to limit.
+ * @param {number} maxLength The maximum allowed length.
+ * @param {string} [url] Optional URL for linking the truncated text.
+ * @param {boolean} [clipAtLine=false] Whether to clip at the nearest newline.
+ * @returns {string} The limited string.
  */
-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 limitString = (str, maxLength, url, clipAtLine = false) => {
+    if (str.length <= maxLength) return str;
 
-    const lastWhitespace = str.search(/[^\s]*$/)
-    if (lastWhitespace > -1) {
-        str = str.substring(0, lastWhitespace)
+    const replacement = url
+        ? `${clipAtLine ? '\n' : ''}([…](${url}))`
+        : (clipAtLine ? '\n…' : '…');
+
+    maxLength -= replacement.length;
+    str = str.substring(0, maxLength);
+
+    const lastNewline = str.search(new RegExp(`[^${clipAtLine ? '\n' : '\s'}]*$`));
+    if (lastNewline > -1) {
+        str = str.substring(0, lastNewline);
     }
 
-    return str + replacement
-}
+    return str + replacement;
+};
 
 /**
- * Handles the action.
- * Get inputs, creates a stylized response webhook, and sends it to the channel.
+ * Builds the embed message for the Discord webhook.
+ * @param {string} name The title or name of the release.
+ * @param {string} html_url The URL of the release.
+ * @param {string} description The formatted description of the release.
+ * @returns {object} The embed message to send in the webhook.
  */
-async function run () {
+const buildEmbedMessage = (name, html_url, description) => {
+    const embedMsg = {
+        title: limitString(name, 256),
+        url: html_url,
+        color: core.getInput('color'),
+        description: limitString(description, Math.min(getMaxDescription(), 6000 - name.length)),
+        footer: {}
+    };
+
+    if (core.getInput('footer_title')) {
+        embedMsg.footer.text = limitString(core.getInput('footer_title'), 2048);
+    }
+    if (core.getInput('footer_icon_url')) {
+        embedMsg.footer.icon_url = core.getInput('footer_icon_url');
+    }
+    if (core.getInput('footer_timestamp') === 'true') {
+        embedMsg.timestamp = new Date().toISOString();
+    }
+
+    return embedMsg;
+};
+
+/**
+ * Sends the webhook request to Discord.
+ * @param {string} webhookUrl The URL of the Discord webhook.
+ * @param {object} requestBody The payload to send in the webhook.
+ */
+const sendWebhook = async (webhookUrl, requestBody) => {
+    try {
+        const response = await fetch(`${webhookUrl}?wait=true`, {
+            method: 'POST',
+            body: JSON.stringify(requestBody),
+            headers: { 'Content-Type': 'application/json' }
+        });
+        const data = await response.json();
+        core.info(JSON.stringify(data));
+    } catch (err) {
+        core.setFailed(err.message);
+    }
+};
+
+/**
+ * Builds the request body for the Discord webhook.
+ * @param {object} embedMsg The embed message to include in the request body.
+ * @returns {object} The request body for the webhook.
+ */
+const buildRequestBody = (embedMsg) => {
+    return {
+        embeds: [embedMsg],
+        ...(core.getInput('username') && { username: core.getInput('username') }),
+        ...(core.getInput('avatar_url') && { avatar_url: core.getInput('avatar_url') }),
+        ...(core.getInput('content') && { content: core.getInput('content') })
+    };
+};
+
+
+/**
+ * Main function to handle the action: get inputs, format the message, and send the webhook.
+ */
+const run = async () => {
     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();
+    if (!webhookUrl) return core.setFailed('webhook_url not set.');
 
+    const { body, html_url, name } = getContext();
     const description = formatDescription(body);
 
-    let embedMsg = {
-        title: limit(name, 256),
-        url: html_url,
-        color: color,
-        description: description,
-        footer: {}
-    }
+    const embedMsg = buildEmbedMessage(name, html_url, description);
 
-    if (footerTitle != '') embedMsg.footer.text = limit(footerTitle, 2048);
-    if (footerIconUrl != '') embedMsg.footer.icon_url = footerIconUrl;
-    if (footerTimestamp == 'true') embedMsg.timestamp = new Date().toISOString();
+    const requestBody = buildRequestBody(embedMsg);
 
-    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]
-    }
-
-    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),
-        headers: { 'Content-Type': 'application/json' }
-    })
-        .then(res => res.json())
-        .then(data => core.info(JSON.stringify(data)))
-        .catch(err => core.info(err))
-}
+    await sendWebhook(webhookUrl, requestBody);
+};
 
 run()
-    .then(() => {core.info('Action completed successfully')})
-    .catch(err => {core.setFailed(err.message)})
+    .then(() => core.info('Action completed successfully'))
+    .catch(err => core.setFailed(err.message));

node_modules/.package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "github-releases-to-discord",
-  "version": "1.13.0",
+  "version": "1.15.1",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {

package-lock.json

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

package.json

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