Skip to content

Commit

Permalink
Updated README.md, Changelogs and added test script.
Browse files Browse the repository at this point in the history
  • Loading branch information
CEKlopfenstein committed Jun 16, 2024
1 parent f9ec0fc commit d89ba6f
Show file tree
Hide file tree
Showing 5 changed files with 71 additions and 11 deletions.
31 changes: 30 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,4 +25,33 @@ An Initial Base Functionality Use/Proof of Concept. Fully functional in the simp
* ClientToken - Client that the plugin will listen to. (May belong to another user if desired.)
* ServerURL - Defaults to `http://localhost`. If you are deploying Gotify outside of docker or have HTTPS configured this may need to be modified. Should be the URL that accesses Gotify on the local machine it is running on.
* DiscordWebhook - The Discord Webhook that the messages are sent to.
* Displayer contains information on the Configurator values.
* Displayer contains information on the Configurator values.

## 2024.2.36
Improvements in automated build pipeline. Refactoring and Bugfixes. With a sprinkling of new features and functionality.

### General Improvements
- Modified method of setting version number. Now provided at compile time through ldflags
- Built and tested basic Release Generation Pipelines for both Prereleases and Proper releases.
- Discord Webhooks how hidden unless hovered over.
- Refactored internal package names for clarity.
- Version of the change log is now present within the Plugin Info Page.
- Limited to changes since last non prerelease. (Contents of MAJOR_CHANGELOG.md in repo)
- Updated README.md
- Removed certain planned features.

### Bug Fixes
- Added block to prevent spamming out transmittions that include blank titles and messages.
- Corrected reconnect protocal to function as expected.
- Broken connections will not be reestablished until 1 second after connection was lost.

### New Features
- Added ability to have transmit counts.
- Updated within the GUI once every 5 seconds currently.
- Logs for the plugin spesifically are now visible within the UI.
- Refreshes every 5 seconds
- Implemented New Relay Transmitters.
- Discord Advance
- Makes use of Embed elements in Discord messages.
- Currently provides limited benefit over normal Discord Transmitter.
- Pushbullet
23 changes: 17 additions & 6 deletions MAJOR_CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,25 @@
### Changes:
### General Improvements
- Modified method of setting version number. Now provided at compile time through ldflags
- Built and tested basic Release Generation Pipelines for both Prereleases and Proper releases.
- Added block to prevent spamming out transmittions that include blank titles and messages.
- Corrected reconnect protocal to function as expected.
- Broken connections will not be reestablished until 1 second after connection was lost.
- Discord Webhooks how hidden unless hovered over.
- Refactored internal package names for clarity.
- Version of the change log is now present within the Plugin Info Page.
- Limited to changes since last non prerelease. (Contents of MAJOR_CHANGELOG.md in repo)
- Discord Webhooks how hidden unless hovered over.
- Updated README.md
- Removed certain planned features.

### Bug Fixes
- Added block to prevent spamming out transmittions that include blank titles and messages.
- Corrected reconnect protocal to function as expected.
- Broken connections will not be reestablished until 1 second after connection was lost.

### New Features
- Added ability to have transmit counts.
- Updated within the GUI once every 5 seconds currently.
- Logs for the plugin spesifically are now visible within the UI.
- Refreshes every 5 seconds
- Refreshes every 5 seconds
- Implemented New Relay Transmitters.
- Discord Advance
- Makes use of Embed elements in Discord messages.
- Currently provides limited benefit over normal Discord Transmitter.
- Pushbullet
9 changes: 8 additions & 1 deletion PRE_CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,11 @@
- Added ability to have transmit counts.
- Updated within the GUI once every 5 seconds currently.
- Logs for the plugin spesifically are now visible within the UI.
- Refreshes every 5 seconds
- Refreshes every 5 seconds
- Implemented New Relay Transmitters.
- Discord Advance
- Makes use of Embed elements in Discord messages.
- Currently provides limited benefit over normal Discord Transmitter.
- Pushbullet
- Updated README.md
- Removed certain planned features.
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,17 +7,18 @@ A "simple" [Gotify](https://gotify.net/) plugin that allows for the relaying of
## Features
- Graphical User Interface
- Manage relay "transmitters"
- Supports Discord Webhooks as a "transmitter" endpoint.
- Supports mulitple "Transmitters"
- Discord
- Discord Advance (With Embeds)
- Pushbullet

## Motivation
I have a few things that support Gotify for notifications but not something else I use. That and I'd like a centralized places to direct all the notifications within my homelab. Is this the best method? Who knows. But let's have fun doing it.

## Currently Planned Features
- Advance Discord Webhook integration
- More "Transmitter" Options
- Secondary Gotify Instance
- Telegram
- Pushbullet
- Discord bot? (Extremely unlikely)
- Forwarding Filters

Expand Down
12 changes: 12 additions & 0 deletions dev-utils/test-message.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
#!/bin/bash
while true
do
curl "http://localhost:8080/message?token=$1" -F "title=Test Message" -F "message=Repeating Test Message"
echo
if [ $? -ne 0 ]
then
break
fi
sleep 10
done

0 comments on commit d89ba6f

Please sign in to comment.