Merge pull request #8 from SethCohen/release-please--branches--master--components--release-please-action

chore(master): release 1.7.0

CHANGELOG.md

@@ -1,5 +1,49 @@
 # Changelog
 
+## [1.7.0](https://github.com/SethCohen/github-release-to-discord/compare/v1.6.0...v1.7.0) (2022-08-24)
+
+
+### Features
+
+* updated action description format ([c517936](https://github.com/SethCohen/github-release-to-discord/commit/c517936fefb0119c0055d4d537bad23e647edd44))
+
+## [1.6.0](https://github.com/SethCohen/github-release-to-discord/compare/v1.5.0...v1.6.0) (2022-08-24)
+
+
+### Features
+
+* updated action description format ([7effb69](https://github.com/SethCohen/github-release-to-discord/commit/7effb69a75fd35dc53ea6dad5f3fa60cbd523ee7))
+
+## [1.5.0](https://github.com/SethCohen/github-release-to-discord/compare/v1.4.0...v1.5.0) (2022-08-24)
+
+
+### Features
+
+* updated action description format ([9f49b0c](https://github.com/SethCohen/github-release-to-discord/commit/9f49b0c9ab5de966ccc4af94863fbddd73bac884))
+
+## [1.4.0](https://github.com/SethCohen/github-release-to-discord/compare/v1.3.0...v1.4.0) (2022-08-24)
+
+
+### Features
+
+* updated action colour ([ac2e4a3](https://github.com/SethCohen/github-release-to-discord/commit/ac2e4a38e2cad7e65dac53a1b4591fd46d65130d))
+* updated description ([4517d8d](https://github.com/SethCohen/github-release-to-discord/commit/4517d8d0ec09c575248503c50ed25f15677f8f3d))
+
+## [1.3.0](https://github.com/SethCohen/github-release-to-discord/compare/v1.2.0...v1.3.0) (2022-08-24)
+
+
+### Features
+
+* changed default action colour ([79005b2](https://github.com/SethCohen/github-release-to-discord/commit/79005b23fefce850957d37ba17ebb796dc81f6a1))
+* updated description format ([a1d7a74](https://github.com/SethCohen/github-release-to-discord/commit/a1d7a74af90fcf8c00d341c8c665ca796b18c689))
+
+## [1.2.0](https://github.com/SethCohen/github-release-to-discord/compare/v1.1.0...v1.2.0) (2022-08-24)
+
+
+### Features
+
+* updated action ([b612527](https://github.com/SethCohen/github-release-to-discord/commit/b6125273330075a9f4de3e58f2fc7f52d85d4691))
+
 ## [1.1.0](https://github.com/SethCohen/github-release-to-discord/compare/v1.0.0...v1.1.0) (2022-08-24)
 
 

README.md

@@ -1,21 +1,34 @@
-# Hello world javascript action
+# Github Release To Discord Action
 
-This action prints "Hello World" or "Hello" + the name of a person to greet to the log.
+This action parses a github release and posts it to a discord channel via a discord webhook.
+## Configuration
+| Variable    | Required | Default                                                                                                   | Description                                 |
+|-------------|----------|----------------------------------------------------------------------------------------------------------------|---------------------------------------------|
+| webhook_url | ✔      |                                                                                                                | Discord's webhook url. Use GH repo secrets. |
+| colour      | ❌       | "2105893"                                                                                                      | Decimal colour 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.       |
 
-## Inputs
 
-## `who-to-greet`
-
-**Required** The name of the person to greet. Default `"World"`.
-
-## Outputs
-
-## `time`
-
-The time we greeted you.
+## Output
+![output](https://i.imgur.com/fOIu7pC.png)
 
 ## Example usage
 
-uses: actions/hello-world-javascript-action@v1.1
-with:
-who-to-greet: 'Mona the Octocat'
+```yaml
+on:
+  release:
+    types: [published]
+
+jobs:
+  github-release-to-discord:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Handle Release
+        uses: ./ # Uses an action in the root directory
+        id: release
+        with:
+          webhook_url: ${{ secrets.WEBHOOK_URL }}
+```

action.yml

@@ -4,6 +4,18 @@ inputs:
   webhook_url:
     description: Discord's webhook url. Use GH repo secrets.
     required: true
+  colour:
+    description: Decimal colour value for embed.
+    required: false
+    default: '2105893'
+  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'
 runs:
   using: 'node16'
   main: 'index.js'

index.js

@@ -1,6 +1,5 @@
 const core = require('@actions/core');
 const github = require('@actions/github');
-
 const fetch = require('node-fetch')
 
 async function getContext () {
@@ -18,6 +17,9 @@ async function getContext () {
 async function run () {
     try {
         const webhookUrl = core.getInput('webhook_url')
+        const colour = core.getInput('colour')
+        const username = core.getInput('username')
+        const avatarUrl = core.getInput('avatar_url')
 
         if (!webhookUrl) {
             return core.setFailed('webhook_url not set. Please set it.')
@@ -25,14 +27,25 @@ async function run () {
 
         const content = await getContext()
 
+        const description = content.body
+            .replace(/### (.*?)\n/g,function (substring) {
+                const newString = substring.slice(4)
+                return `**__${newString}__**`
+            })
+            .replace(/## (.*?)\n/g,function (substring) {
+                const newString = substring.slice(3)
+                return `**${newString}**`
+            })
+            .replace(/(\r\n|\n|\r)/gm, "\n")
+
         const embedMsg = {
-            color: 3447003,
             title: `Release ${content.version}`,
-            description: content.body,
-            url: content.html_url
+            url: content.html_url,
+            color: colour,
+            description: description,
         }
 
-        const body = { embeds: [embedMsg] }
+        const body = { username: username, avatar_url: avatarUrl, embeds: [embedMsg], }
 
         const url = `${webhookUrl}?wait=true`
 

package-lock.json

@@ -1,12 +1,12 @@
 {
   "name": "github-release-to-discord",
-  "version": "1.1.0",
+  "version": "1.7.0",
   "lockfileVersion": 2,
   "requires": true,
   "packages": {
     "": {
       "name": "github-release-to-discord",
-      "version": "1.1.0",
+      "version": "1.7.0",
       "license": "ISC",
       "dependencies": {
         "@actions/core": "^1.9.1",

package.json

@@ -1,6 +1,6 @@
 {
   "name": "github-release-to-discord",
-  "version": "1.1.0",
+  "version": "1.7.0",
   "description": "",
   "main": "index.js",
   "scripts": {