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

chore(master): release 1.5.0

CHANGELOG.md

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

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`
+## Output
-
+![output](https://i.imgur.com/fOIu7pC.png)
-**Required** The name of the person to greet. Default `"World"`.
-
-## Outputs
-
-## `time`
-
-The time we greeted you.
 
 ## Example usage
 
-uses: actions/hello-world-javascript-action@v1.1
+```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:
-who-to-greet: 'Mona the Octocat'
+          webhook_url: ${{ secrets.WEBHOOK_URL }}
+```

action.yml

@@ -7,7 +7,7 @@ inputs:
   colour:
     description: Decimal colour value for embed.
     required: false
-    default: '202225'
+    default: '2105893'
   username:
     description: String username for webhook.
     required: false

index.js

@@ -27,18 +27,15 @@ async function run () {
 
         const content = await getContext()
 
-        let description = '';
+        const description = content.body
-        for (const line of content.body) {
+            .replace(/## (.*?)\n/g,function (substring) {
-            if (line.startsWith('## ')) {
+                const newString = substring.slice(3)
-                description += `**${line.slice(3)}**\n`;
+                return `**${newString}**\n`
-            }
+            })
-            else if (line.startsWith('### ')) {
+            .replace(/### (.*?)\n/g,function (substring) {
-                description += `**__${line.slice(4)}__**\n`;
+                const newString = substring.slice(4)
-            }
+                return `**__${newString}__**\n`
-            else if (line.startsWith('* ')) {
+            })
-                description += `- ${line.slice(2)}\n`;
-            }
-        }
 
         const embedMsg = {
             title: `Release ${content.version}`,

package-lock.json

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

package.json

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