update workflow and documentation for badges

ashkulz · ashkulz · commit bf3223ea9ceb · 2021-12-31T13:30:07.000+05:30
diff --git a/.github/workflows/deploy_badges.yml b/.github/workflows/deploy_badges.yml
@@ -1,15 +1,17 @@
 on:
   workflow_dispatch:
+  push:
+    branches: [ website ]
   schedule:
-    - cron: '0 * * * *'
+    - cron: 0 0 * * *
 
-name: update badges
+name: deploy updated script/data for badges
 jobs:
-  update_badges:
+  deploy_badges:
     runs-on: ubuntu-20.04
     steps:
       - uses: actions/checkout@v2
-      - name: update badges
+      - name: deploy updated script/data for badges
         env:
           CLOUDFLARE_API_TOKEN: ${{ secrets.CLOUDFLARE_API_TOKEN }}
           CLOUDFLARE_ACCOUNT_ID: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
diff --git a/badges/README.md b/badges/README.md
@@ -22,3 +22,21 @@ NOTE: two worker scripts are created (`user-badge`) and (`org-badge`) with diffe
 4. Configure each of the worker scripts [as described here](https://developers.cloudflare.com/workers/platform/routes#custom-routes):
     * Create an AAAA record for `100::` which is proxied by CloudFlare (orange-cloud)
     * Ensure that a route is added which maps to the worker, as no routes are added by default
+
+NOTE: I use [DNSControl](https://stackexchange.github.io/dnscontrol/) for managing DNS, and this is the configuration I use:
+
+```js
+var REGISTRAR  = NewRegistrar('none', 'NONE');
+var CLOUDFLARE = NewDnsProvider('cloudflare', 'CLOUDFLAREAPI', { manage_workers: true });
+
+D('committers.top', REGISTRAR, DnsProvider(CLOUDFLARE),
+  ALIAS('@',          'ashkulz.github.io.'),
+  CNAME('www',        'ashkulz.github.io.'),
+  AAAA ('user-badge', '100::', CF_PROXY_ON),
+  AAAA ('org-badge',  '100::', CF_PROXY_ON),
+
+  CF_WORKER_ROUTE("user-badge.committers.top/*", "user-badge"),
+  CF_WORKER_ROUTE("org-badge.committers.top/*", "org-badge")
+)
+
+```
