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

chore(master): release 1.12.1

.github/workflows/github-release-to-discord.yml

@@ -0,0 +1,15 @@
+on:
+  release:
+    types: [published]
+name: github-release-to-discord
+jobs:
+  github-release-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
+        id: release
+        with:
+          webhook_url: ${{ secrets.WEBHOOK_URL }}

.github/workflows/main.yml

@@ -1,18 +0,0 @@
-on:
-  release:
-    types: [published]
-name: github-release-to-discord
-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 }}
-          colour: "7766090"
-          username: "tes"
-          avatar_url: "https://i.imgur.com/UPbV3Nx.png"

CHANGELOG.md

@@ -1,5 +1,26 @@
 # Changelog
 
+## [1.12.1](https://github.com/SethCohen/github-release-to-discord/compare/v1.12.0...v1.12.1) (2022-08-24)
+
+
+### Miscellaneous Chores
+
+* release 1.12.1 ([6aea64b](https://github.com/SethCohen/github-release-to-discord/commit/6aea64bf70aca011417fed5000ff080269024a93))
+
+## [1.12.0](https://github.com/SethCohen/github-release-to-discord/compare/v1.11.1...v1.12.0) (2022-08-24)
+
+
+### Features
+
+* renamed all `colour`>`color` ([a0914f4](https://github.com/SethCohen/github-release-to-discord/commit/a0914f433a5c2a2626ca39637851235fd4f7adea))
+
+## [1.11.1](https://github.com/SethCohen/github-release-to-discord/compare/v1.11.0...v1.11.1) (2022-08-24)
+
+
+### Bug Fixes
+
+* fixed ReferenceError on require  vs import ([233db9c](https://github.com/SethCohen/github-release-to-discord/commit/233db9c33f9059cbe008e61acf7f321e671f352c))
+
 ## [1.11.0](https://github.com/SethCohen/github-release-to-discord/compare/v1.10.1...v1.11.0) (2022-08-24)
 
 

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 SethCohen
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,19 +1,35 @@
-# Github Release To Discord Action
+# GitHub Release To Discord Action
+A GitHub action that parses a GitHub release and posts it to a Discord channel as a stylized Discord webhook.
+
+---
+
+## 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)
+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)
+5. Save the secret.
+6. Add the secret to your action configuration.
+
+And you're done!
 
-This action parses a github release and posts it to a discord channel via a discord webhook.
 ## Configuration
-| Variable    | Required | Default                                                                                                   | Description                                 |
-|-------------|----------|----------------------------------------------------------------------------------------------------------------|---------------------------------------------|
+
+| 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.       |
+| 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.      |
 
 
 ## Output
-![output](https://i.imgur.com/fOIu7pC.png)
+![output](https://i.imgur.com/Zf3TXtb.png)
 
-## Example usage
+## Example Usage
 
 ```yaml
 on:
@@ -26,9 +42,11 @@ jobs:
     steps:
       - name: Checkout
         uses: actions/checkout@v3
-      - name: Handle Release
-        uses: ./ # Uses an action in the root directory
-        id: release
+      - name: Github Releases To Discord
+        uses: SethCohen/github-release-to-discord@v1.12.0
         with:
           webhook_url: ${{ secrets.WEBHOOK_URL }}
+          color: "2105893"
+          username: "Release Changelog"
+          avatar_url: "https://cdn.discordapp.com/avatars/487431320314576937/bd64361e4ba6313d561d54e78c9e7171.png"
 ```

action.yml

@@ -5,8 +5,8 @@ inputs:
   webhook_url:
     description: Discord's webhook url. Use GH repo secrets.
     required: true
-  colour:
-    description: Decimal colour value for embed.
+  color:
+    description: Decimal color value for embed.
     required: false
     default: '2105893'
   username:

index.js

@@ -1,6 +1,6 @@
-const core = require('@actions/core');
-const github = require('@actions/github');
-import fetch from 'node-fetch'
+import core from '@actions/core';
+import github from '@actions/github';
+import fetch from 'node-fetch';
 
 async function getContext () {
     const payload = github.context.payload
@@ -17,7 +17,7 @@ async function getContext () {
 async function run () {
     try {
         const webhookUrl = core.getInput('webhook_url')
-        const colour = core.getInput('colour')
+        const color = core.getInput('color')
         const username = core.getInput('username')
         const avatarUrl = core.getInput('avatar_url')
 
@@ -41,7 +41,7 @@ async function run () {
         const embedMsg = {
             title: `Release ${content.version}`,
             url: content.html_url,
-            color: colour,
+            color: color,
             description: description,
         }
 

package-lock.json

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

package.json

@@ -1,6 +1,6 @@
 {
   "name": "github-release-to-discord",
-  "version": "1.11.0",
+  "version": "1.12.1",
   "description": "Github Action that parses a release and sends it to a Discord channel",
   "type": "module",
   "main": "index.js",