{"id":18517826,"url":"https://github.com/femtopixel/github-release-notifier","last_synced_at":"2025-04-09T08:31:07.830Z","repository":{"id":57434609,"uuid":"112608225","full_name":"femtopixel/github-release-notifier","owner":"femtopixel","description":"Automatize tasks when a specific package got a new release - Github Release Notifier","archived":false,"fork":false,"pushed_at":"2024-05-02T15:23:07.000Z","size":92,"stargazers_count":25,"open_issues_count":0,"forks_count":6,"subscribers_count":5,"default_branch":"master","last_synced_at":"2024-10-31T23:34:31.121Z","etag":null,"topics":["automatic","cli","github","notification","notification-api","notification-service","notifications","notifier","parser","release","webhook","webhooks"],"latest_commit_sha":null,"homepage":"https://brands.jaymoulin.me/femtopixel/github-release-notifier","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/femtopixel.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null},"funding":{"github":["jaymoulin"],"patreon":null,"open_collective":null,"ko_fi":"jaymoulin","tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"custom":["https://www.paypal.me/jaymoulin","https://www.buymeacoffee.com/jaymoulin","https://www.tipeeestream.com/cursedware/donation","https://streamlabs.com/cursedware/tip"]}},"created_at":"2017-11-30T12:21:38.000Z","updated_at":"2024-09-24T13:23:13.000Z","dependencies_parsed_at":"2023-01-31T00:31:04.935Z","dependency_job_id":null,"html_url":"https://github.com/femtopixel/github-release-notifier","commit_stats":null,"previous_names":[],"tags_count":21,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/femtopixel%2Fgithub-release-notifier","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/femtopixel%2Fgithub-release-notifier/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/femtopixel%2Fgithub-release-notifier/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/femtopixel%2Fgithub-release-notifier/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/femtopixel","download_url":"https://codeload.github.com/femtopixel/github-release-notifier/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":223381994,"owners_count":17136292,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["automatic","cli","github","notification","notification-api","notification-service","notifications","notifier","parser","release","webhook","webhooks"],"created_at":"2024-11-06T17:09:33.895Z","updated_at":"2024-11-06T17:09:34.406Z","avatar_url":"https://github.com/femtopixel.png","language":"Python","readme":".. image:: https://github.com/femtopixel/github-release-notifier/raw/master/logo.png\n\n=======================\nGithub Release Notifier\n=======================\n\n.. image:: https://img.shields.io/github/release/femtopixel/github-release-notifier.svg\n    :alt: latest release\n    :target: http://github.com/femtopixel/github-release-notifier/releases\n.. image:: https://img.shields.io/pypi/v/github-release-notifier.svg\n    :alt: latest release\n    :target: https://pypi.org/project/github-release-notifier/\n.. image:: https://img.shields.io/docker/pulls/femtopixel/github-release-notifier.svg\n    :alt: Docker pull\n    :target: https://hub.docker.com/r/femtopixel/github-release-notifier/\n.. image:: https://img.shields.io/docker/stars/femtopixel/github-release-notifier.svg\n    :alt: Docker stars\n    :target: https://hub.docker.com/r/femtopixel/github-release-notifier/\n.. image:: https://github.com/jaymoulin/jaymoulin.github.io/raw/master/ppl.png\n    :alt: PayPal donation\n    :target: https://www.paypal.me/jaymoulin\n.. image:: https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png\n    :alt: Buy me a coffee\n    :target: https://www.buymeacoffee.com/jaymoulin\n.. image:: https://ko-fi.com/img/githubbutton_sm.svg\n    :alt: Buy me a coffee\n    :target: https://ko-fi.com/jaymoulin\n\nDISCLAIMER: As-of 2021, this product does not have a free support team anymore. If you want this product to be maintained, please support.\n\n(This product is available under a free and permissive license, but needs financial support to sustain its continued improvements. In addition to maintenance and stability there are many desirable features yet to be added.)\n\nThis program will allow you to be notified of Github new releases\n\nInstallation\n------------\n\n.. code::\n\n    pip3 install github-release-notifier\n\nUsage\n-----\n\n.. code::\n\n    usage: github-release-notifier [-h] [--action {cron,subscribe,unsubscribe}] [--package PACKAGE]\n                  [--webhook WEBHOOK] [--uuid UUID]\n\n    optional arguments:\n      -h, --help            show this help message and exit\n      --action {cron,subscribe,unsubscribe}, -a {cron,subscribe,unsubscribe}\n                            Action to do (default: cron)\n      --package PACKAGE, -p PACKAGE\n                            Github package name / url (required for\n                            subscribe/unsubscribe) - prints uuid on subscription\n      --webhook WEBHOOK, -w WEBHOOK\n                            URL to your webhook (required for\n                            subscribe/unsubscribe)\n      --uuid UUID, -u UUID  UUID of your webhook (required for unsubscribe)\n\nExample\n~~~~~~~\n\nFirst, I register my webhook :\n\n.. code::\n\n    github-release-notifier --action subscribe --webhook https://example.com/updated --package jaymoulin/google-music-manager\n\nan UUID is printed. this UUID will be required to unsubscribe the webhook.\n\nWhen `jaymoulin/google-music-manager` releases a new version, `https://example.com/updated` will be called with HTTP method `POST` and body, a JSON like this :\n\n.. code::\n\n    {\n        \"date\": [2017, 11, 13, 19, 46, 35, 0, 317, 0],\n        \"version\": \"0.7.2\",\n        \"title\": \"Fixes split modules\",\n        \"content\": \"\",\n        \"media\": \"https://avatars0.githubusercontent.com/u/14236493?s=60\u0026v=4\",\n        \"author\": \"jaymoulin\"\n        \"package_name\": \"jaymoulin/google-music-manager\"\n    }\n\nFor this to happen, the system should check if a new version have been released.\nWe can do that by calling `github-release-notifier` without any parameter or setting `--action` to `cron` (which is default).\n\nTo automate this process, we could add this process in a cronjob:\n\n.. code::\n\n    (crontab -l ; echo \"0 0 * * * github-release-notifier\") | sort - | uniq - | crontab -\n\nThis will check every day at midnight if new versions have been released.\n\nConfiguration\n-------------\n\nEnvironment variables can be defined to change default `hooks` or `versions` database files (plain json file)\n\n.. code::\n\n    GRN_VERSIONS_FILE: Path to saved versions (default: ${HOME}/.github_release_notifier/versions)\n    GRN_HOOKS_FILE: Path to hooks configuration (default: ${HOME}/.github_release_notifier/hooks)\n\nDocker Usage\n------------\n\nFirst run the daemon\n\n.. code::\n\n    docker run --name GRN -d femtopixel/github-release-notifier\n\nyou can mount a volume to `/root/.github_release_notifier/` to keep tracks of webhooks and versions\n\nexample:\n\n.. code::\n\n    docker run --name GRN -d -v /path/to/your/saves:/root/.github_release_notifier/ femtopixel/github-release-notifier\n\nThen register your webhook :\n\n.. code::\n\n    docker exec GRN -a subscribe -p jaymoulin/google-music-manager -w https://example.com/updated\n\n\nSubmitting bugs and feature requests\n------------------------------------\n\nBugs and feature request are tracked on GitHub\n\nAuthor\n------\n\nJay MOULIN jaymoulin+github-release-notifier@gmail.com See also the list of contributors which participated in this program.\n\nLicense\n-------\n\nGithub Release Notifier is licensed under the MIT License\n","funding_links":["https://github.com/sponsors/jaymoulin","https://ko-fi.com/jaymoulin","https://www.paypal.me/jaymoulin","https://www.buymeacoffee.com/jaymoulin","https://www.tipeeestream.com/cursedware/donation","https://streamlabs.com/cursedware/tip"],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffemtopixel%2Fgithub-release-notifier","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffemtopixel%2Fgithub-release-notifier","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffemtopixel%2Fgithub-release-notifier/lists"}