commit 162f57b2ff113d142d1758e9ecdce82e74252a80 Author: Luke Tainton Date: Sun Mar 23 20:45:06 2025 +0000 Initial diff --git a/.gitea/workflows/conventional_commit.yml b/.gitea/workflows/conventional_commit.yml new file mode 100644 index 0000000..bb8caa7 --- /dev/null +++ b/.gitea/workflows/conventional_commit.yml @@ -0,0 +1,14 @@ +name: Conventional Commit +on: + pull_request: + types: + - opened + - edited + - synchronize + - reopened + +jobs: + validate_pr_title: + uses: https://git.tainton.uk/actions/gha-workflows/.gitea/workflows/conventional-commit.yml@main + with: + commit_message: ${{ gitea.event.pull_request.title }} diff --git a/.gitea/workflows/release.yml b/.gitea/workflows/release.yml new file mode 100644 index 0000000..a7dd43b --- /dev/null +++ b/.gitea/workflows/release.yml @@ -0,0 +1,20 @@ +name: Release +on: + workflow_dispatch: + push: + branches: + - main + +jobs: + create_release: + name: Create Release + uses: https://git.tainton.uk/actions/gha-workflows/.gitea/workflows/create-release.yml@main + secrets: + ACTIONS_TOKEN: ${{ secrets.ACTIONS_TOKEN }} + + print_release: + name: Print Release + runs-on: ubuntu-latest + needs: create_release + steps: + - run: echo "Created release ${{ needs.create_release.outputs.release_name }}." diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 0000000..2c4e06d --- /dev/null +++ b/Dockerfile @@ -0,0 +1,6 @@ +FROM python:3.11-slim +LABEL maintainer="Luke Tainton " +WORKDIR /home +COPY . . +RUN pip install requests +ENTRYPOINT ["python3", "/home/pushover.py"] diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..cde4ac6 --- /dev/null +++ b/LICENSE @@ -0,0 +1,10 @@ +This is free and unencumbered software released into the public domain. + +Anyone is free to copy, modify, publish, use, compile, sell, or distribute this software, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means. + +In jurisdictions that recognize copyright laws, the author or authors of this software dedicate any and all copyright interest in the software to the public domain. We make this dedication for the benefit of the public at large and to the detriment of our heirs and +successors. We intend this dedication to be an overt act of relinquishment in perpetuity of all present and future rights to this software under copyright law. + +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 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. + +For more information, please refer to diff --git a/README.md b/README.md new file mode 100644 index 0000000..9f0abdf --- /dev/null +++ b/README.md @@ -0,0 +1,38 @@ +# Pushover Action + +A [GitHub Action](https://github.com/features/actions) / [Gitea Action](https://docs.gitea.com/usage/actions/overview) to send a message via Pushover. + +You can use the Action as follows: + +```yaml +name: Build +on: + push: + branches: + - main +jobs: + build: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@master + - uses: https://git.tainton.uk/actions/pushover-action@v1.0.0 + env: + PUSHOVER_APP_TOKEN: xxx + PUSHOVER_USER_TOKEN: xxx + with: + message: ${{ github.event.head_commit.message }} +``` + +## Properties + +For more info on what a property means, see the Pushover API [documentation](https://pushover.net/api). + +| Property | Description | Required? | +| ----------- | --------------------------------------------- | --------- | +| `message` | Message to send | Yes | +| `title` | Message title | No | +| `device` | Registered device to send the message to | No | +| `priority` | Priority of the message | No | +| `sound` | Sound to use when delivering the notification | No | +| `url` | URL to present in the notification | No | +| `url_title` | Button name to use for the URL link | No | diff --git a/action.yml b/action.yml new file mode 100644 index 0000000..8c53186 --- /dev/null +++ b/action.yml @@ -0,0 +1,37 @@ +name: 'Pushover' +description: 'A GitHub/Gitea Action to send a message via Pushover.' +inputs: + message: + description: 'Message to send' + required: true + device: + description: 'Device to send message to' + required: false + priority: + description: 'Message priority' + required: false + default: '0' + sound: + description: 'Sound to play' + required: false + default: 'pushover' + title: + description: 'Message title' + required: false + url: + description: 'URL to include with message' + required: false + url_title: + description: 'Title for URL' + required: false +runs: + using: 'docker' + image: 'Dockerfile' + args: + - --message=${{ inputs.message }} + - --title=${{ inputs.title }} + - --url=${{ inputs.url }} + - --url_title=${{ inputs.url_title }} + - --device=${{ inputs.device }} + - --priority=${{ inputs.priority }} + - --sound=${{ inputs.sound }} diff --git a/pushover.py b/pushover.py new file mode 100755 index 0000000..88adccf --- /dev/null +++ b/pushover.py @@ -0,0 +1,65 @@ +import os +import argparse + +import requests + + +def get_args(): + parser = argparse.ArgumentParser() + parser.add_argument('--message', type=str, help='Message text') + parser.add_argument('--title', type=str, help='Message title') + parser.add_argument('--url', type=str, help='Supplementary URL to show with your message') + parser.add_argument('--url_title', type=str, help='title for your supplementary URL, otherwise just the URL is shown') + parser.add_argument('--device', type=str, help='Device name to send the message directly to') + parser.add_argument('--priority', type=str, help='Notification priority (low-to-high: -2 to 1)') + parser.add_argument('--sound', type=str, help='The name of a supported sound (https://pushover.net/api#sounds; custom sounds are supported)') + args = parser.parse_args() + return args + +def main(): + args = get_args() + + token = os.environ['PUSHOVER_APP_TOKEN'] + user = os.environ['PUSHOVER_USER_TOKEN'] + + msg: str = args.message + title: str | None = args.title if args.title else None + url: str | None = args.url if args.url else None + url_title: str | None = args.url_title if args.url_title else None + device: str | None = args.device if args.device else None + priority: str | None = args.priority if args.priority else None + sound: str | None = args.sound if args.sound else None + + if not msg: + print('No message provided') + return + + payload = { + 'token' : token, + 'user' : user, + 'message' : msg + } + if title: + payload['title'] = title + if url: + payload['url'] = url + if url_title: + payload['url_title'] = url_title + if device: + payload['device'] = device + if priority: + payload['priority'] = priority + if sound: + payload['sound'] = sound + + response = requests.post( + url='https://api.pushover.net/1/messages.json', + headers={'Content-Type': 'application/x-www-form-urlencoded'}, + data=payload, + timeout=60 + ) + response.raise_for_status() + print(response.text) + +if __name__ == '__main__': + main() diff --git a/renovate.json b/renovate.json new file mode 100644 index 0000000..c725323 --- /dev/null +++ b/renovate.json @@ -0,0 +1,20 @@ +{ + "assignAutomerge": true, + "assigneesFromCodeOwners": true, + "dependencyDashboardAutoclose": true, + "extends": ["config:recommended", "docker:enableMajor"], + "ignorePaths": ["**/.archive/**"], + "labels": ["type/dependencies"], + "platformCommit": "enabled", + "rebaseWhen": "behind-base-branch", + "rollbackPrs": true, + "vulnerabilityAlerts": { + "commitMessagePrefix": "[SECURITY] ", + "enabled": true, + "labels": ["security"], + "prCreation": "immediate" + }, + "lockFileMaintenance": { + "enabled": true + } +}