Gladys Assistant website

This is the repository of https://gladysassistant.com.

This website is built with Docusaurus v2.

How to contribute?

Clone the repository

git clone https://github.com/GladysAssistant/v4-website
cd v4-website

Install the dependencies

yarn

Running the English website

npm start

Running the French website

npm run start -- --locale fr

How to refresh the development activity page?

The /dev/ page reads src/data/devActivity.json: a snapshot of the Gladys repository (weekly commits, releases, pull requests, contributors) and of the accepted feature requests on the forum.

Nothing to do by hand: build.sh regenerates it on every deploy, and the refresh-dev-activity workflow asks Cloudflare Pages for a daily rebuild so the page keeps moving even on quiet days. Whatever cannot be downloaded during a build (GitHub unreachable, rate limit reached, forum down) simply keeps the values committed in the repository, section by section, so a refresh never fails the deploy.

To regenerate it locally:

yarn load-dev-activity

About the GitHub rate limit

Without a token, GitHub allows 60 requests per hour and per IP. Cloudflare Pages builds run on shared IPs, so that budget is often already spent by someone else and the GitHub half of the snapshot stops refreshing (the build logs then show 403 rate limit exceeded). The script limits the damage by sending conditional requests: each answer is stored with its ETag and the 304 Not Modified replies do not count against the limit.

To refresh reliably, give the build a token and add it as a DEV_ACTIVITY_GITHUB_TOKEN environment variable on the Cloudflare Pages project (Settings > Environment variables). That raises the budget to 5000 requests per hour. Locally, the same variable in .env does the same.

Only public data is read, so the token needs no permission on anything:

• classic token: create it with no scope checked at all. A scopeless classic token reads public data, which is all this script does.
• fine-grained token: under Repository access, pick Public Repositories (read-only); nothing to tick under Repository or Account permissions. Give it an expiration date under a year: the GladysAssistant organization refuses fine-grained tokens living longer than 366 days, "no expiration" included, and answers 403 Forbidden on every call — the build log quotes that refusal in full. Such a token has to be rotated once a year; a classic token has no such limit.

The build log always opens with what it got, so a deploy that refreshes nothing says whether the token even reached it:

>> GitHub calls: DEV_ACTIVITY_GITHUB_TOKEN (fine-grained token, 93 characters)
>> GitHub calls: no token (DEV_ACTIVITY_GITHUB_TOKEN and GITHUB_TOKEN are unset): […]

The name is deliberately specific: GITHUB_TOKEN is read by a lot of tooling (and is the name GitHub Actions gives its own automatic token), so a variable set for this script alone should not be handed to everything else running in the build. GITHUB_TOKEN is still accepted as a fallback, which is what the workflows use when they pass secrets.GITHUB_TOKEN.

How to add new integrations ?

Don't add files into the integrations folder.

We use an AirTable spreadsheet to crowdsource the list of integrations.

Please contact us on the forum if you want write access to this spreadsheet.