https://github.com/eidam/cf-workers-github-releases

Get notified on Slack when a new version of your favorite repositories is released. Using Cloudflare Workers, CRON Triggers, and KV storage.
https://github.com/eidam/cf-workers-github-releases

cloudflare-workers cloudflare-workers-cron cloudflare-workers-kv github-releases releases slack wrangler

Last synced: 10 days ago
JSON representation

Get notified on Slack when a new version of your favorite repositories is released. Using Cloudflare Workers, CRON Triggers, and KV storage.

• Host: GitHub
• URL: https://github.com/eidam/cf-workers-github-releases
• Owner: eidam
• License: apache-2.0
• Created: 2020-10-31T01:06:18.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2020-11-09T16:41:15.000Z (about 4 years ago)
• Last Synced: 2025-01-15T21:19:47.979Z (15 days ago)
• Topics: cloudflare-workers, cloudflare-workers-cron, cloudflare-workers-kv, github-releases, releases, slack, wrangler
• Language: JavaScript
• Homepage:
• Size: 91.8 KB
• Stars: 4
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE_APACHE
  • Code of conduct: code_of_conduct.md

Awesome Lists containing this project

README

        
# Cloudflare Worker - GitHub repository releases

Get notified on Slack when a new version of your favorite repositories is released. Using **Cloudflare Workers**, **CRON Triggers,** and **KV storage**.

![slack-screenshot.png](.gitbook/assets/slack-screenshot.png)

## Pre-requisites

You'll need a [Cloudflare Workers account](https://dash.cloudflare.com/sign-up/workers) with

* A workers domain set up

* The Workers Bundled subscription \($5/mo\)

Also, prepare the following secrets

* Cloudflare API token with `Edit Cloudflare Workers` permissions

* GitHub API personal token

* Slack incoming webhook

## Getting started

You can either deploy with **Cloudflare Deploy Button** using GitHub Actions or deploy on your own.

### Deploy with Cloudflare Deploy Button

[![Deploy to Cloudflare Workers](https://deploy.workers.cloudflare.com/button?paid=true)](https://deploy.workers.cloudflare.com/?url=https://github.com/eidam/cf-workers-github-releases&paid=true)

1. Click the button and follow the instructions, you should end up with a clone of this repository

2. Navigate to your new **GitHub repository > Settings > Secrets** and add the following secrets:

   ```text

   - Name: CF_API_TOKEN (should be added automatically)

   

   - Name: CF_ACCOUNT_ID (should be added automatically)

   - Name: SECRET_SLACK_WEBHOOK_URL

   - Value: your-slack-webhook-url

   - Name: SECRET_GITHUB_TOKEN

   - Value: your-porsonal-read-github-token

   ```

3. Adjust [index.js](https://github.com/adam-janis/cf-workers-github-releases/tree/54f79a32c962967fd4523b7ba48415acef1f16c7/index.js) to list all of your repositories you want to watch

   ```javascript

   const githubRepositories = [

     'eidam/cf-workers-github-releases',

     'cloudflare/wrangler',

     'cloudflare/wrangler-action',

     '...',

   ]

   ```

4. Push to `main` branch to trigger the deployment

5. 🎉

### Deploy on your own

You can clone the repository yourself and use Wrangler CLI to develop/deploy, extra list of things you need to take care of:

* create KV namespace and add the `KV_GITHUB_RELEASES` binding to [wrangler.toml](https://github.com/adam-janis/cf-workers-github-releases/tree/54f79a32c962967fd4523b7ba48415acef1f16c7/wrangler.toml)

* create Worker secrets

  * `SECRET_SLACK_WEBHOOK_URL`

  * `SECRET_GITHUB_TOKEN`

## Known issues

* **Max 25 repositories to watch**, due to the limit of subrequests Cloudflare Worker can make \(50\).

  The plan is to support up to 49 by sending only one Slack notification per scheduled run.