Compare commits
No files matched your search
@@ -0,0 +1,103 @@
|
||||
name: ♿ Accessibility barrier
|
||||
description: Something on the website or in the apps doesn't work with your keyboard, screen reader, zoom, contrast settings or other assistive technology
|
||||
title: "[Accessibility] "
|
||||
labels: ["accessibility"]
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
Thank you for taking the time to report this. Every report helps, even a partial one — describe what happened in your own words, and skip whatever you'd rather not share. Please don't include health information.
|
||||
|
||||
Prefer email, or don't have a GitHub account? Write to **contact@poli0981.dev** (English or Vietnamese). What happens next, and the response targets, are in [ACCESSIBILITY.md](https://github.com/poli0981/free-games-itchio-list/blob/main/ACCESSIBILITY.md#7-reporting-an-accessibility-barrier).
|
||||
|
||||
**Found a security vulnerability?** Please don't file it here: report it privately (see SECURITY.md).
|
||||
|
||||
- type: dropdown
|
||||
id: where
|
||||
attributes:
|
||||
label: Where did it happen?
|
||||
description: Pick all that apply.
|
||||
multiple: true
|
||||
options:
|
||||
- Website (freeitchgames.win)
|
||||
- Desktop app — Windows
|
||||
- Desktop app — macOS
|
||||
- Desktop app — Linux
|
||||
- Android app
|
||||
- Not sure
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: input
|
||||
id: page
|
||||
attributes:
|
||||
label: Page or screen
|
||||
description: The address of the page, or the screen in the app.
|
||||
placeholder: e.g. https://freeitchgames.win/charts, or "the Games list in the Android app"
|
||||
|
||||
- type: textarea
|
||||
id: details
|
||||
attributes:
|
||||
label: What were you trying to do, and what happened?
|
||||
description: What you expected, what happened instead, and the steps to get there if you can.
|
||||
placeholder: |
|
||||
e.g. I pressed Tab to reach the "Platform" filter, but focus jumped back to the top of the page.
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: dropdown
|
||||
id: kind
|
||||
attributes:
|
||||
label: What kind of barrier? (optional)
|
||||
multiple: true
|
||||
options:
|
||||
- Keyboard (can't reach or use something, focus lost or hidden)
|
||||
- Screen reader (missing or wrong name, nothing announced, wrong reading order)
|
||||
- Zoom, text size or layout at large sizes
|
||||
- Colour or contrast (including Windows contrast themes)
|
||||
- Motion or animation
|
||||
- Charts
|
||||
- Language (read in the wrong language or voice)
|
||||
- Speech input or switch access
|
||||
- Something else
|
||||
|
||||
- type: dropdown
|
||||
id: severity
|
||||
attributes:
|
||||
label: How much does it get in your way?
|
||||
description: Just your best guess; it may change during triage.
|
||||
options:
|
||||
- Critical — I can't do a main task at all (find, open or read a game, change settings)
|
||||
- Serious — I can, but only with great effort or a workaround
|
||||
- Moderate — annoying or inconsistent, but I get there
|
||||
- Minor — a small polish issue
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: input
|
||||
id: assistive-tech
|
||||
attributes:
|
||||
label: Assistive technology and version (if any)
|
||||
placeholder: e.g. Windows Narrator, NVDA 2026.1, VoiceOver on iOS 26, TalkBack, keyboard only, Windows contrast theme
|
||||
|
||||
- type: input
|
||||
id: environment
|
||||
attributes:
|
||||
label: Device, operating system, browser or app version
|
||||
description: The app version is shown on the About page.
|
||||
placeholder: e.g. Windows 11 + Edge 142; Android 15 + app 4.6.0
|
||||
|
||||
- type: textarea
|
||||
id: media
|
||||
attributes:
|
||||
label: Screenshot or recording (optional)
|
||||
description: Paste or drag files here. Please hide any personal information.
|
||||
|
||||
- type: checkboxes
|
||||
id: conduct
|
||||
attributes:
|
||||
label: Code of Conduct
|
||||
description: By submitting this issue you agree to follow the project's [Code of Conduct](https://github.com/poli0981/free-games-itchio-list/blob/main/CODE_OF_CONDUCT.md).
|
||||
options:
|
||||
- label: I agree to follow the Code of Conduct.
|
||||
required: true
|
||||
@@ -8,6 +8,8 @@ body:
|
||||
value: |
|
||||
Thanks bro! This catalog lives on additions because I'm too lazy to hunt alone :D Only free-to-play itch.io games.
|
||||
|
||||
The game must be playable or downloadable **on its itch.io page itself** (a browser build or an uploaded file). A page that only points to a launcher or a download on another site doesn't qualify.
|
||||
|
||||
**Just one game? Use the Suggest page instead: https://freeitchgames.win/suggest** — no GitHub account needed, and it goes straight into the review queue.
|
||||
This issue form is the fallback for **bulk lists** (several games at once).
|
||||
|
||||
@@ -56,6 +58,7 @@ body:
|
||||
options:
|
||||
- label: I searched https://freeitchgames.win/games and these games aren't listed yet
|
||||
- label: These games are free to play on itch.io (not paid)
|
||||
- label: Each page has its own browser build or download on itch.io (not only a link to another site)
|
||||
|
||||
- type: checkboxes
|
||||
id: agreement
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
name: 🐛 Bug Report
|
||||
description: Report a bug on the website, in the desktop/Android app, in the game data, or in the scripts
|
||||
name: 🛠️ Report a problem (wrong data, something broke)
|
||||
description: Wrong or outdated game data, a dead link, or something that stopped working on the website or in the apps. Not for feature requests.
|
||||
title: "[Bug] "
|
||||
labels: ["bug"]
|
||||
body:
|
||||
@@ -8,8 +8,11 @@ body:
|
||||
value: |
|
||||
Thanks for reporting! I'm a lazy unemployed dev, so bugs happen a lot :D My AI buddies fix most, but your help is gold.
|
||||
|
||||
**The project is in maintenance mode** (stable, no new features): this form is for wrong game data and for things that broke. Ideas and feature requests are closed without review.
|
||||
|
||||
**Found a security vulnerability?** Please don't file it here — report it privately via https://github.com/poli0981/free-games-itchio-list/security/advisories/new or security@poli0981.dev.
|
||||
Want a game removed (or you're its creator)? Use the "Remove a Game" template instead.
|
||||
Something doesn't work with your keyboard, screen reader, zoom or contrast settings? The "Accessibility barrier" template asks the right questions.
|
||||
|
||||
- type: dropdown
|
||||
id: where
|
||||
|
||||
@@ -6,3 +6,9 @@ contact_links:
|
||||
- name: 🔒 Report a security vulnerability (private)
|
||||
url: https://github.com/poli0981/free-games-itchio-list/security/advisories/new
|
||||
about: Please report vulnerabilities privately here (or email security@poli0981.dev), never in a public issue.
|
||||
- name: 💬 Questions, feedback, anything else
|
||||
url: https://github.com/poli0981/free-games-itchio-list/discussions
|
||||
about: Issues are for the catalog data only (add, fix or remove a game). Everything else goes to Discussions.
|
||||
- name: 🧊 Feature requests are closed
|
||||
url: https://github.com/poli0981/free-games-itchio-list#project-status
|
||||
about: The project is stable and in maintenance mode — security fixes and dependency updates only. Feature requests and code pull requests are closed without review.
|
||||
@@ -1,62 +0,0 @@
|
||||
name: 💡 Feature Request / Improvement
|
||||
description: Suggest a new feature or code improvement
|
||||
title: "[Feature/Improvement] "
|
||||
labels: ["enhancement"]
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
Yo legend! My code is mediocre at best, so ideas are welcome. Grok helps, but you might have better ones :D
|
||||
|
||||
- type: checkboxes
|
||||
id: type
|
||||
attributes:
|
||||
label: Type (choose one only)
|
||||
options:
|
||||
- label: New Feature
|
||||
- label: Code Improvement
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: input
|
||||
id: title
|
||||
attributes:
|
||||
label: Feature/Improvement Name
|
||||
description: Short title — what is it?
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: reason
|
||||
attributes:
|
||||
label: Why? (e.g tables too slow, missing info, etc.)
|
||||
description: Explain the problem it solves or why it's cool/good for the repo.
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: checkboxes
|
||||
id: priority
|
||||
attributes:
|
||||
label: How necessary? (choose one only)
|
||||
options:
|
||||
- label: Not urgent (nice to have)
|
||||
- label: Maybe needed
|
||||
- label: Very needed
|
||||
- label: Extremely urgent (repo dying without it)
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: code
|
||||
attributes:
|
||||
label: (Optional) Pseudo-code, snippet, or file idea
|
||||
description: |
|
||||
Share code ideas — I'll check (no malware pls, I'm paranoid and lazy :D). My skill is average, so keep it simple.
|
||||
|
||||
- type: checkboxes
|
||||
id: agreement
|
||||
attributes:
|
||||
label: Agreement (required)
|
||||
options:
|
||||
- label: I agree — if this issue is off-topic, spam, or violates repo policy, it may be ignored/closed without response.
|
||||
required: true
|
||||
@@ -1,36 +0,0 @@
|
||||
name: 💬 Feedback
|
||||
description: General feedback about the repo/docs
|
||||
title: "[Feedback] "
|
||||
labels: ["feedback"]
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
Roast me, praise me, or complain — I'm introvert but I'll read :D
|
||||
|
||||
- type: checkboxes
|
||||
id: reasons
|
||||
attributes:
|
||||
label: What's the feedback about? (can check multiple)
|
||||
options:
|
||||
- label: EULA/ToS too strict/annoying
|
||||
- label: Repo concept wrong/bad
|
||||
- label: Anti-AI vibes (but Grok built half of it :v)
|
||||
- label: Delete the repo pls
|
||||
- label: Other (describe below)
|
||||
|
||||
- type: textarea
|
||||
id: details
|
||||
attributes:
|
||||
label: Full feedback/details
|
||||
description: Be honest — my self-loathing can handle it
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: checkboxes
|
||||
id: agreement
|
||||
attributes:
|
||||
label: Agreement (required)
|
||||
options:
|
||||
- label: I agree — if this issue is off-topic, spam, or violates repo policy, it may be ignored/closed without response.
|
||||
required: true
|
||||
@@ -1,25 +0,0 @@
|
||||
name: ❓ General / Off-Topic
|
||||
description: Anything not fitting other templates
|
||||
title: "[General] "
|
||||
labels: ["question"]
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
Not bug/feature/games/feedback? Drop it here. Memes welcome :D
|
||||
|
||||
- type: textarea
|
||||
id: content
|
||||
attributes:
|
||||
label: What's on your mind?
|
||||
description: Questions, random thoughts, or just saying hi
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: checkboxes
|
||||
id: agreement
|
||||
attributes:
|
||||
label: Agreement (required)
|
||||
options:
|
||||
- label: I agree — if this issue is off-topic, spam, or violates repo policy, it may be ignored/closed without response.
|
||||
required: true
|
||||
@@ -1,7 +1,7 @@
|
||||
name: 🚫 Remove a Game (or copyright request)
|
||||
description: Ask to remove games from the catalog or correct their data, including requests from creators and rights holders (max 10 per issue)
|
||||
title: "[Remove Games] "
|
||||
labels: ["removal"]
|
||||
labels: ["delete-game"]
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
|
||||
@@ -12,6 +12,7 @@ Optional: short notes, why they rock, NSFW/safety concerns (the Maintainer sets
|
||||
|
||||
### Checklist
|
||||
- [ ] All links are free itch.io game pages
|
||||
- [ ] Each page has its own browser build or download on itch.io (not only a link to another site)
|
||||
- [ ] No duplicates (searched https://freeitchgames.win/games)
|
||||
- [ ] Only `scripts/temp_link.json` changed, and it's still valid JSON
|
||||
- [ ] I agree my contribution is licensed under CC BY 4.0, like the rest of the catalog data (`data_game/LICENSE.md`)
|
||||
|
||||
@@ -1,27 +0,0 @@
|
||||
**🐛 Bug Fix**
|
||||
|
||||
Thanks for fixing my mediocre code! I'm just an unemployed noob dev, so bugs are my specialty :D
|
||||
|
||||
### What bug did you fix?
|
||||
- [ ] Wrong game info or NSFW/safety flag (usually easier as a Bug Report issue — please don't hand-edit `data_game/`, the pipeline writes it)
|
||||
- [ ] Scraping failure (itch.io changed HTML again)
|
||||
- [ ] Data pipeline / GitHub Actions fail
|
||||
- [ ] Website bug (`webapp/src/`)
|
||||
- [ ] Worker bug (`webapp/worker/` — image proxy, Suggest API, admin API)
|
||||
- [ ] Desktop/Android app (Tauri) bug
|
||||
- [ ] Other (describe below)
|
||||
|
||||
### Description
|
||||
Explain the bug and how your fix works. Bonus points if you tested locally!
|
||||
|
||||
### Related Issues
|
||||
Closes # (link issue number if any)
|
||||
|
||||
### Checklist
|
||||
- [ ] Tested locally — Python: `pytest`, `ruff check scripts tests webapp/scripts`, `python scripts/validate.py`; webapp: `npm test`, `npm run lint`, `npx tsc -b`
|
||||
- [ ] No new bugs introduced (hopefully)
|
||||
- [ ] No secrets, tokens or personal data in the diff
|
||||
- [ ] I agree my contribution is licensed under the MIT License (see `LICENSE`)
|
||||
- [ ] Followed the vibe (chill, no drama)
|
||||
|
||||
Grok approved? (just kidding, but thanks legend!) 🚀
|
||||
@@ -1,26 +0,0 @@
|
||||
**📝 Documentation Update / Other**
|
||||
|
||||
Not code or games? Fix my bad English, typos, or update legal docs — still super helpful!
|
||||
|
||||
### What did you update?
|
||||
- [ ] Fix typo/grammar in README/docs
|
||||
- [ ] Update DISCLAIMER/PRIVACY/TERMS/EULA/SECURITY/etc.
|
||||
- [ ] Update the Vietnamese mirror (`README.vi.md`, `docs/i18n/vi/`)
|
||||
- [ ] Improve MY_STUFF or ACKNOWLEDGEMENTS
|
||||
- [ ] Add badges/screenshots
|
||||
- [ ] Other small polish
|
||||
|
||||
### Description
|
||||
Explain changes and why.
|
||||
|
||||
### Related Issues
|
||||
References # (if any)
|
||||
|
||||
### Checklist
|
||||
- [ ] No breaking changes
|
||||
- [ ] Relative links still resolve; website links use `https://freeitchgames.win/<path>`
|
||||
- [ ] If I changed an English doc that has a Vietnamese mirror, I updated the mirror too (or said so above so someone else can)
|
||||
- [ ] I agree my contribution is licensed under CC BY 4.0, like the rest of the documentation
|
||||
- [ ] Keeps the self-deprecating vibe :D
|
||||
|
||||
Even small fixes make this repo look less noob — thanks bro! 🚀
|
||||
@@ -1,30 +0,0 @@
|
||||
**💡 New Feature / Code Improvement**
|
||||
|
||||
Yo legend! My code is "kinda works" level, so any upgrade is huge. Grok helps me, but real humans are better :D
|
||||
|
||||
Heads-up: the website and apps are read-only for visitors on purpose — no accounts, no ads, no profiling, no telemetry in the apps. Features that would add those (or new cookies, or a new third-party service) need a chat in an issue first, since the Privacy Policy would have to change.
|
||||
|
||||
### What feature/improvement?
|
||||
- [ ] Better scraping (more info, rating, etc.)
|
||||
- [ ] Website/app UI (new page, filter, chart, better mobile layout)
|
||||
- [ ] Desktop/Android app (Tauri)
|
||||
- [ ] Automation (pipeline, GitHub Actions)
|
||||
- [ ] Performance fix (faster pages, faster Actions)
|
||||
- [ ] Refactor my messy code
|
||||
- [ ] Other (describe)
|
||||
|
||||
### Description
|
||||
Explain what it does and why it's cool. Include code snippets if needed.
|
||||
|
||||
### Related Issues
|
||||
References # (link if any)
|
||||
|
||||
### Checklist
|
||||
- [ ] Tested locally (Python: `pytest`, `ruff check scripts tests webapp/scripts`; webapp: `npm test`, `npm run lint`, `npm run knip`, `npx tsc -b`)
|
||||
- [ ] Doesn't break the daily refresh or the ingest workflow
|
||||
- [ ] New npm dependency? Added it to `webapp/src/lib/about.ts` so the About page lists it
|
||||
- [ ] Edited `webapp/wrangler.jsonc`? Ran `npm run cf:types`
|
||||
- [ ] I agree my contribution is licensed under the MIT License (see `LICENSE`)
|
||||
- [ ] Keeps the noob vibe intact
|
||||
|
||||
If this makes the repo less mediocre — you're the MVP. 🚀
|
||||
+17
-7
@@ -1,5 +1,5 @@
|
||||
# Dependabot version updates. Security updates are enabled separately in
|
||||
# Settings → Code security (they are not limited by open-pull-requests-limit).
|
||||
# Dependabot version updates. Security updates are a separate switch in
|
||||
# Settings → Code security (when on, they are not limited by open-pull-requests-limit).
|
||||
version: 2
|
||||
updates:
|
||||
- package-ecosystem: npm
|
||||
@@ -21,11 +21,15 @@ updates:
|
||||
patterns: ['@radix-ui/*', 'radix-ui']
|
||||
tauri-js:
|
||||
patterns: ['@tauri-apps/*']
|
||||
# @vitest/coverage-v8 requires the exact vitest version (peer dependency).
|
||||
vitest:
|
||||
patterns: ['vitest', '@vitest/*']
|
||||
build-tooling:
|
||||
patterns:
|
||||
- 'vite'
|
||||
- '@vitejs/*'
|
||||
- 'typescript'
|
||||
- '@typescript/*'
|
||||
- 'typescript-eslint'
|
||||
- 'eslint*'
|
||||
- '@eslint/*'
|
||||
@@ -36,12 +40,14 @@ updates:
|
||||
- 'wrangler'
|
||||
- '@cloudflare/*'
|
||||
ignore:
|
||||
# typescript-eslint supports TypeScript < 6.1 only.
|
||||
# `typescript` is an alias of @typescript/typescript6 (the 6.0 API):
|
||||
# typescript-eslint supports TypeScript < 6.1 only. TypeScript 7 itself
|
||||
# is `@typescript/native`. Never move the alias to a new major.
|
||||
- dependency-name: 'typescript'
|
||||
versions: ['>=6.1']
|
||||
# Match the Node 24 runtime.
|
||||
update-types: ['version-update:semver-major']
|
||||
# Match the Node 26 runtime.
|
||||
- dependency-name: '@types/node'
|
||||
versions: ['>=25']
|
||||
versions: ['>=27']
|
||||
|
||||
- package-ecosystem: pip
|
||||
directory: /
|
||||
@@ -63,10 +69,14 @@ updates:
|
||||
actions:
|
||||
patterns: ['*']
|
||||
|
||||
# Weekly on Mondays like npm, so tauri-rs and tauri-js bumps land together:
|
||||
# `tauri build` (release workflows only) refuses crate / npm versions on a
|
||||
# different major.minor; Webapp CI's check:tauri step catches a one-sided bump.
|
||||
- package-ecosystem: cargo
|
||||
directory: /webapp/src-tauri
|
||||
schedule:
|
||||
interval: monthly
|
||||
interval: weekly
|
||||
day: monday
|
||||
groups:
|
||||
tauri-rs:
|
||||
patterns: ['tauri*']
|
||||
|
||||
@@ -0,0 +1,31 @@
|
||||
<!--
|
||||
The project is in maintenance mode (stable, no new features — see README → Project status).
|
||||
Pull requests from contributors are accepted for ONE thing: adding itch.io URLs to
|
||||
scripts/temp_link.json. For that, add ?template=add_games.md to this page's address.
|
||||
Code, UI and docs pull requests are closed without review; a game's data is fixed or removed
|
||||
through an issue or email (CONTRIBUTING.md). This template is the Maintainer's own checklist.
|
||||
-->
|
||||
|
||||
### What and why
|
||||
|
||||
What does this change, and why?
|
||||
|
||||
### Related issues
|
||||
|
||||
Closes # (if any)
|
||||
|
||||
### Checklist
|
||||
|
||||
- [ ] Tested locally — Python: `pytest`, `ruff check scripts tests webapp/scripts`; webapp: `npm test`, `npm run lint`, `npm run knip`, `npx tsc -b`
|
||||
- [ ] No secrets, tokens or personal data in the diff
|
||||
- [ ] New UI text is in both `webapp/src/lib/i18n/en.ts` and `vi.ts`; a changed English doc has its Vietnamese mirror updated (or I said so above)
|
||||
- [ ] I agree my contribution is licensed like the part it changes: MIT for code, CC BY 4.0 for data and docs
|
||||
|
||||
### Accessibility (UI or docs changes — see [ACCESSIBILITY.md](https://github.com/poli0981/free-games-itchio-list/blob/main/ACCESSIBILITY.md#8-for-contributors))
|
||||
|
||||
- [ ] N/A — no UI or docs change
|
||||
- [ ] Works with the keyboard alone: everything reachable, focus visible and never lost
|
||||
- [ ] Every control has a name; nothing relies on colour alone; `npm test` (contrast check) passes
|
||||
- [ ] Respects reduced motion; no new auto-playing motion
|
||||
- [ ] Checked once with a screen reader (Narrator, NVDA, VoiceOver or TalkBack)
|
||||
- [ ] Docs: headings in order, descriptive link text, alt text for images
|
||||
@@ -0,0 +1 @@
|
||||
3.15
|
||||
@@ -1,5 +1,5 @@
|
||||
# Lint + tests for the data pipeline, and schema validation of the catalog.
|
||||
# Pushes by GitHub Apps (browser extension, admin Worker) also trigger this,
|
||||
# Pushes by the admin Worker's GitHub App also trigger this,
|
||||
# so every externally written data change is validated.
|
||||
name: Python CI
|
||||
|
||||
@@ -10,8 +10,9 @@ on:
|
||||
- 'tests/**'
|
||||
- 'data_game/**'
|
||||
- 'requirements*.txt'
|
||||
- 'requirements*.in'
|
||||
- 'pyproject.toml'
|
||||
- '.python-version'
|
||||
- '.github/python-version'
|
||||
- '.github/workflows/python-ci.yml'
|
||||
push:
|
||||
branches: [main]
|
||||
@@ -20,8 +21,9 @@ on:
|
||||
- 'tests/**'
|
||||
- 'data_game/**'
|
||||
- 'requirements*.txt'
|
||||
- 'requirements*.in'
|
||||
- 'pyproject.toml'
|
||||
- '.python-version'
|
||||
- '.github/python-version'
|
||||
- '.github/workflows/python-ci.yml'
|
||||
|
||||
permissions: {}
|
||||
@@ -30,9 +32,6 @@ concurrency:
|
||||
group: python-ci-${{ github.ref }}
|
||||
cancel-in-progress: true
|
||||
|
||||
env:
|
||||
PYTHONUTF8: '1'
|
||||
|
||||
jobs:
|
||||
test:
|
||||
runs-on: ubuntu-latest
|
||||
@@ -46,14 +45,21 @@ jobs:
|
||||
persist-credentials: false
|
||||
|
||||
- name: Set up Python
|
||||
uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
|
||||
uses: actions/setup-python@6d4fd22b20465ccc0f7354476588e8df7c9ca0e0 # v7.1.0
|
||||
with:
|
||||
python-version-file: .python-version
|
||||
# Not .python-version: Dependabot's pip updater reads that file and
|
||||
# supports Python <= 3.14 only (CLAUDE.md gotcha 39).
|
||||
python-version-file: .github/python-version
|
||||
cache: pip
|
||||
cache-dependency-path: requirements-dev.txt
|
||||
cache-dependency-path: |
|
||||
requirements.txt
|
||||
requirements-dev.txt
|
||||
|
||||
# Both hash-locked files at once: pip fails if their pins disagree.
|
||||
# Wheels only, so no package runs a build script here.
|
||||
- name: Install dependencies
|
||||
run: pip install -r requirements-dev.txt
|
||||
run: |
|
||||
pip install --require-hashes --only-binary :all: -r requirements.txt -r requirements-dev.txt
|
||||
|
||||
- name: Ruff
|
||||
run: |
|
||||
|
||||
@@ -0,0 +1,195 @@
|
||||
# Qodana (JetBrains) static analysis, one linter per Qodana Cloud project:
|
||||
#
|
||||
# typescript — qodana-js webapp/ https://qodana.cloud/projects/wwgZ1
|
||||
# python — qodana-python the repository root https://qodana.cloud/projects/GgGnX
|
||||
# rust — qodana-rust webapp/src-tauri/ https://qodana.cloud/projects/P2Rd7
|
||||
#
|
||||
# Each project has its own token (a repository secret) and its own settings
|
||||
# file (`qodana.yaml` in the directory above). Every run analyses the whole
|
||||
# project (`pr-mode: false`), so a pull request and `main` report the same way.
|
||||
#
|
||||
# Dependabot and fork PRs get no repository secrets: the analysis is skipped
|
||||
# there, not failed (the `tokens` job). Dependencies are installed before the
|
||||
# scan, in steps that don't see the token.
|
||||
name: Qodana
|
||||
|
||||
on:
|
||||
push:
|
||||
branches: [main]
|
||||
# Data commits (the pipeline's, the admin Worker's) and docs change no code.
|
||||
paths-ignore:
|
||||
- 'data_game/**'
|
||||
- 'scripts/temp_link.json'
|
||||
- 'scripts/deleted_games.json'
|
||||
- 'scripts/state/**'
|
||||
- '**.md'
|
||||
pull_request:
|
||||
paths-ignore:
|
||||
- 'data_game/**'
|
||||
- 'scripts/temp_link.json'
|
||||
- 'scripts/deleted_games.json'
|
||||
- 'scripts/state/**'
|
||||
- '**.md'
|
||||
workflow_dispatch:
|
||||
|
||||
permissions: {}
|
||||
|
||||
concurrency:
|
||||
group: qodana-${{ github.ref }}
|
||||
cancel-in-progress: true
|
||||
|
||||
jobs:
|
||||
tokens:
|
||||
runs-on: ubuntu-latest
|
||||
timeout-minutes: 5
|
||||
permissions: {}
|
||||
outputs:
|
||||
present: ${{ steps.check.outputs.present }}
|
||||
steps:
|
||||
- name: Check for the Qodana tokens
|
||||
id: check
|
||||
env:
|
||||
TOKEN_TS_JS: ${{ secrets.QODANA_TOKEN_TS_JS }}
|
||||
TOKEN_PYTHON: ${{ secrets.QODANA_TOKEN_PYTHON }}
|
||||
TOKEN_RUST: ${{ secrets.QODANA_TOKEN_RUST }}
|
||||
run: |
|
||||
if [ -n "$TOKEN_TS_JS" ] && [ -n "$TOKEN_PYTHON" ] && [ -n "$TOKEN_RUST" ]; then
|
||||
echo "present=true" >> "$GITHUB_OUTPUT"
|
||||
else
|
||||
echo "::notice::No Qodana tokens in this run (Dependabot or fork PR): Qodana analysis skipped."
|
||||
fi
|
||||
|
||||
typescript:
|
||||
name: TypeScript / JavaScript
|
||||
needs: tokens
|
||||
if: needs.tokens.outputs.present == 'true'
|
||||
runs-on: ubuntu-latest
|
||||
timeout-minutes: 30
|
||||
permissions:
|
||||
contents: read
|
||||
checks: write # the action's annotations
|
||||
steps:
|
||||
- name: Checkout repository
|
||||
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
|
||||
with:
|
||||
ref: ${{ github.event.pull_request.head.sha || github.sha }}
|
||||
fetch-depth: 0
|
||||
persist-credentials: false
|
||||
|
||||
- name: Set up Node.js
|
||||
uses: actions/setup-node@949feb2413d6458794dcd2491c4babbbce0c15c1 # v7.1.0
|
||||
with:
|
||||
node-version-file: webapp/.node-version
|
||||
cache: npm
|
||||
cache-dependency-path: webapp/package-lock.json
|
||||
|
||||
# The linter resolves imports and types from node_modules.
|
||||
- name: Install npm dependencies
|
||||
working-directory: webapp
|
||||
run: npm ci --ignore-scripts
|
||||
|
||||
- name: Qodana scan
|
||||
uses: JetBrains/qodana-action@3e8d76ff0e0241618abd808682f426afe84bab3f # v2026.2.2
|
||||
with:
|
||||
args: --project-dir webapp --repository-root . --linter qodana-js --within-docker false
|
||||
pr-mode: false
|
||||
post-pr-comment: false
|
||||
upload-result: true
|
||||
artifact-name: qodana-report-typescript
|
||||
primary-cache-key: qodana-2026.2-js-${{ github.ref }}-${{ github.sha }}
|
||||
additional-cache-key: qodana-2026.2-js-${{ github.ref }}
|
||||
cache-default-branch-only: true
|
||||
env:
|
||||
QODANA_TOKEN: ${{ secrets.QODANA_TOKEN_TS_JS }}
|
||||
|
||||
python:
|
||||
name: Python
|
||||
needs: tokens
|
||||
if: needs.tokens.outputs.present == 'true'
|
||||
runs-on: ubuntu-latest
|
||||
timeout-minutes: 30
|
||||
permissions:
|
||||
contents: read
|
||||
checks: write
|
||||
steps:
|
||||
- name: Checkout repository
|
||||
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
|
||||
with:
|
||||
ref: ${{ github.event.pull_request.head.sha || github.sha }}
|
||||
fetch-depth: 0
|
||||
persist-credentials: false
|
||||
|
||||
- name: Set up Python
|
||||
uses: actions/setup-python@6d4fd22b20465ccc0f7354476588e8df7c9ca0e0 # v7.1.0
|
||||
with:
|
||||
python-version-file: .github/python-version
|
||||
cache: pip
|
||||
cache-dependency-path: |
|
||||
requirements.txt
|
||||
requirements-dev.txt
|
||||
|
||||
# Hash-locked, wheels only (CLAUDE.md, gotcha 40). In native mode the
|
||||
# linter finds no interpreter by itself: it gets this virtual environment
|
||||
# (QODANA_PYTHON_PATH below) and resolves imports from it.
|
||||
- name: Install Python dependencies
|
||||
run: |
|
||||
python -m venv .venv
|
||||
.venv/bin/pip install --require-hashes --only-binary :all: -r requirements.txt -r requirements-dev.txt
|
||||
|
||||
- name: Qodana scan
|
||||
uses: JetBrains/qodana-action@3e8d76ff0e0241618abd808682f426afe84bab3f # v2026.2.2
|
||||
with:
|
||||
args: --linter qodana-python --within-docker false
|
||||
pr-mode: false
|
||||
post-pr-comment: false
|
||||
upload-result: true
|
||||
artifact-name: qodana-report-python
|
||||
primary-cache-key: qodana-2026.2-python-${{ github.ref }}-${{ github.sha }}
|
||||
additional-cache-key: qodana-2026.2-python-${{ github.ref }}
|
||||
cache-default-branch-only: true
|
||||
env:
|
||||
QODANA_TOKEN: ${{ secrets.QODANA_TOKEN_PYTHON }}
|
||||
QODANA_PYTHON_PATH: ${{ github.workspace }}/.venv/bin/python
|
||||
|
||||
rust:
|
||||
name: Rust
|
||||
needs: tokens
|
||||
if: needs.tokens.outputs.present == 'true'
|
||||
runs-on: ubuntu-latest
|
||||
timeout-minutes: 45
|
||||
permissions:
|
||||
contents: read
|
||||
checks: write
|
||||
steps:
|
||||
- name: Checkout repository
|
||||
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
|
||||
with:
|
||||
ref: ${{ github.event.pull_request.head.sha || github.sha }}
|
||||
fetch-depth: 0
|
||||
persist-credentials: false
|
||||
|
||||
# tauri::generate_context!() refuses to expand without the frontend
|
||||
# directory (frontendDist): an empty page stands in for the web build.
|
||||
- name: Stand-in for the web build
|
||||
run: |
|
||||
mkdir -p webapp/dist
|
||||
echo '<!doctype html><title>stand-in</title>' > webapp/dist/index.html
|
||||
|
||||
# qodana-rust ships only as a Docker image (Early Access). It runs as
|
||||
# root so that its bootstrap (webapp/src-tauri/qodana.yaml) can install
|
||||
# the C toolchain and the libraries Tauri links against; the crates go
|
||||
# to the (cached) Qodana cache directory. `cargo check` runs the build
|
||||
# scripts of the locked dependencies in that container.
|
||||
- name: Qodana scan
|
||||
uses: JetBrains/qodana-action@3e8d76ff0e0241618abd808682f426afe84bab3f # v2026.2.2
|
||||
with:
|
||||
args: --project-dir webapp/src-tauri --repository-root . --linter qodana-rust -u root -e CARGO_HOME=/data/cache/cargo
|
||||
pr-mode: false
|
||||
post-pr-comment: false
|
||||
upload-result: true
|
||||
artifact-name: qodana-report-rust
|
||||
primary-cache-key: qodana-2026.2-rust-${{ github.ref }}-${{ github.sha }}
|
||||
additional-cache-key: qodana-2026.2-rust-${{ github.ref }}
|
||||
cache-default-branch-only: true
|
||||
env:
|
||||
QODANA_TOKEN: ${{ secrets.QODANA_TOKEN_RUST }}
|
||||
@@ -48,7 +48,6 @@ concurrency:
|
||||
|
||||
env:
|
||||
PYTHONUNBUFFERED: '1'
|
||||
PYTHONUTF8: '1'
|
||||
|
||||
jobs:
|
||||
scan:
|
||||
@@ -69,14 +68,15 @@ jobs:
|
||||
persist-credentials: false
|
||||
|
||||
- name: Set up Python
|
||||
uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
|
||||
uses: actions/setup-python@6d4fd22b20465ccc0f7354476588e8df7c9ca0e0 # v7.1.0
|
||||
with:
|
||||
python-version-file: .python-version
|
||||
python-version-file: .github/python-version
|
||||
cache: pip
|
||||
cache-dependency-path: requirements.txt
|
||||
|
||||
- name: Install dependencies
|
||||
run: pip install -r requirements.txt
|
||||
run: |
|
||||
pip install --require-hashes --only-binary :all: -r requirements.txt
|
||||
|
||||
- name: Check a slice of the catalog
|
||||
id: refresh
|
||||
@@ -95,7 +95,7 @@ jobs:
|
||||
|
||||
- name: Upload patch
|
||||
if: always()
|
||||
uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
|
||||
uses: actions/upload-artifact@cf430e030ddbb5b0abf93d22962f4752f3646cd9 # v7.0.2
|
||||
with:
|
||||
name: refresh-patch
|
||||
path: ${{ runner.temp }}/patch.json
|
||||
@@ -124,17 +124,18 @@ jobs:
|
||||
ref: main
|
||||
|
||||
- name: Set up Python
|
||||
uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
|
||||
uses: actions/setup-python@6d4fd22b20465ccc0f7354476588e8df7c9ca0e0 # v7.1.0
|
||||
with:
|
||||
python-version-file: .python-version
|
||||
python-version-file: .github/python-version
|
||||
cache: pip
|
||||
cache-dependency-path: requirements.txt
|
||||
|
||||
- name: Install dependencies
|
||||
run: pip install -r requirements.txt
|
||||
run: |
|
||||
pip install --require-hashes --only-binary :all: -r requirements.txt
|
||||
|
||||
- name: Download patch
|
||||
uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1
|
||||
uses: actions/download-artifact@9000827ccba6bdab643e8b6fd33ac0654aef8333 # v8.0.2
|
||||
with:
|
||||
name: refresh-patch
|
||||
path: ${{ runner.temp }}
|
||||
|
||||
@@ -45,7 +45,7 @@ jobs:
|
||||
persist-credentials: false
|
||||
|
||||
- name: Set up JDK
|
||||
uses: actions/setup-java@de7274f081f381c8f8158605e0321c36c376e2e6 # v6.0.1
|
||||
uses: actions/setup-java@77dd5b2ce225ea11469928ac317850245a74ae78 # v6.2.0
|
||||
with:
|
||||
distribution: temurin
|
||||
java-version: '17'
|
||||
@@ -55,7 +55,7 @@ jobs:
|
||||
# (it hard-errors otherwise). Release builds use no caches at all.
|
||||
|
||||
- name: Set up Node.js
|
||||
uses: actions/setup-node@820762786026740c76f36085b0efc47a31fe5020 # v7.0.0
|
||||
uses: actions/setup-node@949feb2413d6458794dcd2491c4babbbce0c15c1 # v7.1.0
|
||||
with:
|
||||
node-version-file: webapp/.node-version
|
||||
# No dependency cache in release builds: a poisoned cache could end
|
||||
@@ -63,7 +63,7 @@ jobs:
|
||||
package-manager-cache: false
|
||||
|
||||
- name: Set up Rust
|
||||
uses: dtolnay/rust-toolchain@7e38f4b43b4db5c8dd498af069a4f6196df1d067 # master
|
||||
uses: dtolnay/rust-toolchain@683b588c487a69d01f6c6ddf40f036ff682cc2c8 # master
|
||||
with:
|
||||
toolchain: stable
|
||||
targets: aarch64-linux-android
|
||||
@@ -81,7 +81,7 @@ jobs:
|
||||
|
||||
- name: Install npm deps
|
||||
working-directory: webapp
|
||||
run: npm ci
|
||||
run: npm ci --ignore-scripts
|
||||
|
||||
- name: Initialize Android project
|
||||
working-directory: webapp
|
||||
@@ -129,7 +129,7 @@ jobs:
|
||||
echo "apk_name=$OUT" >> "$GITHUB_OUTPUT"
|
||||
|
||||
- name: Upload APK as workflow artifact
|
||||
uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
|
||||
uses: actions/upload-artifact@cf430e030ddbb5b0abf93d22962f4752f3646cd9 # v7.0.2
|
||||
with:
|
||||
name: ${{ steps.sign.outputs.apk_name }}
|
||||
path: ${{ steps.sign.outputs.apk_path }}
|
||||
|
||||
@@ -94,7 +94,7 @@ jobs:
|
||||
persist-credentials: false
|
||||
|
||||
- name: Set up Node.js
|
||||
uses: actions/setup-node@820762786026740c76f36085b0efc47a31fe5020 # v7.0.0
|
||||
uses: actions/setup-node@949feb2413d6458794dcd2491c4babbbce0c15c1 # v7.1.0
|
||||
with:
|
||||
node-version-file: webapp/.node-version
|
||||
# No dependency cache in release builds: a poisoned cache could end
|
||||
@@ -102,7 +102,7 @@ jobs:
|
||||
package-manager-cache: false
|
||||
|
||||
- name: Set up Rust
|
||||
uses: dtolnay/rust-toolchain@7e38f4b43b4db5c8dd498af069a4f6196df1d067 # master
|
||||
uses: dtolnay/rust-toolchain@683b588c487a69d01f6c6ddf40f036ff682cc2c8 # master
|
||||
with:
|
||||
toolchain: stable
|
||||
targets: ${{ matrix.tauri_target }}
|
||||
@@ -121,7 +121,7 @@ jobs:
|
||||
|
||||
- name: Install npm deps
|
||||
working-directory: webapp
|
||||
run: npm ci
|
||||
run: npm ci --ignore-scripts
|
||||
|
||||
- name: Build Tauri app
|
||||
uses: tauri-apps/tauri-action@1deb371b0cd8bd54025b384f1cd735e725c4060f # action-v1.0.0
|
||||
|
||||
@@ -0,0 +1,149 @@
|
||||
# SonarQube Cloud: CI-based analysis with test coverage
|
||||
# (https://sonarcloud.io/project/overview?id=poli0981_free-games-itchio-list).
|
||||
# Automatic Analysis is switched off on sonarcloud.io — while it is on, the
|
||||
# scanner refuses to run. Settings: sonar-project.properties. The SonarQube
|
||||
# Cloud app reports each PR's quality gate as the "SonarCloud Code Analysis" check.
|
||||
#
|
||||
# token — is SONAR_TOKEN available? Dependabot and fork PRs get no
|
||||
# repository secrets: the analysis is skipped there, not failed.
|
||||
# coverage — pytest-cov and Vitest (v8) coverage reports, without the token.
|
||||
# scan — sonarqube-scan-action with those reports: the only step that
|
||||
# uses the token, in a job that runs no project or dependency code.
|
||||
name: SonarQube Cloud
|
||||
|
||||
on:
|
||||
push:
|
||||
branches: [main]
|
||||
# Data commits (the pipeline's, the admin Worker's) and docs change no code.
|
||||
paths-ignore:
|
||||
- 'data_game/**'
|
||||
- 'scripts/temp_link.json'
|
||||
- 'scripts/deleted_games.json'
|
||||
- 'scripts/state/**'
|
||||
- '**.md'
|
||||
pull_request:
|
||||
paths-ignore:
|
||||
- 'data_game/**'
|
||||
- 'scripts/temp_link.json'
|
||||
- 'scripts/deleted_games.json'
|
||||
- 'scripts/state/**'
|
||||
- '**.md'
|
||||
workflow_dispatch:
|
||||
|
||||
permissions: {}
|
||||
|
||||
concurrency:
|
||||
group: sonarcloud-${{ github.ref }}
|
||||
cancel-in-progress: true
|
||||
|
||||
jobs:
|
||||
token:
|
||||
runs-on: ubuntu-latest
|
||||
timeout-minutes: 5
|
||||
permissions: {}
|
||||
outputs:
|
||||
present: ${{ steps.check.outputs.present }}
|
||||
steps:
|
||||
- name: Check for SONAR_TOKEN
|
||||
id: check
|
||||
env:
|
||||
SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
|
||||
run: |
|
||||
if [ -n "$SONAR_TOKEN" ]; then
|
||||
echo "present=true" >> "$GITHUB_OUTPUT"
|
||||
else
|
||||
echo "::notice::No SONAR_TOKEN in this run (Dependabot or fork PR): SonarQube Cloud analysis skipped."
|
||||
fi
|
||||
|
||||
coverage:
|
||||
needs: token
|
||||
if: needs.token.outputs.present == 'true'
|
||||
runs-on: ubuntu-latest
|
||||
timeout-minutes: 15
|
||||
permissions:
|
||||
contents: read
|
||||
steps:
|
||||
- name: Checkout repository
|
||||
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
|
||||
with:
|
||||
persist-credentials: false
|
||||
|
||||
- name: Set up Python
|
||||
uses: actions/setup-python@6d4fd22b20465ccc0f7354476588e8df7c9ca0e0 # v7.1.0
|
||||
with:
|
||||
python-version-file: .github/python-version
|
||||
cache: pip
|
||||
cache-dependency-path: |
|
||||
requirements.txt
|
||||
requirements-dev.txt
|
||||
|
||||
# Hash-locked, wheels only (CLAUDE.md, gotcha 40).
|
||||
- name: Install Python dependencies
|
||||
run: |
|
||||
pip install --require-hashes --only-binary :all: -r requirements.txt -r requirements-dev.txt
|
||||
|
||||
- name: Pytest with coverage
|
||||
run: pytest --cov --cov-report=xml
|
||||
|
||||
- name: Set up Node.js
|
||||
uses: actions/setup-node@949feb2413d6458794dcd2491c4babbbce0c15c1 # v7.1.0
|
||||
with:
|
||||
node-version-file: webapp/.node-version
|
||||
cache: npm
|
||||
cache-dependency-path: webapp/package-lock.json
|
||||
|
||||
- name: Install npm dependencies
|
||||
working-directory: webapp
|
||||
run: npm ci --ignore-scripts
|
||||
|
||||
- name: Vitest with coverage
|
||||
working-directory: webapp
|
||||
run: npm run test:coverage
|
||||
|
||||
- name: Upload coverage reports
|
||||
uses: actions/upload-artifact@cf430e030ddbb5b0abf93d22962f4752f3646cd9 # v7.0.2
|
||||
with:
|
||||
name: coverage
|
||||
path: |
|
||||
coverage.xml
|
||||
webapp/coverage/lcov.info
|
||||
retention-days: 1
|
||||
if-no-files-found: error
|
||||
|
||||
scan:
|
||||
needs: coverage
|
||||
runs-on: ubuntu-latest
|
||||
timeout-minutes: 15
|
||||
permissions:
|
||||
contents: read
|
||||
steps:
|
||||
- name: Checkout repository
|
||||
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
|
||||
with:
|
||||
# Full history: blame data, and the new-code diff of a PR.
|
||||
fetch-depth: 0
|
||||
persist-credentials: false
|
||||
|
||||
- name: Download coverage reports
|
||||
uses: actions/download-artifact@9000827ccba6bdab643e8b6fd33ac0654aef8333 # v8.0.2
|
||||
with:
|
||||
name: coverage
|
||||
|
||||
# The app version is the analysis version, so on main "new code" (New Code
|
||||
# definition: previous version) starts over at each version bump.
|
||||
- name: Read the app version
|
||||
id: version
|
||||
run: |
|
||||
version=$(jq -r .version webapp/package.json)
|
||||
if ! [[ "$version" =~ ^[0-9]+\.[0-9]+\.[0-9]+$ ]]; then
|
||||
echo "::error::webapp/package.json has no x.y.z version"
|
||||
exit 1
|
||||
fi
|
||||
echo "version=$version" >> "$GITHUB_OUTPUT"
|
||||
|
||||
- name: SonarQube Cloud scan
|
||||
uses: SonarSource/sonarqube-scan-action@e805d875275f728fac1885b413934be6d7c63f65 # v8.4.1
|
||||
env:
|
||||
SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
|
||||
with:
|
||||
args: -Dsonar.projectVersion=${{ steps.version.outputs.version }}
|
||||
@@ -1,5 +1,5 @@
|
||||
# Ingest queued links from scripts/temp_link.json (written by the browser
|
||||
# extension, and later the admin Worker) plus an optional dispatched URL.
|
||||
# Ingest queued links from scripts/temp_link.json (written by the admin
|
||||
# Worker and its cron) plus an optional dispatched URL.
|
||||
#
|
||||
# Runs right away when temp_link.json changes on main (pushes made by GitHub
|
||||
# Apps trigger it; this workflow's own GITHUB_TOKEN push does not, so no loop),
|
||||
@@ -34,7 +34,6 @@ concurrency:
|
||||
|
||||
env:
|
||||
PYTHONUNBUFFERED: '1'
|
||||
PYTHONUTF8: '1'
|
||||
|
||||
jobs:
|
||||
ingest:
|
||||
@@ -49,14 +48,15 @@ jobs:
|
||||
ref: main
|
||||
|
||||
- name: Set up Python
|
||||
uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
|
||||
uses: actions/setup-python@6d4fd22b20465ccc0f7354476588e8df7c9ca0e0 # v7.1.0
|
||||
with:
|
||||
python-version-file: .python-version
|
||||
python-version-file: .github/python-version
|
||||
cache: pip
|
||||
cache-dependency-path: requirements.txt
|
||||
|
||||
- name: Install dependencies
|
||||
run: pip install -r requirements.txt
|
||||
run: |
|
||||
pip install --require-hashes --only-binary :all: -r requirements.txt
|
||||
|
||||
- name: Scrape queued links
|
||||
timeout-minutes: 50
|
||||
|
||||
@@ -30,14 +30,22 @@ jobs:
|
||||
persist-credentials: false
|
||||
|
||||
- name: Set up Node.js
|
||||
uses: actions/setup-node@820762786026740c76f36085b0efc47a31fe5020 # v7.0.0
|
||||
uses: actions/setup-node@949feb2413d6458794dcd2491c4babbbce0c15c1 # v7.1.0
|
||||
with:
|
||||
node-version-file: webapp/.node-version
|
||||
cache: npm
|
||||
cache-dependency-path: webapp/package-lock.json
|
||||
|
||||
# No install scripts: esbuild's and workerd's postinstall only check their
|
||||
# platform binary, which their launchers find without it.
|
||||
- name: Install dependencies
|
||||
run: npm ci
|
||||
run: npm ci --ignore-scripts
|
||||
|
||||
# The web build never runs `tauri build`, which refuses mismatched
|
||||
# crate / npm versions; without this a Dependabot bump on one side
|
||||
# surfaces only when the release workflows run on a tag.
|
||||
- name: Tauri crates match their npm packages
|
||||
run: npm run check:tauri
|
||||
|
||||
- name: Worker types are up to date
|
||||
run: npm run cf:types -- --check
|
||||
@@ -55,4 +63,4 @@ jobs:
|
||||
run: npm run build
|
||||
|
||||
- name: Validate Workers config (dry run)
|
||||
run: npx wrangler deploy --dry-run --env=""
|
||||
run: npm run cf:check
|
||||
@@ -15,6 +15,7 @@
|
||||
|
||||
/webapp/node_modules/
|
||||
/webapp/dist/
|
||||
/webapp/coverage/
|
||||
/webapp/src-tauri/target/
|
||||
/webapp/src-tauri/gen/
|
||||
|
||||
|
||||
@@ -1 +0,0 @@
|
||||
3.14
|
||||
@@ -0,0 +1,196 @@
|
||||
# Accessibility
|
||||
|
||||
Last updated: 2026-11-09
|
||||
|
||||
Applies from: the release of version 4.6.0 (the website and the desktop and Android apps).
|
||||
|
||||
This is a hobby project run by one person, poli0981 (SkullMute), called "the Maintainer" below: a catalog of free itch.io games, on the website https://freeitchgames.win and in desktop and Android apps that show the same pages. Everyone should be able to use it, whether with a keyboard alone, a screen reader, zoom, a high-contrast theme, speech input or anything else. This statement says what works, how it is checked, what doesn't work yet, and how to tell the Maintainer when something gets in your way.
|
||||
|
||||
A Vietnamese translation is available at [`docs/i18n/vi/ACCESSIBILITY.md`](docs/i18n/vi/ACCESSIBILITY.md). If the two differ, this English version prevails.
|
||||
|
||||
> **TL;DR**
|
||||
>
|
||||
> - The goal is [WCAG 2.2](https://www.w3.org/TR/WCAG22/) Level AA for the website and the apps. That is a target, not a certificate: nobody outside the project has audited it.
|
||||
> - Every page works with the keyboard alone and with a screen reader. The Maintainer tests with the keyboard only, Windows Narrator, and VoiceOver on an iPhone.
|
||||
> - Colours meet the WCAG contrast ratios in the light and dark themes, and a test checks them on every change. Windows contrast themes are supported, and the site follows your system's "reduce motion" setting.
|
||||
> - Every chart comes with a data table.
|
||||
> - Known gaps are listed in [§6](#6-known-limitations).
|
||||
> - Something in your way? Open an [accessibility issue](https://github.com/poli0981/free-games-itchio-list/issues/new?template=accessibility.yml) or email **contact@poli0981.dev**.
|
||||
|
||||
## 1. Scope
|
||||
|
||||
This statement covers:
|
||||
|
||||
- **the website** https://freeitchgames.win: every public page (Home, Games, the game pages, Charts, Removed, Suggest, Settings, About, the error pages) and the verification page shown before them;
|
||||
- **the desktop apps** (Windows, macOS, Linux) **and the Android app**, which show the same pages in the system's web view.
|
||||
|
||||
It doesn't cover:
|
||||
|
||||
- the games themselves, their itch.io pages, and what their creators wrote or made (titles, descriptions, tags, cover images);
|
||||
- Cloudflare Turnstile, the third-party check on the verification page and on the Suggest form (Cloudflare is responsible for its accessibility);
|
||||
- the Maintainer's admin page, which has one user;
|
||||
- other sites the pages link to, GitHub included.
|
||||
|
||||
## 2. Goals and priorities
|
||||
|
||||
- **Target**: [WCAG 2.2](https://www.w3.org/TR/WCAG22/) Level AA, as far as a one-person hobby project can get.
|
||||
- **First**: the main tasks with a keyboard and a screen reader: find a game, read its details, open it on itch.io, change your settings, suggest a game.
|
||||
- **Then**: readable text and controls (contrast, zoom, reflow), no motion you didn't ask for, and the right language for screen readers (English or Vietnamese).
|
||||
- **Always**: new features keep all of this working (see [§8](#8-for-contributors)).
|
||||
|
||||
## 3. What works today
|
||||
|
||||
### Moving around
|
||||
|
||||
- "Skip to content" is the first thing the Tab key reaches.
|
||||
- Each page has named landmarks (header, main navigation, search, main content, pager, footer), one level-1 heading, and its own title.
|
||||
- After you follow a link inside the site, focus moves to the new page's heading, so a screen reader announces the page and Tab continues from there. Going back returns focus to the link you used, for example the game you opened from the list.
|
||||
- The sticky header never covers what has keyboard focus.
|
||||
|
||||
### Keyboard
|
||||
|
||||
- Everything works with the keyboard alone: menus, filters, dialogs and charts.
|
||||
- Focus is always visible: a purple outline, or the system highlight in a contrast theme.
|
||||
- Dialogs keep focus inside while they are open and return it to where you were when they close.
|
||||
- "/" jumps to the search box. You can switch this shortcut off in **Settings → Accessibility**, which helps with speech input or if the key clashes with your screen reader or your browser's quick find.
|
||||
- When a control disappears after you use it (clearing a search, removing a filter), focus moves to the next sensible place instead of getting lost.
|
||||
|
||||
### Screen readers
|
||||
|
||||
- Every control has a name, in English or Vietnamese. Icons are hidden from screen readers.
|
||||
- The number of results, search suggestions, loading states and form messages are announced.
|
||||
- On wide screens the game list is a table with column headers; on phones it is a simple list.
|
||||
- Links that open a new tab (in the apps: your browser) say so.
|
||||
- Text in the other language, such as the language names and the English-only names of the legal documents, is marked with its language.
|
||||
|
||||
### Seeing the content
|
||||
|
||||
- Text and controls meet the WCAG 2.2 AA contrast ratios in both themes: 4.5:1 for text, 3:1 for field borders, the focus outline and chart colours. The test [`webapp/scripts/check-contrast.test.mjs`](webapp/scripts/check-contrast.test.mjs) checks the colours on every change.
|
||||
- Light, dark or system theme, compact or normal rows, and hidden scrollbars: all in Settings.
|
||||
- Windows contrast themes (forced colours): the selected tab, pressed toggles, the current page and switches use the system's highlight colours.
|
||||
- Zoom is never blocked. At 400 % zoom or in a 320-pixel-wide window the phone layout takes over, and the page doesn't scroll sideways.
|
||||
- Links inside sentences are underlined. Nothing is shown by colour alone: states also change the text, an outline or an underline.
|
||||
|
||||
### Motion
|
||||
|
||||
- With "reduce motion" switched on in your system, animations, chart entrances and smooth scrolling are off.
|
||||
- On the website, covers are normally shown as still images (animated covers are turned into stills).
|
||||
- Apart from loading placeholders, nothing moves on its own.
|
||||
|
||||
### Charts
|
||||
|
||||
- Each chart is named after its heading. Focus it and use the left and right arrow keys: the value you move to is read out.
|
||||
- Under every chart, **Data table** opens the same numbers as a table, with each part's share for the pie charts.
|
||||
|
||||
### Language
|
||||
|
||||
- The pages are in English or Vietnamese (Settings), and the page language follows your choice, so screen readers pick the right voice. Numbers and dates follow it too.
|
||||
|
||||
## 4. How it is tested
|
||||
|
||||
- **By the Maintainer, by hand** (November 2026): the website on Windows 11 and the Windows desktop app, with the keyboard only (mouse switched off) and Windows Narrator. No blocking problems were found.
|
||||
- **On a real phone** (November 2026, version 4.6.0): the website on an iPhone 14 Pro with VoiceOver, in Safari, Chrome and Brave. It passed.
|
||||
- **For 4.6.0**: the main pages and dialogs were walked through with the keyboard, and their accessibility tree was checked (names, roles, headings, landmarks, announcements) in English and Vietnamese, on a desktop and a phone-sized screen.
|
||||
- **Automatically, on every change**: the contrast test above and the app's unit tests (where focus goes after a page change, the chart tables).
|
||||
- **Before each release**: a short smoke test. That means a keyboard pass through the main tasks, a screen reader spot check, 200 % zoom and a narrow window, reduced motion, and a Windows contrast theme.
|
||||
- **Not yet**: automated browser scans (such as axe or Lighthouse) in CI, and testing by people who use a wide range of assistive technology every day. Help is welcome.
|
||||
|
||||
## 5. Supported environments
|
||||
|
||||
| | Versions |
|
||||
|---|---|
|
||||
| Website | Current Chrome, Edge, Firefox and Safari on computers and phones. The oldest versions the site is built for are Chrome and Edge 111, Firefox 114, and Safari and iOS 15.4. |
|
||||
| Desktop apps | Windows 10 and 11 (Microsoft Edge WebView2), macOS (WebKit 16.4 or newer), Linux (WebKitGTK 4.1) |
|
||||
| Android app | Android 11 or newer |
|
||||
|
||||
Assistive technology:
|
||||
|
||||
- **Tested**: Windows Narrator on Windows 11, VoiceOver on iOS (iPhone 14 Pro: Safari, Chrome and Brave), and keyboard-only use.
|
||||
- **Expected to work, not regularly tested**: NVDA and JAWS on Windows, VoiceOver on macOS, TalkBack on Android, browser zoom, Windows contrast themes, speech input. They rely on the same standard markup.
|
||||
- **Limited**: Orca in the Linux desktop app, because WebKitGTK supports screen readers less well than the browsers do.
|
||||
|
||||
## 6. Known limitations
|
||||
|
||||
- **Creators' text isn't marked with its language.** Game titles, descriptions and tags come from itch.io in many languages, and a screen reader reads them in the page's language.
|
||||
- **Cover images have a generic description** ("Game name cover"). What the image shows isn't described.
|
||||
- **Charts**: the arrow keys only move left and right. The genre treemap can't be stepped through, but its numbers are in its data table and in the Genres chart. Chart text has a fixed pixel size, so a larger default font size in your browser doesn't change it (page zoom does).
|
||||
- **Desktop apps**: there are no zoom keys inside the app, the window can't be maximized, and it can't be made smaller than 900 × 600. If you need larger text, use your system's display scaling or the website in a browser.
|
||||
- **Android app**: pinch-to-zoom is off. The website can be zoomed in your phone's browser.
|
||||
- **Animated covers in the apps**: the apps load covers straight from itch.io, so an animated cover keeps playing there.
|
||||
- **Cloudflare's checks**: the verification check (website only) and the anti-spam check on the Suggest form are Cloudflare Turnstile widgets. They usually pass without anything to do. If one ever asks for something you can't do, email the Maintainer.
|
||||
- **GitHub pages**: the policies, this statement and the issue forms live on GitHub, so GitHub's own accessibility applies there.
|
||||
- **No external audit**, and one maintainer.
|
||||
|
||||
## 7. Reporting an accessibility barrier
|
||||
|
||||
If something stops you or slows you down, please say so. Partial reports help too.
|
||||
|
||||
- **GitHub**: open an [Accessibility barrier issue](https://github.com/poli0981/free-games-itchio-list/issues/new?template=accessibility.yml).
|
||||
- **Email**: **contact@poli0981.dev**. No GitHub account needed; English or Vietnamese both work.
|
||||
|
||||
Details that help, as far as you're comfortable sharing them (never send health information):
|
||||
|
||||
- what you were trying to do, and what happened instead;
|
||||
- the page (its address) or the app and its version, shown on the About page;
|
||||
- your device, operating system and browser;
|
||||
- the assistive technology you use and its version, if any;
|
||||
- a screenshot or a recording, if you can.
|
||||
|
||||
How much it gets in your way:
|
||||
|
||||
| Severity | Meaning |
|
||||
|---|---|
|
||||
| Critical | You can't do a main task at all, for example open a game or read its details. |
|
||||
| Serious | You can, but only with great effort or a workaround. |
|
||||
| Moderate | It's annoying or inconsistent, but you get there. |
|
||||
| Minor | A small polish issue. |
|
||||
|
||||
What happens next. These are targets, not guarantees, since this is a solo hobby project:
|
||||
|
||||
- **Acknowledgement** within 7 days, often sooner.
|
||||
- **A fix or a workaround**: Critical within 30 days, Serious within 60 days, Moderate and Minor in a later release.
|
||||
- **Website fixes** go live when they are deployed; **app fixes** come with the next release.
|
||||
- You'll be asked whether the fix works for you, and credited in the release notes if you want.
|
||||
|
||||
Security vulnerabilities don't belong in a public issue: see [SECURITY.md](SECURITY.md).
|
||||
|
||||
## 8. For contributors
|
||||
|
||||
Changes to the interface must keep [§3](#3-what-works-today) true:
|
||||
|
||||
- **Keyboard**: every control can be reached and used, focus stays visible and never gets lost.
|
||||
- **Names**: every control has a label, with its text in both `webapp/src/lib/i18n/en.ts` and `vi.ts`.
|
||||
- **Colour**: use the theme tokens. `npm test` checks contrast (4.5:1 for text, 3:1 for borders, focus and chart colours), and colour is never the only signal.
|
||||
- **Motion**: respect `prefers-reduced-motion`; the shared CSS rule and `SERIES_ANIMATION` already do.
|
||||
- **Screen reader**: check the change once with one (Narrator, NVDA, VoiceOver or TalkBack).
|
||||
- **Markup**: prefer native elements and the Radix / shadcn components already in use, and add ARIA only when it's needed.
|
||||
|
||||
Documentation: headings in order, link text that says where it goes, alt text for images, header cells in tables, and the Vietnamese translation updated (or say in the pull request that it isn't).
|
||||
|
||||
The [pull request template](.github/pull_request_template.md) has the checklist.
|
||||
|
||||
## 9. Finding accessible games
|
||||
|
||||
The catalog shows the accessibility features that creators list on their itch.io pages, such as subtitles, configurable controls or colour-blind modes:
|
||||
|
||||
- on each game's page, under "Accessibility";
|
||||
- as the Accessibility filter on the Games page, for example https://freeitchgames.win/games?access=Subtitles;
|
||||
- in the "Accessibility Features" chart (Charts → Discovery).
|
||||
|
||||
Creators declare these features themselves, and the project doesn't verify them. If a game's information is wrong, report it with the "Bug Report" issue template.
|
||||
|
||||
## 10. References
|
||||
|
||||
- [Open Source Guides: Accessibility best practices for your project](https://opensource.guide/accessibility-best-practices-for-your-project/)
|
||||
- [Open Source Accessibility toolkit](https://github.com/open-source-accessibility/accessibility-toolkit): this statement follows the outline of its ACCESSIBILITY.md example, in its own words.
|
||||
- [Web Content Accessibility Guidelines (WCAG) 2.2](https://www.w3.org/TR/WCAG22/)
|
||||
- [W3C: Developing an accessibility statement](https://www.w3.org/WAI/planning/statements/)
|
||||
|
||||
## 11. Contact
|
||||
|
||||
- **Accessibility barriers**: the [issue form](https://github.com/poli0981/free-games-itchio-list/issues/new?template=accessibility.yml) or **contact@poli0981.dev**.
|
||||
- **Everything else**: see the addresses in [README → Legal](README.md#legal).
|
||||
|
||||
## 12. Final vibes
|
||||
|
||||
One person, one catalog, every way of browsing it. If something here doesn't work the way you use the web, the Maintainer would really like to hear it — that's how this list gets better. 🚀
|
||||
+9
-1
@@ -3,12 +3,20 @@
|
||||
All notable changes to this project, newest first. The notes of each release live in
|
||||
[`changelog/`](changelog/), one file per minor version: `changelog/<major>.x/ver<major>.<minor>.x.md`.
|
||||
|
||||
**Latest release: [4.3.0](changelog/4.x/ver4.3.x.md#430---2026-10-10-ai-disclosure-accessibility-refreshed-catalog) (2026-10-10) — AI disclosure, accessibility, refreshed catalog.**
|
||||
**Latest release: [4.6.2](changelog/4.x/ver4.6.x.md#462---2026-11-16-dependency-updates) (2026-11-16) — Dependency updates.**
|
||||
|
||||
## 4.x
|
||||
|
||||
| Version | Date | Highlights |
|
||||
|---|---|---|
|
||||
| [4.6.2](changelog/4.x/ver4.6.x.md#462---2026-11-16-dependency-updates) | 2026-11-16 | Dependency updates (wry 0.57.2: app crash fixes) |
|
||||
| [4.6.1](changelog/4.x/ver4.6.x.md#461---2026-11-11-stable-maintenance-mode) | 2026-11-11 | Stable: maintenance mode (data-only issues and PRs), Qodana code analysis |
|
||||
| [4.6.0](changelog/4.x/ver4.6.x.md#460---2026-11-09-accessibility) | 2026-11-09 | Accessibility: statement, keyboard and screen-reader fixes, chart data tables, WCAG contrast |
|
||||
| [4.5.0](changelog/4.x/ver4.5.x.md#450---2026-10-27-rate-limits-for-the-whole-site) | 2026-10-27 | Rate limits for the whole site (HTTP 429), WAF guide |
|
||||
| [4.4.3](changelog/4.x/ver4.4.x.md#443---2026-10-26-dependency-and-security-updates) | 2026-10-26 | Dependency and security updates (build-tool advisories closed) |
|
||||
| [4.4.2](changelog/4.x/ver4.4.x.md#442---2026-10-22-toolchain-upgrade-code-scan-fixes) | 2026-10-22 | Toolchain upgrade (TypeScript 7, Node 26, Python 3.15), code-scan fixes |
|
||||
| [4.4.1](changelog/4.x/ver4.4.x.md#441---2026-10-16-extension-and-bot-retired) | 2026-10-16 | Extension and bot retired (archived repos), ingest API removed |
|
||||
| [4.4.0](changelog/4.x/ver4.4.x.md#440---2026-10-13-admin-automation-bulk-actions-smoother-charts) | 2026-10-13 | Admin automation, bulk actions, smoother charts |
|
||||
| [4.3.0](changelog/4.x/ver4.3.x.md#430---2026-10-10-ai-disclosure-accessibility-refreshed-catalog) | 2026-10-10 | AI disclosure, accessibility, refreshed catalog |
|
||||
| [4.2.0](changelog/4.x/ver4.2.x.md#420---2026-10-03-compact-catalog-data-themed-scrollbars) | 2026-10-03 | Compact catalog data, themed scrollbars |
|
||||
| [4.1.1](changelog/4.x/ver4.1.x.md#411---2026-09-29-new-contact-addresses) | 2026-09-29 | New contact addresses (@poli0981.dev) |
|
||||
|
||||
@@ -8,25 +8,27 @@ A curated, auto-updating catalog of free itch.io games, published at **https://f
|
||||
everyone; the old github.io URL only redirects). Three layers share one JSON catalog:
|
||||
|
||||
1. **Python pipeline** — the data layer (GitHub Actions).
|
||||
- `data_game/game_info_NNN.json` — chunked records, max 500 per file, 2,811 games on 2026-09-24. Serialization is fixed: `json.dumps(..., ensure_ascii=False, indent=4)`, no trailing newline (`json_io.dumps`) — the Worker port (`webapp/worker/catalog.ts`) emits identical bytes (`tests/fixtures/golden/`).
|
||||
- `data_game/game_info_NNN.json` — chunked records, max 500 per file, 6,069 games on 2026-11-16. Serialization is fixed: `json.dumps(..., ensure_ascii=False, indent=4)`, no trailing newline (`json_io.dumps`) — the Worker port (`webapp/worker/catalog.ts`) emits identical bytes (`tests/fixtures/golden/`).
|
||||
- `data_game/index.json` — chunk manifest (total + per-file counts). `data_game/count_history.json` — date-keyed `{date,total}` series ("games over time" chart). `scripts/deleted_games.json` — removal log (public "Removed" page). `scripts/temp_link.json` — ingest queue.
|
||||
- `scripts/` — scanners never write the catalog: `update_info.py` (queued URLs) and `refresh.py` (rotating 1/7-per-day check; `--full` re-scrape) emit a URL-keyed **patch** (`patch.py`); `apply_patch.py` applies it to the latest `main` and runs `validate.py`; `bash/commit_push.sh` does fetch → reset → apply → commit → push with retries. Shared: `scraper.py` (session, `Pacer` + 429 back-off, parsing: the info panel incl. itch.io's 2025–26 rows — `AI Disclosure` ("AI Assisted", then what for) / `Content` linking `/games/tag-no-ai` → `ai_disclosure` + `ai_content`, `Accessibility` → `accessibility`; `description` = the creator's tagline (`og:description`), else the first sentence), `data_store.py` (chunks stay in place, rebalance only past thresholds, write-if-changed), `json_io.py`, `canonical.py` (canonical itch.io URL; vectors in `tests/fixtures/url_vectors.json`, shared with the Worker). Pipeline bookkeeping lives in `scripts/state/` (not published). Tests: `pytest` (network blocked). Lint: `ruff check scripts tests webapp/scripts`, `ruff format`, `vulture` (config in root `pyproject.toml`). Local env: `python -m venv .venv && .venv/Scripts/pip install -r requirements-dev.txt` (Windows: run with `PYTHONUTF8=1`).
|
||||
- `scripts/` — scanners never write the catalog: `update_info.py` (queued URLs) and `refresh.py` (rotating 1/7-per-day check; `--full` re-scrape) emit a URL-keyed **patch** (`patch.py`); `apply_patch.py` applies it to the latest `main` and runs `validate.py`; `bash/commit_push.sh` does fetch → reset → apply → commit → push with retries. Shared: `scraper.py` (session, `Pacer` + 429 back-off, parsing: the info panel incl. itch.io's 2025–26 rows — `AI Disclosure` ("AI Assisted", then what for) / `Content` linking `/games/tag-no-ai` → `ai_disclosure` + `ai_content`, `Accessibility` → `accessibility`; `description` = the creator's tagline (`og:description`), else the first sentence), `data_store.py` (chunks stay in place, rebalance only past thresholds, write-if-changed), `json_io.py`, `canonical.py` (canonical itch.io URL; vectors in `tests/fixtures/url_vectors.json`, shared with the Worker). Pipeline bookkeeping lives in `scripts/state/` (not published), including `ingest_outcomes.json` (how each queued link ended — added / duplicate / paid / dead / private / deleted / gave_up; patch key `ingest_outcomes`; the last 90 days, ≤ 5,000) that the admin's tracking and the cron's reconcile read. Tests: `pytest` (network blocked; `pytest --cov --cov-report=xml` → `coverage.xml` for SonarQube Cloud, gotcha 41). Lint: `ruff check scripts tests webapp/scripts`, `ruff format`, `vulture` (config in root `pyproject.toml`). Local env: Python 3.15 (`.github/python-version`, gotcha 39; ruff `target-version = "py315"`), `python -m venv .venv && .venv/Scripts/pip install -r requirements-dev.txt` (3.15 is in UTF-8 mode by default — no `PYTHONUTF8` needed, the workflows no longer set it). Both requirements files are hash-locked pip-tools compiles of `requirements*.in` — edit the `.in`, then recompile (gotcha 40).
|
||||
2. **Cloudflare Worker + static assets** — `webapp/worker/` + `webapp/wrangler.jsonc`, deployed by **Cloudflare Workers Builds** from `main` (root dir `webapp`, build `npm run build`, deploy `npx wrangler deploy`; no deploy workflow). The catalog is bundled into the site at build time (`vite-plugins/catalog-data.ts` → `dist/data/pack/` compact packs + the legacy readable JSON in `dist/data/`, plus `data/urls.json` and `sitemap.xml`), so every data commit rebuilds the site.
|
||||
3. **Web app + Tauri apps** — `webapp/src/` (React 19.3 + TypeScript 6.0 + Vite 8/rolldown + Tailwind + shadcn/ui + React Router 8), and the **Tauri 2 desktop + Android** read-only viewers in `webapp/src-tauri/` (same code; they fetch `https://freeitchgames.win/data/pack` and load covers straight from img.itch.zone). Plus `webapp/admin/` — the maintainer-only admin app (second Vite entry, served at `/admin/`).
|
||||
3. **Web app + Tauri apps** — `webapp/src/` (React 19.3 + TypeScript 7.0 + Vite 8/rolldown + Tailwind + shadcn/ui + React Router 8), and the **Tauri 2 desktop + Android** read-only viewers in `webapp/src-tauri/` (same code; they fetch `https://freeitchgames.win/data/pack` and load covers straight from img.itch.zone). Plus `webapp/admin/` — the maintainer-only admin app (second Vite entry, served at `/admin/`).
|
||||
|
||||
Adding games: the public **Suggest** page (`/suggest`, Turnstile), the maintainer's browser extension (`POST /api/ingest`, Access service token; repo `poli0981/itch-f2p-extension`), and RSS discovery (Worker cron) all feed a **D1 review queue**; approving in `/admin` commits the URLs to `scripts/temp_link.json` as a GitHub App, which triggers `update.yml`.
|
||||
Adding games: the public **Suggest** page (`/suggest`, Turnstile) and RSS discovery (Worker cron) feed a **D1 review queue** (the browser extension's `POST /api/ingest` was removed in 4.4.1; the extension `poli0981/itch-f2p-extension` and the Telegram bot `poli0981/telegram-scraper-bot` are archived repos); approving in `/admin` commits the URLs to `scripts/temp_link.json` as a GitHub App, which triggers `update.yml`. Since 4.4 the cron also approves by rule (`/admin` → Settings, on by default: unflagged `rss` / `form` items nobody rejected within 24 h, only those found after the switch-on baseline `since`, ≤ 100 per run) and queues the new free games of **followed itch.io collections** directly (removed or flagged ones go to the queue) — the policies say so (ToS §5, Privacy §2.4, Disclaimer §4). The Add page takes any text, a file or a collection, **Check**s it first (dry run), sends batches of 200 and follows each game's ingest (`/api/admin/track`).
|
||||
|
||||
## How to work in webapp/
|
||||
|
||||
```sh
|
||||
cd webapp
|
||||
cd webapp # Node 26 (.node-version; engines >=26)
|
||||
npm ci
|
||||
npm run dev # Vite on http://localhost:5173 (proxies /api and /img to wrangler dev on :8787)
|
||||
npx wrangler dev # the Worker + built assets (run `npm run build` first); .dev.vars holds local secrets
|
||||
npm run build # → webapp/dist/ (public app + /admin/ + /data + sitemap); Tauri builds use the same dir
|
||||
npm test # vitest (worker/, src/lib); worker/test/* D1 tests spawn a local workerd via getPlatformProxy
|
||||
npm run test:coverage # the same with v8 coverage → coverage/lcov.info (repo-root paths, for SonarQube Cloud)
|
||||
npm run lint && npm run knip && npx tsc -b
|
||||
npm run cf:types # after editing wrangler.jsonc (ignores .dev.vars via types.env; CI runs it with --check)
|
||||
npm run cf:check # wrangler deploy --dry-run with the project's wrangler (what CI runs; after a build)
|
||||
npx wrangler d1 migrations apply freeitchgames --local # local D1 (use --remote by hand for production)
|
||||
npm run tauri:dev # native window; needs Rust toolchain
|
||||
npm run tauri:build # native installers
|
||||
@@ -39,15 +41,16 @@ Local admin without Access: put `DEV_ADMIN_EMAIL=you@example.com` in `webapp/.de
|
||||
|
||||
## Worker (`webapp/worker/`)
|
||||
|
||||
- `index.ts` routes: `/img/*` (img.ts, behind the gate), `/api/health`, `/api/verify` (gate.ts), `/api/suggest` (suggest.ts), `/api/ingest` (ingest.ts), `/api/admin/*` + `/admin*` (admin.ts), the readable `/data/*.json` (legacy-data.ts), everything else that misses an asset → `spa.ts`. `run_worker_first` also lists `/` (otherwise served straight from `dist/index.html`) so the gate sees it, and the five legacy catalog files one by one (never a `!` pattern — gotcha 26). `scheduled()` (cron `23 */4 * * *`): `discover.ts` (one itch.io RSS feed per run, 6 h back-off on 429) → `QueueStore.reconcile` (queued → ingested / failed after 3 days) → `purge` (idempotency 7 d, Suggest notes 180 d).
|
||||
- `index.ts` routes: `/img/*` (img.ts, behind the gate), `/api/health`, `/api/verify` (gate.ts), `/api/suggest` (suggest.ts), `/api/admin/*` + `/admin*` (admin.ts), the readable `/data/*.json` (legacy-data.ts), everything else that misses an asset → `spa.ts`. `run_worker_first` also lists `/` (otherwise served straight from `dist/index.html`) so the gate sees it, and the five legacy catalog files one by one (never a `!` pattern — gotcha 26). `scheduled()` (cron `23 */4 * * *`), four steps each in its own try/catch: `discover.ts` (one itch.io RSS feed per run, 6 h back-off on 429) → `QueueStore.reconcile` (queued → ingested / failed with the pipeline's outcome, read at head through the GitHub App; else in the catalog → ingested, > 3 days → failed `timeout`) → `automation.ts` (auto-approve + followed collections, ≤ 30 itch.io pages a run, ONE `[auto]` commit, D1 written only after it lands; the run's summary in settings `automation_last_run`) → `purge` (Suggest notes 180 d). The account is on **Workers Paid** (30 s CPU): admin catalog edits parse and rewrite ~3.8 MB in the Worker (≈ 25–30 ms for 100 removals).
|
||||
- `ratelimit.ts` (since 4.5): every Worker request is counted first, per IP (IPv6 /64, `rateKey`) and per Cloudflare location (approximate, fails open), in one `ratelimits` binding per kind of traffic (counted per machine of the data centre: it holds for one-connection clients, the WAF holds for floods — gotcha 43) — `RL_SITE` 120/60 s (pages, public `/api`, legacy `/data`, misses), `RL_IMG` 600, `RL_ADMIN` 300; `RL_SUGGEST` 5 and `RL_GATE` 20 still apply on top to those POSTs. Verified bots (the gate's header) are not counted. Over a limit: 429 + `Retry-After: 60` — JSON `rate_limited` for `/api`, `/img`, files and `/data` (with CORS), the script-less EN/VI page of `gate-page.ts` for app pages. Keep every `period` 60 and a unique `namespace_id` in 88xx (staging 89xx): namespaces are **account-wide** and other Workers on the account (repolens, ticktune…) use 1001–1006, so the old 1001 / 1003 shared their counters (`ratelimit.test.ts` reads `wrangler.jsonc`). Layer 1 is the zone's WAF rate-limiting rule (Free plan: one rule, IP, 10 s; `docs/operations.md` §1 step 15): only it saves the Worker request a flood costs, and only it covers static assets.
|
||||
- `img.ts`: `/img/<160|640>/<path on img.itch.zone>` — allow-listed against `data/urls.json`, edge cache → R2 `THUMBS` (`w{w}/<sha256>.webp`) → `cf.image` transform (stored once) → fallback streams the original with a 1-day cache (quota error 9422). The fallback original and a missing upstream image are also kept in `caches.default` for a day (GET only); widths are the exact strings `160` / `640` (a `Map`, no `Number()` aliases); background puts log failures. Upstream errors → controlled 502.
|
||||
- `spa.ts`: `not_found_handling` is `"none"`, so misses reach the Worker: `/assets/*`, `/data/*` (a pack from an older deploy included — `no-store`, CORS) and file-like paths get a real 404 (`no-store`); app routes get the shell with 200; unknown paths and game slugs not in the catalog get the shell with **404**; with the gate on, a visitor without a pass gets the verification page instead (checked before the shell is fetched, so never a 304). Keep its `ROUTES` in sync with `src/App.tsx` and `src/hooks/useSeoHead.ts`.
|
||||
- `gate.ts` + `gate-page.ts`: the **verification gate** (web only). App pages and `/img` need a pass: the `__Host-fig_gate` cookie (HMAC of its issue time, HttpOnly, `BOT_GATE_TTL_HOURS`, default 48) set by `POST /api/verify` after a Turnstile check (action `gate`, `RL_GATE`, same-origin); `GET /api/verify` reports `{enabled, valid, via, ttl}`. The page is self-contained (inline CSS/JS with a per-response CSP nonce, EN/VI, the site's og tags, 200 + noindex). Verified bots pass with `x-fig-known-bot: <GATE_BOT_TOKEN>` from a zone Transform Rule; clients that only claim to be a crawler get 503. `/assets`, `/data`, `/api/*`, `/admin*` and the other static files stay open. `turnstile.ts`: siteverify shared with Suggest (hostname + action checked; the test secrets skip both).
|
||||
- `access.ts`: verifies `Cf-Access-Jwt-Assertion` with jose (issuer + AUD). Maintainer = email in secret `ADMIN_EMAILS` + same-origin writes; ingest = service-token `common_name`.
|
||||
- `admin.ts`: API (queue list / approve / reject / add / edit the 3 fields / delete with reason + R2 cleanup / restore) and the `/admin` shell with its own CSP. The maintainer's email goes only to the D1 audit log, never into a commit (the repo is public).
|
||||
- `access.ts`: verifies `Cf-Access-Jwt-Assertion` with jose (issuer + AUD). Maintainer = email in secret `ADMIN_EMAILS` + same-origin writes (the only identity: the service-token ingest is gone since 4.4.1).
|
||||
- `admin.ts`: API (queue list / approve / reject / check (dry run) / add / track / edit one or ≤ 100 (`/games/bulk`) / remove one or ≤ 100 (`/games/remove`; after the commit the audit row and the R2 cleanup are best effort → `warnings`, never a 500) / restore / activity / settings / itch.io collections) and the `/admin` shell with its own CSP (theme-script hash included). Request limits shared with the admin app: `limits.ts`. `collections.ts` reads public itch.io collections (gotcha 36); `automation.ts` holds the cron's rules (`planCollectionItems`: only URLs D1 has never seen and without a flag are queued directly — no re-add loop for games the ingest dropped). The maintainer's email goes only to the D1 audit log, never into a commit (the repo is public).
|
||||
- `repo.ts` + `github.ts` + `catalog.ts`: writes as a **GitHub App** (installation token, cached per isolate) with GraphQL `createCommitOnBranch` + `expectedHeadOid` (verified commits; `commitWithRetry` rebuilds from the new head on a race). Reads use the raw media type (no base64/UTF-8 mojibake). `catalog.ts` ports `data_store.py` byte-for-byte (golden fixtures).
|
||||
- `legacy-data.ts`: the readable catalog JSON (`index.json`, `game_info_NNN.json`, `count_history.json`, `deleted_games.json`, `urls.json`) goes only to apps 4.0–4.1.1 — `Origin` `tauri://localhost` / `http(s)://tauri.localhost` → `env.ASSETS` passthrough + `Vary: Origin`; anyone else → **410** JSON with the repository links (`no-store`, CORS, a sampled `console.info` of the Origin). A nudge, not a security boundary: the data is public in the repo.
|
||||
- `queue.ts`: URL classification (catalog → blocklist → pending → previously deleted) + the D1 store (`worker/migrations/`, additive only — never edit an applied migration). `data.ts`: catalog facts read from the site's own `/data` via `env.ASSETS`, cached per isolate (loaded values only — see gotchas).
|
||||
- `queue.ts`: URL classification (catalog → blocklist → pending → previously deleted) + the D1 store (`worker/migrations/`, additive only — never edit an applied migration; `0002` added `candidates.outcome`, `settings` and `watched_collections`; the `idempotency` table and `'ext'` in the `candidates.source` CHECK are unused leftovers of the ingest API removed in 4.4.1; URL lists bind in `IN` slices of 90, gotcha 37). `data.ts`: catalog facts read from the site's own `/data` via `env.ASSETS`, cached per isolate (loaded values only — see gotchas).
|
||||
- Configuration: non-secret settings are `vars` in `wrangler.jsonc` (empty until setup); secrets (`GH_APP_PRIVATE_KEY` — the PEM GitHub downloads (PKCS#1) or PKCS#8; `github.ts` converts, `ADMIN_EMAILS`, `TURNSTILE_SECRET`, `GATE_SECRET`, `GATE_BOT_TOKEN`) via `wrangler secret put`, typed in `worker/env.ts` as optional. A feature whose settings are missing answers **503** (the gate just stays off); the public site needs none of them. `env.staging` = Worker `free-games-itchio-list-staging` on `staging.freeitchgames.win` (no cron, own R2/D1/rate-limit namespaces).
|
||||
|
||||
## Web app structure (`webapp/src/`)
|
||||
@@ -57,14 +60,15 @@ Local admin without Access: put `DEV_ADMIN_EMAIL=you@example.com` in `webapp/.de
|
||||
- Cache: react-query persisted to IndexedDB (`webapp.query-cache`, 7 days) by `lib/data/persister.ts` — byte 0 = format (1 deflate-raw, 0 plain), then the JSON; a legacy string is dropped; writes throttled 1 s and skipped when no data object changed. Persisted: `db`, `deleted`, `count-history` and only the `desc` files the current catalog names (`shouldPersistQuery`); stale `desc` queries are removed after a `db` success. `CACHE_BUSTER = ${APP.version}:data-v2`. **`gcTime` must stay >= persist `maxAge`.**
|
||||
- Layout: `components/site/*` (sticky top nav + global search with the `/` shortcut + display menu + phone sheet menu; footer) — the window scrolls, not `<main>`. `/` is the Welcome page (`routes/welcome.tsx`).
|
||||
- `/games`: search, filters, sort and page live in the URL — `lib/game-filters.ts` (`parseQuery` / `toParams` drop defaults; params `q genre platform status tag lang input engine ai access rating browser sort page`; `ai` treats "N/A" / a missing field as its own "Not disclosed" value and lists its options in a fixed order (`aiRank`); unit-tested) — rendered by `components/games/*` (filter chips with facet counts that ignore their own filter, a desktop ARIA table / phone list chosen by `useIsMobile`, 100 per page; the detail page's breadcrumb links back to the same list via router state). Counts show the whole catalog ("2,729 of 2,811") because 18+ games are hidden by default.
|
||||
- `components/charts/` (19 charts, 4 lazy tabs, **no barrel `index.ts`**; every Recharts tooltip/cursor comes from `chart-theme.ts` + `chart-tooltip.tsx`), `components/game-thumb.tsx` (`lib/thumbnail.ts` → `/img/160|640/...` on the web, the original URL in Tauri), `components/legal-gate.tsx` (a non-dismissable Radix dialog **over** the page, so deep links land where they pointed; links flagged `inGate` in `lib/about.ts`; re-prompts when `LEGAL_VERSION` in `stores/prefs.ts` changes; no "Leave" button in Tauri).
|
||||
- Styling: **Tailwind v4** via `@tailwindcss/vite` (no PostCSS, no `tailwind.config`); tokens are hex CSS variables in `src/index.css` (`:root` / `.dark`, `@theme inline`; `--brand-soft`, `--thumb`, `--success`, `--scrollbar-thumb(-hover/-active)` besides the shadcn set) and must match the approved mockup. Themed scrollbars (`@layer base`, only under `(hover: hover) and (pointer: fine)`): `::-webkit-scrollbar*` for Chromium/Safari, `scrollbar-color` / `scrollbar-width: thin` for Firefox only (gotcha 28); "Hide scrollbars" = unlayered `html[data-scrollbars='hidden']` rules (`hooks/useScrollbarsEffect.ts`). Self-hosted Geist / Geist Mono (`@fontsource-variable/*`, CSP `font-src 'self'`). Numbers and dates go through `lib/format.ts` (`useFormat`: en-GB / vi-VN). `webapp/scripts/gen_assets.py` redraws favicon, PWA icons and `og.png` from the same tokens and the Geist fonts in `node_modules`.
|
||||
- `components/charts/` (19 charts, 4 lazy tabs loaded with `lib/lazy-preload.ts` — preloaded when idle or on hover/focus, rendered without a Suspense fallback once loaded — and kept mounted once shown (gotcha 33; skeletons in `chart-skeletons.tsx` match the cards), every series spreading `SERIES_ANIMATION` (300 ms, no delay; a test checks), **no barrel `index.ts`**; every Recharts tooltip/cursor comes from `chart-theme.ts` + `chart-tooltip.tsx`, every pie legend from `LEGEND_BASE` there; every chart container spreads `chartAria(id)` (named by its card's h2 + description + arrow-key hint), every `<Pie>` has `rootTabIndex={-1}`, every `ChartCard` gets an `id` and a `table` (a lazy `<details>` "Data table" built with `lib/chart-table.ts`), and the tooltip reads its text into the card's polite live region through `ChartAnnounce` (a ref, no re-render — gotcha 33); `chart-theme.test.ts` checks all four; below `md` the charts get 12 px legends / 11 px ticks from a media block in `index.css`, the tab bar is one row of equal tabs, and Languages / Avg session switch to horizontal bars via `useIsMobile`), `components/game-thumb.tsx` (`lib/thumbnail.ts` → `/img/160|640/...` on the web, the original URL in Tauri), `components/legal-gate.tsx` (a non-dismissable Radix dialog **over** the page, so deep links land where they pointed; links flagged `inGate` in `lib/about.ts`; re-prompts when `LEGAL_VERSION` in `stores/prefs.ts` changes; no "Leave" button in Tauri).
|
||||
- Styling: **Tailwind v4** via `@tailwindcss/vite` (no PostCSS, no `tailwind.config`); tokens are hex CSS variables in `src/index.css` (`:root` / `.dark`, `@theme inline`; `--brand-soft`, `--thumb`, `--success`, `--scrollbar-thumb(-hover/-active)` besides the shadcn set) and must match the approved mockup — except where WCAG 2.2 AA needed more (4.6.0): `--primary` #6a48f5 (white text 5.44:1), `--primary-text` for purple text (#9a83ff in dark), `--input` #8a8a93 / #6b6b75 for field borders and the off switch (3:1), `--destructive-solid` for filled destructive buttons; `--brand` keeps the mockup's #7c5cff for the logo (as do the favicon, `og.png`, the app icons and the gate page's logo). `webapp/scripts/check-contrast.test.mjs` fails CI when a token pair or a chart colour (`components/charts/palette.ts`) drops below 4.5:1 (text) / 3:1 (borders, ring, chart marks); `lib/color.ts` does the maths. A `@media (forced-colors: active)` block gives selected tabs / pressed toggles / the current page / the active option and switches the system highlight (Windows contrast themes). Themed scrollbars (`@layer base`, only under `(hover: hover) and (pointer: fine) and (forced-colors: none)`): `::-webkit-scrollbar*` for Chromium/Safari, `scrollbar-color` / `scrollbar-width: thin` for Firefox only (gotcha 28); "Hide scrollbars" = unlayered `html[data-scrollbars='hidden']` rules (`hooks/useScrollbarsEffect.ts`). On mouse devices `<html>` reserves the scrollbar gutter, released while a dialog locks scrolling (gotcha 35). The theme: `stores/theme.ts` (synced across tabs, site ↔ admin), `hooks/useThemeEffect.ts` (`.dark` + the `theme-color` metas), an inline pre-paint script in both HTML entries (gotcha 34), and the display menu's button shows `components/theme-icon.ts`'s icon for the theme in use. Self-hosted Geist / Geist Mono (`@fontsource-variable/*`, CSP `font-src 'self'`). Numbers and dates go through `lib/format.ts` (`useFormat`: en-GB / vi-VN). `webapp/scripts/gen_assets.py` redraws favicon, PWA icons and `og.png` from the same tokens and the Geist fonts in `node_modules`.
|
||||
- `lib/gate.ts` (web only): when a tab comes back into view or a cover fails and the verification pass may have run out (`webapp.gate` hint), it asks `GET /api/verify` and reloads into the verification page; `lib/reload.ts` is the shared at-most-every-30-s reload guard.
|
||||
- `hooks/useSeoHead.ts` sets canonical + robots per route (index.html has no static canonical/og:url on purpose).
|
||||
- Accessibility (statement: root `ACCESSIBILITY.md`; target WCAG 2.2 AA): after an in-app navigation `App.tsx`'s ScrollManager moves focus to the new page's h1 (`lib/route-focus.ts` decides: not on first load or query-only changes; a #hash focuses its section; Back focuses the link last used on that entry), waiting for lazy routes with `components/focus-target.ts` (`whenPresent`, 10 s; `focusElement` adds `tabindex=-1` + `data-focus-target`, which hides the ring). Dialogs without a trigger return focus themselves (18+: the opener, `requestNsfw(returnFocus)`; legal gate: the page h1); menus that navigate `preventDefault` their `onCloseAutoFocus` (gotcha 46). The "/" shortcut is a pref (`slashShortcut`, Settings → Accessibility; WCAG 2.1.4). `CardTitle` renders an h2. `ExtLink` appends "(opens in a new tab)" / "(opens in your browser)" for screen readers. English-only strings shown on a Vietnamese page carry `lang="en"`; `<html lang>` turns `vi` only once the VI dictionary is in. `html { scroll-padding-top }` keeps focus clear of the sticky header. No a11y linter: `eslint-plugin-jsx-a11y` peers ESLint ≤ 9.
|
||||
- `lib/i18n/` — `en.ts` is the source of truth; `vi.ts` is `Record<MessageKey, string>` and must never be static-imported (lazy chunk).
|
||||
- `stores/` — Zustand: `prefs` (`webapp.prefs`: language, density, `hideScrollbars`, legal acceptance…), `theme` (`webapp.theme`).
|
||||
- `lib/about.ts` — keep `THIRD_PARTY` up to date when adding npm deps; `LEGAL_LINKS`; `APP.version`.
|
||||
- Code split (`vite.config.ts` rolldown `codeSplitting.groups`): `vendor-react` (priority 100 — must claim React first), `vendor-query`, `vendor-ui`. There is deliberately **no vendor-charts group** (it pulled React/clsx in and put Recharts on the first load); Recharts stays in the lazy chart chunks. Initial load ≈ 179 KB gzip (JS + CSS, gzip -9; 4.2 added ~4.6 KB for the pack loader, persister and `useQueries`) plus ~51 KB of Geist woff2; catalog data on a first visit ≈ 264 KB (main packs + log + history), descriptions ≈ 170 KB on demand. `fflate` is a lazy chunk, never preloaded. Web build `target` is Safari/iOS 15.4 (Radix class static blocks otherwise break iOS 15); Tauri uses the default.
|
||||
- Code split (`vite.config.ts` rolldown `codeSplitting.groups`): `vendor-react` (priority 100 — must claim React first), `vendor-query`, `vendor-ui`. There is deliberately **no vendor-charts group** (it pulled React/clsx in and put Recharts on the first load); Recharts stays in the lazy chart chunks. Initial load ≈ 189 KB gzip (JS + CSS, gzip -9, measured for 4.6.0; 4.2 added ~4.6 KB for the pack loader, persister and `useQueries`, 4.6 ~3 KB for focus management and the accessibility strings) plus ~51 KB of Geist woff2; catalog data on a first visit ≈ 264 KB (main packs + log + history), descriptions ≈ 170 KB on demand. `fflate` is a lazy chunk, never preloaded. Web build `target` is Safari/iOS 15.4 (Radix class static blocks otherwise break iOS 15); Tauri uses the default.
|
||||
|
||||
## Editable vs read-only fields
|
||||
|
||||
@@ -74,18 +78,20 @@ Each game has **20** fields (plus optional `added_at` / `updated_at`, appended b
|
||||
|
||||
| Workflow | Trigger | Notes |
|
||||
|---|---|---|
|
||||
| `update.yml` | Push to `main` touching `scripts/temp_link.json` + daily 01:23 UTC + `workflow_dispatch` (`url`) | Ingest queue → patch → `commit_push.sh`. Workflow-level `concurrency: ingest` with **`queue: max`** (the default queue replaces a pending run, which would drop its dispatched `url`). A dispatched `url` is processed first and written to `temp_link.json` (`queue_add`) until it reaches a final outcome. Failed fetches count as an attempt only ≥ 6 h apart (`last_attempt`; 3 → given up), and a 429 counts as none. GitHub-App pushes (extension, admin Worker) trigger it; its own `GITHUB_TOKEN` push does not (no loop). Keep the filename. |
|
||||
| `refresh.yml` | Daily 02:47 UTC + `workflow_dispatch` (`budget`, `url`, `allow_mass_removal`, `full`) | scan (read-only, 55-min step timeout, checks out the branch as it is when the job starts — not the queued SHA — so runs waiting in the queue see the previous run's state; patch artifact uploaded `if: always()`) → apply (`!cancelled()`: a failed / timed-out scan's checkpoint is applied, a cancelled run's is not) → notify. Workflow-level `concurrency: refresh-pipeline` + `queue: max` runs one whole scan → apply at a time (scheduled, manual and force-update runs alike). Removal needs the same 404/410 or paid strike seen again ≥ 20 h after the first sighting (`strike_at`). Checkpoints never carry removals. **Mass-change guard:** a run whose removals or new strikes exceed max(10, 10 %) of the games it checked withholds all its removals and marks them — and, on a strike spike, all its strikes — `withheld_at`; later runs keep withholding those (they take at most half a run's budget) until a healthy check clears them, and alert (`mass_change`) — that pattern means itch.io markup changed; dispatch with `allow_mass_removal` only after checking on itch.io. `apply_patch.py` re-checks the same per-run limit and max(25, 5 %) of the catalog unless `ALLOW_MASS_REMOVAL=1`. |
|
||||
| `update.yml` | Push to `main` touching `scripts/temp_link.json` + daily 01:23 UTC + `workflow_dispatch` (`url`) | Ingest queue → patch → `commit_push.sh`. Workflow-level `concurrency: ingest` with **`queue: max`** (the default queue replaces a pending run, which would drop its dispatched `url`). A dispatched `url` is processed first and written to `temp_link.json` (`queue_add`) until it reaches a final outcome. Failed fetches count as an attempt only ≥ 6 h apart (`last_attempt`; 3 → given up), and a 429 counts as none. GitHub-App pushes (the admin Worker and its cron) trigger it; its own `GITHUB_TOKEN` push does not (no loop). Keep the filename. |
|
||||
| `refresh.yml` | Daily 02:47 UTC + `workflow_dispatch` (`budget`, `url`, `allow_mass_removal`, `full`) | scan (read-only, 55-min step timeout, checks out the branch as it is when the job starts — not the queued SHA — so runs waiting in the queue see the previous run's state; patch artifact uploaded `if: always()`) → apply (`!cancelled()`: a failed / timed-out scan's checkpoint is applied, a cancelled run's is not) → notify. Workflow-level `concurrency: refresh-pipeline` + `queue: max` runs one whole scan → apply at a time (scheduled, manual and force-update runs alike). Removal needs the same 404/410, paid or `private` (itch.io's password form, `is_password_protected`; ingest drops such links as final) strike seen again ≥ 20 h after the first sighting (`strike_at`). Checkpoints never carry removals. **Mass-change guard:** a run whose removals or new strikes exceed max(10, 10 %) of the games it checked withholds all its removals and marks them — and, on a strike spike, all its strikes — `withheld_at`; later runs keep withholding those (they take at most half a run's budget) until a healthy check clears them, and alert (`mass_change`) — that pattern means itch.io markup changed; dispatch with `allow_mass_removal` only after checking on itch.io. `apply_patch.py` re-checks the same per-run limit and max(25, 5 %) of the catalog unless `ALLOW_MASS_REMOVAL=1`. |
|
||||
| `force_update.yml` | `workflow_dispatch` ONLY (`url`, `budget`, `allow_mass_removal`) | Dispatches `refresh.yml` with `full: true` (`actions: write`; it used to call it through `uses:`, which failed at startup with no annotation): re-scrapes every scraper field for one URL or the next batch (rotates on `full` timestamps). Dispatch it N times in a row to cover N consecutive batches (FIFO, each from the latest main). Always preserves `safe_virus` / `notes` / `nsfw`. Canonical tool for repairing mojibake. |
|
||||
| `notify-failure.yml` | `workflow_call` | Discord (`DISCORD_CI_WEBHOOK`) on failure / **cancelled** (job-level timeouts end as cancelled) / rate-limited / mass change / failed Cloudflare build. |
|
||||
| `python-ci.yml` / `webapp-ci.yml` | PRs (+ pushes for Python) | ruff + format + vulture + pytest + `validate.py` / `npm run cf:types -- --check` + lint + knip + vitest + build + `wrangler deploy --dry-run --env=""`. |
|
||||
| `python-ci.yml` / `webapp-ci.yml` | PRs (+ pushes for Python) | ruff + format + vulture + pytest + `validate.py` (both requirements locks installed at once, so drifting pins fail) / `npm ci --ignore-scripts` + `npm run check:tauri` (gotcha 31) + `npm run cf:types -- --check` + lint + knip + vitest + build + `npm run cf:check` (`wrangler deploy --dry-run`). SonarQube Cloud runs in `sonarcloud.yml`. |
|
||||
| `sonarcloud.yml` | Push to `main` + PRs (both skip data-only and `.md`-only changes) + `workflow_dispatch` | SonarQube Cloud CI analysis (gotcha 41): `token` (no `SONAR_TOKEN` — Dependabot and fork PRs — → notice, the rest skipped) → `coverage` (pytest-cov + Vitest v8, no secrets; artifact kept 1 day) → `scan` (`sonarqube-scan-action`, full history, `sonar.projectVersion` from `webapp/package.json`; the only step that uses the token). |
|
||||
| `qodana.yml` | Push to `main` + PRs (both skip data-only and `.md`-only changes) + `workflow_dispatch` | Qodana (JetBrains) analysis (gotcha 49): `tokens` (no Qodana secrets — Dependabot and fork PRs — → notice, the rest skipped) → three jobs, one per Qodana Cloud project and token: `typescript` (`qodana-js`, native, `webapp/qodana.yaml`), `python` (`qodana-python`, native, root `qodana.yaml`), `rust` (`qodana-rust`, Docker image, `webapp/src-tauri/qodana.yaml`). Whole-project scans (`pr-mode: false`), no PR comment; each `qodana.yaml` has a quality gate of 0 problems (`failureConditions`), so a finding fails its job. |
|
||||
| `deploy-status.yml` | Hourly + manual | Not a deploy. `bash/cf_build_status.sh` walks main's first-parent history to the latest finished `Workers Builds: free-games-itchio-list` check run (Cloudflare posts it only when a build ends; branch commits carry preview builds under the same name) and alerts once per failed build (cache key per check-run id, saved after the Discord post). Scheduled because GitHub never starts `check_run` workflows for `GITHUB_TOKEN` pushes (the data commits). |
|
||||
| `release_desktop.yml` | Tag `v*` push, or manual | `create-release` makes the single draft (id passed to tauri-action v1 `releaseId`); release builds use **no** npm/cargo caches (cache-poisoning). Win + macOS aarch64 + macOS x86_64 (cross-compile) + Linux (`ubuntu-22.04` for a low glibc floor). Uploads `.dmg` / `.app.tar.gz` / `.pkg` (macOS), `.msi` / `.exe` (Windows), `.deb` / `.rpm` / `.AppImage` (Linux). macOS `.pkg` `--identifier` reads `tauri.conf.json`. |
|
||||
| `release_android.yml` | Tag `v*` push, or manual | Tauri **Android** build → arm64-v8a APK, **post-signed** with `zipalign`+`apksigner` (gen/ stays gitignored). Tag → attaches to the same draft Release; manual dispatch → workflow artifact. Secrets: `ANDROID_KEYSTORE_BASE64` / `ANDROID_KEYSTORE_PASSWORD` / `ANDROID_KEY_ALIAS`. |
|
||||
| `announce-release.yml`, `notify-release-pipeline.yml` | Release published / pipeline runs | Reusable workflows from `poli0981/.github`, SHA-pinned — but at that pin they still check out their notifier script from that repo's `main`. |
|
||||
| `announce-discussion.yml` | Release published; push to `main` touching `CHANGELOG.md` / `changelog/**` | Local. The release goes to Discussions → Announcements, a changelog push to → General unless the head commit says `[skip-discuss]`. |
|
||||
|
||||
All workflows: `permissions: {}` at the top, per-job grants, actions pinned by commit SHA.
|
||||
All workflows: `permissions: {}` at the top, per-job grants, actions pinned by commit SHA. Python installs are hash-locked and wheels only (`pip install --require-hashes --only-binary :all:`, gotcha 40); npm installs skip install scripts (`npm ci --ignore-scripts` — esbuild's and workerd's launchers find their platform binary without them).
|
||||
|
||||
## Release / tag process
|
||||
|
||||
@@ -98,11 +104,11 @@ git push origin vX.Y.Z
|
||||
gh release edit vX.Y.Z --draft=false
|
||||
```
|
||||
|
||||
Draft-first: **never** `gh release create` by hand before CI — tauri-action v1 refuses to upload into a published release, and announcements would go out before installers exist. Merge PRs into `main` with squash or a merge commit, never by fast-forward pushing a branch: its commits' preview-build check runs would then sit on main's own line and confuse `deploy-status.yml`. Tag from `main` only. Release notes go to `changelog/<major>.x/ver<major>.<minor>.x.md` plus a row in the `CHANGELOG.md` index (each row keeps the anchor of the old single-file heading as `<a name>`: published release notes link to them). Versions live in `webapp/src/lib/about.ts` (`APP.version`), `webapp/package.json`, `webapp/src-tauri/tauri.conf.json` and `Cargo.toml` (+ `Cargo.lock`) — keep them equal. GPG signing is wired through gpg-agent (`commit.gpgsign=true`, so `git tag -s` and `git commit` both sign; the pinentry must be answered — in unattended sessions commits fail rather than going unsigned). The historical key `03F965C2E2DB5C6B` was exposed in the browser extension's storage (Sept 2026) and is being replaced — use the maintainer's current key.
|
||||
Draft-first: **never** `gh release create` by hand before CI — tauri-action v1 refuses to upload into a published release, and announcements would go out before installers exist. Merge PRs into `main` with squash or a merge commit, never by fast-forward pushing a branch: its commits' preview-build check runs would then sit on main's own line and confuse `deploy-status.yml`. Tag from `main` only. Release notes go to `changelog/<major>.x/ver<major>.<minor>.x.md` plus a row in the `CHANGELOG.md` index (each row keeps the anchor of the old single-file heading as `<a name>`: published release notes link to them). Versions live in `webapp/src/lib/about.ts` (`APP.version`), `webapp/package.json`, `webapp/src-tauri/tauri.conf.json` and `Cargo.toml` (+ `Cargo.lock`) — keep them equal. GPG signing is wired through gpg-agent (`commit.gpgsign=true`, so `git tag -s` and `git commit` both sign; the pinentry must be answered — in unattended sessions commits fail rather than going unsigned). Signing key since 2026-10-10: `838884804847BE7AE5FCF0A96AD1AB0921B96825` (ed25519 certify-only primary, generated locally and never published before; signing subkey `ED0BFD3005662D5D`; `user.signingkey` = the primary fingerprint, global + repo). The old key `03F965C2E2DB5C6B` is **revoked** (compromised: it sat in the browser extension's storage, Sept 2026); tags up to v4.3.0 and older commits carry it. The owner's offline backup and revocation certificates live outside the repo.
|
||||
|
||||
## Licenses & policies
|
||||
|
||||
Code **MIT** (`LICENSE`); catalog data **CC BY 4.0** for the maintainer's contribution — excluding creators' descriptions, cover images, names/trademarks (`data_game/LICENSE.md`, `LICENSES/CC-BY-4.0.txt`); docs **CC BY 4.0**; map + non-affiliation in `NOTICE.md`. Policies (EN in `docs/`, VI mirrors in `docs/i18n/vi/`, English controls): ToS (website + data + content removal), EULA (desktop/Android binaries only; also `webapp/src-tauri/installer/EULA.rtf`), Privacy Policy, Disclaimer, `SECURITY.md`, `CODE_OF_CONDUCT.md`. When a policy changes, bump `LEGAL_VERSION` (`webapp/src/stores/prefs.ts`) and the dates in `about.legal.desc` (EN/VI) so the legal gate asks again. Contact addresses `contact@ / legal@ / privacy@ / security@ / takedown@poli0981.dev` are aliases of the maintainer's Google Workspace mailbox (not Cloudflare Email Routing; the Privacy Policy lists Google as the email processor). The maintainer's site https://poli0981.dev/ and channel hub https://poli0981.dev/links/ are linked from the About page (`DEV` in `lib/about.ts`).
|
||||
Code **MIT** (`LICENSE`); catalog data **CC BY 4.0** for the maintainer's contribution — excluding creators' descriptions, cover images, names/trademarks (`data_game/LICENSE.md`, `LICENSES/CC-BY-4.0.txt`); docs **CC BY 4.0**; map + non-affiliation in `NOTICE.md`. Policies (EN in `docs/`, VI mirrors in `docs/i18n/vi/`, English controls): ToS (website + data + content removal), EULA (desktop/Android binaries only; also `webapp/src-tauri/installer/EULA.rtf`), Privacy Policy, Disclaimer, `SECURITY.md`, `CODE_OF_CONDUCT.md`. `ACCESSIBILITY.md` (root: GitHub's accessibility community health file; VI mirror `docs/i18n/vi/ACCESSIBILITY.md`) is a statement, not a policy to accept — no `LEGAL_VERSION` bump when it changes, but keep its §3 (what works) and §6 (known limitations) in step with the code; barriers come in through `.github/ISSUE_TEMPLATE/accessibility.yml` (label `accessibility`) or contact@. When a policy changes, bump `LEGAL_VERSION` (`webapp/src/stores/prefs.ts`) and the dates in `about.legal.desc` (EN/VI) so the legal gate asks again. Contact addresses `contact@ / legal@ / privacy@ / security@ / takedown@poli0981.dev` are aliases of the maintainer's Google Workspace mailbox (not Cloudflare Email Routing; the Privacy Policy lists Google as the email processor). The maintainer's site https://poli0981.dev/ and channel hub https://poli0981.dev/links/ are linked from the About page (`DEV` in `lib/about.ts`).
|
||||
|
||||
## Known gotchas (cost a release each — don't relearn)
|
||||
|
||||
@@ -111,7 +117,7 @@ Code **MIT** (`LICENSE`); catalog data **CC BY 4.0** for the maintainer's contri
|
||||
3. **Tauri icons must exist before build.** `npm run tauri icon -- path/to/source.png`; the 1024×1024 source is gitignored, generated icons are committed.
|
||||
4. **Tauri doesn't ship `.pkg`.** Built with `pkgbuild` after tauri-action and uploaded via `gh release upload`; the step uses `if: ${{ !cancelled() && … }}` so a DMG flake doesn't drop the PKG while a cancel still stops it.
|
||||
5. **Vite v8 `base`** only accepts `'./'`, an absolute URL, or an empty string. Web uses `'/'` (BrowserRouter deep links), Tauri `'./'`.
|
||||
6. **TS 6** deprecates `baseUrl`. Use `paths` alone. Stay on TS 6.0.x until typescript-eslint supports newer.
|
||||
6. **TypeScript 7 has no JS API (expected in 7.1), and typescript-eslint needs one** (peer `typescript <6.1`). So in `webapp/package.json` `typescript` is an alias of `@typescript/typescript6` (the 6.0 API for typescript-eslint and `scripts/i18n-edit.mjs`; bin `tsc6`) and TS 7 is `@typescript/native` (`npm:typescript@^7`), whose `tsc` is what `npm run build` / `npx tsc -b` run — `npx tsc --version` must say 7.x. Drop the alias once typescript-eslint accepts TS 7; never let Dependabot move the alias to 7. `baseUrl` is gone since TS 6: use `paths` alone.
|
||||
7. **lucide-react v1+** removed brand icons (`Github`). Use `Library`, `Database`, etc.
|
||||
8. **`bundle.windows.nsis.license` does NOT exist in `@tauri-apps/cli` 2.11** — use top-level `bundle.licenseFile`, and it must be **RTF** (WiX `.msi` requires it; NSIS auto-detects). File: `webapp/src-tauri/installer/EULA.rtf`.
|
||||
9. **The bundle `identifier` must be alphanumeric** (`com.poli0981.freegamesitchio`): Android rejects `-`, Tauri's validator rejects `_`; one identifier serves every platform.
|
||||
@@ -136,17 +142,68 @@ Code **MIT** (`LICENSE`); catalog data **CC BY 4.0** for the maintainer's contri
|
||||
28. **In Chromium 121+, `scrollbar-color` or `scrollbar-width` on an element switches its `::-webkit-scrollbar` styling off.** Keep the standard properties Firefox-only (`@supports not selector(::-webkit-scrollbar)`), except `scrollbar-width: none` for hiding.
|
||||
29. **Pack names are content hashes: the build must stay deterministic** (column and dictionary order, zlib level 9 — a Node/zlib upgrade only re-downloads once), **and no hash may reach the JS bundle** (data-only deploys keep JS byte-identical; the manifest is fetched, never imported). `_headers` joins a header set by two matching rules with a comma — give each path one `Cache-Control`.
|
||||
30. **itch.io shows the `Published` and `Updated` info rows only for a few weeks** after the event (every `Published` date in a 250-page sample of Oct 2026 was under four weeks old); an explicit `Release date` row stays. That is why `release_date` is N/A for most older games, and why a `--full` re-scrape keeps a known `release_date` / `thumbnail` instead of writing N/A (`KEEP_KNOWN_FIELDS` in `refresh.py`).
|
||||
31. **Tauri crates and their npm packages must share major.minor** (`tauri` ↔ `@tauri-apps/api`, `tauri-plugin-x` ↔ `@tauri-apps/plugin-x`): `tauri build` refuses to build otherwise, and only the release workflows run it — every v4.3.0 release build first failed on `tauri-plugin-opener` 2.6.0 vs `@tauri-apps/plugin-opener` 2.7.0 after Dependabot bumped the npm side alone (#119). Webapp CI's `npm run check:tauri` (`webapp/scripts/check-tauri-versions.mjs`, lock files only) now fails such a PR; Dependabot's cargo updates run weekly on Mondays like npm so both groups arrive together. Fix a one-sided bump with `cargo update -p <crate>` in `webapp/src-tauri/`.
|
||||
32. **Recharts hides category labels silently and styles legends its own way.** The default `interval="preserveEnd"` keeps a label only if its line box (font size × 1.5) plus `minTickGap` (5) fits its row, and the first one only if half of it fits above: the 15-row Genres chart showed 7 labels, without the two largest genres — category axes set `interval={0}`. A label wider than the axis wraps onto two lines, measured at the 16px body size unless `style` carries a size with a unit (`singleLineTick()` in `chart-theme.ts`). `<Legend>` sorts alphabetically (`itemSorter: 'value'`) and colours each label like its slice (amber/green text on white fails contrast) — pies spread `LEGEND_BASE`.
|
||||
33. **Recharts' ResponsiveContainer unmounts its chart when it measures 0×0** (`display: none`, e.g. Radix's `hidden` panel): a hidden tab must keep its size. The Charts page force-mounts visited tabs and hides the inactive ones with `absolute inset-x-0 top-0 h-0 overflow-hidden invisible` + `inert` (no scroll height, no focus); switching back otherwise rebuilt every chart and replayed its animation. Its panel elements are memoised, so a tab switch re-renders only the tab bar (a re-render restarts Recharts tweens).
|
||||
34. **The inline theme script's sha256 is in three CSPs**: `public/_headers`, `src-tauri/tauri.conf.json` and `THEME_SCRIPT_HASH` in `worker/admin.ts`. Change the script and `scripts/check-csp-hashes.test.mjs` fails with the hash to paste. A wrong hash only blocks the script (the old light flash). Keep `%` and `import(` out of it (Vite rewrites them in HTML).
|
||||
35. **`scrollbar-gutter: stable` vs dialogs**: fixed overlays stop at the reserved gutter, and react-remove-scroll-bar adds the scrollbar width as body margin on top. Hence `html:not(:has(> body[data-scroll-locked]))` — the gutter is released while a dialog locks scrolling, which is then exactly the old behaviour.
|
||||
36. **itch.io collection JSON** (`/c/<id>/<slug>?format=json&page=N`): `&page=1` redirects to the HTML page (page 1 has no `page`); a wrong or missing slug redirects to the canonical URL **without** the query string (re-request with the slug from `Location`); an unknown id answers 500; link attributes come in any order; past the last page `num_items` is 0. Zero cells while `num_items > 0` means changed markup: `collections.ts` reports it (422) and adds nothing.
|
||||
37. **D1 counts every statement of a batch** towards its 1,000 queries per invocation: bind URL lists in `IN (…)` slices of ≤ 90 (100 bound parameters at most), as `setStatus` / `reconcile` / `markIngested` do, never one statement per URL.
|
||||
38. **npm 11.20+ (Node 26) gates dependency install scripts on `allowScripts` in `webapp/package.json`.** esbuild and workerd are approved by name (their postinstall only checks the platform binary). A new dependency with an install script shows up in `npm install-scripts ls`; review it, then `npm install-scripts approve <pkg> --no-allow-scripts-pin` (name-only, so Dependabot bumps stay covered).
|
||||
39. **Dependabot's pip updater reads `.python-version` and aborts on a Python it doesn't support** (3.10–3.14 as of Oct 2026): a `3.15` there stopped pip version updates and the pip dependency graph ("Dependabot detected the following Python requirement … '3.15.*'"). So the CI pin lives in `.github/python-version`, which only `setup-python`'s `python-version-file` reads (python-ci, refresh ×2, update); move it back to `.python-version` once Dependabot lists 3.15.
|
||||
40. **The Python requirements are hash-locked pip-tools compiles** — `requirements.txt` ← `requirements.in`, `requirements-dev.txt` ← `requirements-dev.in` (`-c requirements.txt`) — installed everywhere with `--require-hashes --only-binary :all:`, so a new release of any dependency, indirect ones included, can't reach the jobs that push to `main`, and no sdist build script runs. After editing a `.in`, recompile with **pip-tools on Python 3.14**: `pip-compile --generate-hashes --allow-unsafe --strip-extras requirements.in`, then the same for `requirements-dev.in`. Dependabot takes the Python version from the `# … autogenerated by pip-compile with Python X.Y` header and supports ≤ 3.14 (gotcha 39); the hashes cover every file of a release, so CI's 3.15 still finds its cp315 wheels. `colorama` is listed in `requirements-dev.in` because pytest needs it on Windows only: a lock compiled on Linux (Dependabot's) would otherwise leave it out and the hash-checked local install would fail. Keep those pip commands in a block scalar (`run: |`): in a plain YAML scalar the `: ` of `:all: -r` makes the whole workflow file invalid — GitHub then records a 0-job failed push run named after the file, and a PR simply shows no check for that workflow.
|
||||
41. **SonarQube Cloud analyses in CI** (`sonarcloud.yml` + `sonar-project.properties`; project `poli0981_free-games-itchio-list`, public). Automatic Analysis is switched off on sonarcloud.io — switched back on, it makes the CI scan fail. PRs get a "SonarCloud Code Analysis" check from the SonarQube Cloud app; Dependabot and fork PRs get no `SONAR_TOKEN`, so their analysis is skipped with a notice (a Dependabot secret of that name would enable it). Tests run in the `coverage` job without the token; besides the `token` job's presence check, only the `scan` step gets it, in a job that runs no project code. Binary images and the D1 migrations (SQLite, claimed by the Oracle PL/SQL analyzer, which then warned on every run) are excluded from the analysis. Coverage: `pytest --cov` (`[tool.coverage.run]` in `pyproject.toml`) and `npm run test:coverage` (`test.coverage` in `vite.config.ts`; the lcov reporter's `projectRoot` is the repo root, so the scanner resolves the paths); `@vitest/coverage-v8` needs vitest's exact version (Dependabot group `vitest`). The built-in "Sonar way" gate fails a PR under 80 % coverage on new code (from 20 new lines up), so code without unit tests by design is in `sonar.coverage.exclusions` — keep that list in step with what the tests reach. `sonar.projectVersion` comes from `webapp/package.json`: on `main`, "new code" (previous version) starts over at each version bump. `sonar.python.version` stays 3.14 until SonarQube Cloud's analyzer supports 3.15 (it warns "No explicit support for version 3.15"). The free plan keeps only `main` and PRs: a manual run on another branch uploads a branch analysis nobody can open ("not allowed to access data from non main branches"). Mark a false positive on the issue itself. Two of its suggested fixes are wrong here: S2871 wants `localeCompare` in `.sort()`, but chunk names, migration files and `unblocked.json` keep code-unit order (= Python's `sorted()`) — pass `compareCodeUnits` (`worker/text.ts`); S8906 wants `select_one('div.a.b')` for bs4's `class_=[a, b]`, which means *either* class — write a selector list `div.a, div.b`. Trim trailing characters with `trimEnd()` (`worker/text.ts`), not `/x+$/` (S8786: quadratic backtracking on a long run). Known false positive: css:S8776 on Tailwind v4's `@utility … { &::-webkit-scrollbar … }` (the `&` is required for variants).
|
||||
42. **miniflare (wrangler's local runtime) pins `undici` exactly, so Dependabot can't fix an undici alert** until a wrangler release moves the pin. The stopgap is `overrides.undici` in `webapp/package.json` (4.4.3–4.5.0 carried `^7.30.1` over wrangler 4.152's 7.29.1; dropped with wrangler 4.156, whose miniflare pins 7.30.1). Only miniflare uses undici; nothing of it reaches the site, the Worker or the apps. Remove such an override once `npm ls undici` without it shows the fixed version, and before miniflare moves to a new undici major (the override would hold it back).
|
||||
43. **The Workers rate-limit binding counts per machine, not per data centre.** Measured on production right after the 4.5.0 deploy (CDG): 1,000 requests in 53 s, each `curl` on a new connection, against `RL_SITE` 120/60 s → **no 429 at all**; 200 requests on **one** keep-alive connection → 93 × 200, then 429s. A data centre has many machines, each counts locally and syncs late, so a client that keeps one connection (browsers over HTTP/2, scripts with keep-alive) is held to the limit, while one that opens a new connection per request is spread across machines and barely counted. The zone's WAF rule counts across the data centre: it is the limit that holds against floods. Test the Worker limits over one connection (`curl URL URL …` in one invocation, or `--next`), never with `xargs curl`; under `wrangler dev` (miniflare: one process) every request counts. The WAF rule (300 / 10 s, set 2026-10-27) needs > 30 requests a second, which `xargs curl` doesn't reach from a home line: use the runbook's Node `fetch` one-liner (800 requests in 4.9 s → 111 × 200, 201 × Worker 429, 488 × WAF 1015).
|
||||
|
||||
44. **Tailwind v4's `outline-hidden` adds a visible 2 px outline in forced-colours mode.** On a focus variant that is the point (inputs keep a system-coloured focus ring in Windows contrast themes); used unconditionally on a container (`<main tabIndex={-1}>`, the games list, popovers) it drew a permanent frame there. Containers use `outline-none`, fields `focus-visible:outline-hidden`.
|
||||
45. **Vitest stubs CSS imports — `./index.css?raw` is an empty string in tests.** A test that reads a stylesheet lives in `webapp/scripts/*.test.mjs` and uses `node:fs` (`check-contrast.test.mjs`; `src/` has no Node types).
|
||||
46. **Radix FocusScope gives focus back to the trigger in a `setTimeout` after unmount.** A link inside a menu or sheet that navigates would have focus pulled back to the menu button, away from the new page's h1: `SheetContent` / `PopoverContent` call `e.preventDefault()` in `onCloseAutoFocus` when the path changed. A modal opened without a Radix trigger (the 18+ dialog) drops focus to `<body>` unless `onCloseAutoFocus` focuses something. Radix 1.3.1 sets no `aria-modal` (it hides the rest with `aria-hidden`).
|
||||
47. **Name Recharts charts with `aria-labelledby`, not their `title` prop** (`title` also shows a native browser tooltip over the whole chart); `Treemap`'s props type has no `role`. A custom tooltip loses Recharts' live region, and the tooltip box is `visibility: hidden` while inactive, so announcements go through the card (`ChartAnnounce`).
|
||||
48. **The tool permissions refuse loading third-party code into the preview page** (an axe-core `<script>` from a CDN). Check pages with the browser's accessibility tree and DOM queries instead; Lighthouse / axe DevTools are for the owner's own browser.
|
||||
49. **Qodana takes one linter per Qodana Cloud project**, hence three projects (`itch-typescript` wwgZ1, `itch-python` GgGnX, `itch-rust` P2Rd7; team "My first team", public) and three secrets (`QODANA_TOKEN_TS_JS` / `_PYTHON` / `_RUST`). All three linters need an **Ultimate** licence (a trial in Nov 2026; the Rust linter is Early Access and its image carries its own evaluation licence, to 2027-01-10): when it ends the scans fail on the licence — renew, or delete `qodana.yml` and the three `qodana.yaml`. What the first runs cost: (a) **native `qodana-python` finds no interpreter by itself** (`SDKs.json` empty), and then calls every `X | None` an invalid type hint and a dataclass a class without `__init__` — the job builds `.venv` and passes `QODANA_PYTHON_PATH`; (b) **the `qodana-rust` image has no C linker and none of Tauri's system libraries, and its container runs as the runner's user**, who can't write the image's `CARGO_HOME` or `apt-get install` (`cargo metadata` / `cargo check` fail → "Cargo project loading" sanity problem, analysis degraded, `run` unresolved) — the job passes `-u root -e CARGO_HOME=/data/cache/cargo`, `webapp/src-tauri/qodana.yaml` installs the packages in `bootstrap`, and a stand-in `webapp/dist/index.html` lets `tauri::generate_context!()` expand; (c) `--project-dir <subdir> --repository-root .` is how a subdirectory project keeps its git data; (d) the default cache keys are the same for every job of a run — each job sets its own. `gh run view --log` returns nothing until the whole run has finished; the report (SARIF + IDE logs) is the `qodana-report-*` artifact, a zip inside the artifact. Inspections switched off on purpose are listed with their reason in `webapp/qodana.yaml` (throw-to-own-catch in Worker handlers, kept regex escapes, non-ASCII keys); deliberate uses of deprecated DOM APIs carry `// noinspection JSDeprecatedSymbols`. Recharts' `<Cell>` is deprecated (gone in 4.0): a pie slice's colour is the `fill` of its data entry (`paletteFills` in `components/charts/palette.ts`).
|
||||
|
||||
## Safe-edit rules
|
||||
|
||||
- Don't write `data_game/` from new code paths directly — go through a patch + `apply_patch.py` (or the Worker's `repo.ts`), so concurrent writers never clobber each other and `validate.py` gates every commit.
|
||||
- Don't commit `webapp/dist/`, `webapp/src-tauri/target/`, `webapp/src-tauri/gen/`, `webapp/src-tauri/icon-source.png`, `.dev.vars`, `username.txt`, `assets/qr/`. `Cargo.lock` **is** committed (since v4).
|
||||
- Never commit secrets (GitHub App key, admin emails, Turnstile secret, tokens). Data workflows push with the job's `GITHUB_TOKEN`; the Worker writes as the GitHub App.
|
||||
- When adding an npm dep, also add it to `webapp/src/lib/about.ts` so the About page lists it.
|
||||
- When adding an npm dep, also add it to `webapp/src/lib/about.ts` so the About page lists it. A Python dep goes into `requirements*.in`, then recompile the locks (gotcha 40).
|
||||
|
||||
## Current state (Oct 2026)
|
||||
## Current state (Nov 2026)
|
||||
|
||||
**v4.3.0** (2026-10-10): itch.io's newer info rows in the catalog — `ai_disclosure` / `ai_content` (generative-AI disclosure) and `accessibility` — on the game page, as `/games` filters (`ai`, `access`) and as charts (Overview: "Generative AI"; Discovery: "Accessibility Features", "What AI Was Used For"); `description` = the creator's tagline. Rolled out with a full re-scrape: after the merge, `force_update.yml` dispatched 6× (budget 600, one ~41-min batch each at ≈14.5 games/min, FIFO); the daily refresh fills the new fields in on its own within a week. A 250-page sample before the release: No AI 47 %, AI Assisted 10 %, not disclosed 43 %; accessibility listed on ≈20 % of games.
|
||||
**Maintenance mode since v4.6.1 (2026-11-11) — the owner's decision.** The project is stable and feature-complete. Work is limited to security fixes (CVEs), runtime / dependency updates (the weekly sweep) and repairs when the site or the data pipeline breaks; **no new features, redesigns or refactors**. Issues and PRs are accepted for the data only (add, fix, remove a game — README → Project status, CONTRIBUTING); accessibility barriers and security reports keep their channels (kept because ACCESSIBILITY.md §7 and SECURITY.md promise them). Feature requests and code PRs are closed without review. Don't propose features in this repo.
|
||||
|
||||
**v4.6.2** (2026-11-16, PR #195): dependency-only release — the 2026-11-16 sweep below. Released because wry 0.57.2 fixes Android crashes and a memory leak, macOS panics and a Windows focus issue, which reach the apps only through a release (web-only updates redeploy on merge and need none). The owner wants a deps-only release's notes short: one "Update deps:" list (changelog + GitHub release). README count 6,000+ (6,069 games that day). No policy change (`LEGAL_VERSION` unchanged).
|
||||
|
||||
**v4.6.1** (2026-11-11): maintenance mode + Qodana. Docs (EN + VI): "Project status" in the READMEs, CONTRIBUTING rewritten around the data-only scope, SECURITY note, runbook §2 step 5 (Qodana) and §4. Templates: `bug_report.yml` is now "Report a problem"; `feature_request.yml`, `feedback.yml`, `general_question.yml` and the PR templates `bug_fix.md`, `new_features.md`, `documentation.md` are deleted; the issue chooser links Discussions. README badges (status, Python CI, SonarQube quality gate + coverage, Qodana, WCAG target) and the game count (5,900+; 5,907 games that day). `qodana.yml` + three `qodana.yaml` (gotcha 49). Code changes are only the first Qodana findings: pie charts without `<Cell>`, `ElementRef` → `ComponentRef`, `FormEvent` → `SubmitEvent`, an awaited `res.json()`, three Python nits, the unused `serde_json` crate dropped from the Tauri shell. No policy change (`LEGAL_VERSION` unchanged).
|
||||
|
||||
**v4.6.0** (2026-11-09): accessibility. Root `ACCESSIBILITY.md` + VI mirror (the owner had tested the website and the Windows app with the keyboard only and Windows Narrator; this release fixed what a WCAG 2.2 AA review found; after it, the owner's VoiceOver test on a real iPhone 14 Pro in Safari, Chrome and Brave passed), the `accessibility.yml` issue form and labels `accessibility` / `feedback`, a default `.github/pull_request_template.md` (GitHub's community profile ignores `PULL_REQUEST_TEMPLATE/`). Code: focus management (route h1, Back to the used link, dialogs), the "/" shortcut switch, header search options / count, h2 card titles, `lang` marking, screen-reader text for counts / loading / new tabs, contrast tokens + `check-contrast.test.mjs`, forced-colours CSS, chart names / arrow-key announcements / data tables. Docs sync: dead `@freeitchgames.win` addresses in `data_game/LICENSE.md`, stale dates / VI revision notes / library versions, `check:tauri` in the check lists, the About page's removal link, `remove_game.yml` → label `delete-game`. Not done by choice: desktop zoom (`zoomHotkeysEnabled` off, `maximizable: false`, min 900×600 — a known limitation in the statement). No policy change (`LEGAL_VERSION` unchanged). Ships the two deps sweeps below.
|
||||
|
||||
**Deps sweeps since v4.5.0** (11-02 and 11-09 shipped in 4.6.0 — the catalog had 5,818 games on 2026-11-09 —, 11-16 in 4.6.2). Each combines the week's Dependabot PRs plus what Dependabot didn't open (its 5-PR limit, pip / actions / cargo), with the 3-day cooldown applied by hand to every ecosystem (cargo and actions have none in `dependabot.yml`):
|
||||
- 2026-11-02, PR #176: Dependabot #171–#175 (react-router 8.5.1, TanStack Query 5.105.0, lucide-react 1.64.0, knip 6.44.0, typescript-eslint 8.72.1, wrangler 4.156.0 + regenerated types), jose 6.2.14, `overrides.undici` dropped (gotcha 42), pytest 9.2.0 / Ruff 0.17.3, sonarqube-scan-action 8.4.0, `cargo update`.
|
||||
- 2026-11-09, PR #182: Dependabot #177–#181 (TanStack Query 5.106.1, vitest 5.1.0, vite 8.3.6, @vitejs/plugin-react 6.2.1, Tailwind 4.3.4, eslint 10.14.0, knip 6.44.1, wrangler 4.158.0 + regenerated types, jose 6.2.15, globals 17.14.0), lucide-react 1.69.0, soupsieve 4.0.1 (a major whose breaking changes only touch `<template>` / `<iframe>` contents), coverage 7.17.2 / Ruff 0.17.4, setup-java 6.2.0, sonarqube-scan-action 8.4.1, `cargo update` (wasm-bindgen 0.2.130 family …).
|
||||
- 2026-11-16, PR #195: Dependabot #190–#194 (TanStack Query 5.107.1, @tauri-apps/plugin-opener 2.7.3, Tailwind 4.3.5, @vitejs/plugin-react 6.3.0, knip 6.45.1, typescript-eslint 8.72.2, vite 8.3.8, wrangler 4.161.0 + regenerated types, jose 6.2.17, lucide-react 1.72.0), zustand 5.1.0 (`persist` still hydrates sync storage synchronously; `rehydrate()` now returns a `Promise`), soupsieve 4.1 / coverage 7.17.3 / Ruff 0.17.5, `cargo update` (wry 0.57.2 — it pulls `dom_query` 0.29 next to tauri-utils' 0.28 —, tauri-plugin-opener 2.7.3; brotli, bumpalo, cc, ctor, jiff, mio held at older versions by the cooldown); transitive npm bumps checked too (tapable 2.3.4 held at 2.3.3 in the lock; `npm audit signatures` all verified). Held for the next sweep: eslint 10.15.0, eslint-plugin-react-refresh 0.5.8, lucide-react 1.73.0, wrangler 4.162.0, soupsieve 4.1.1, sonarqube-scan-action 8.5.0, setup-java 6.3.0. Rust stable 1.100.0 (2026-11-12) is what the release builds now get (`toolchain: stable`).
|
||||
|
||||
Node 26.13.1 (LTS; the 2026-11-11 security release — http2 / TLS server fixes) with its npm 11.20.0 is current: CI and Workers Builds follow `.node-version` / `NODE_VERSION` `26` by themselves; only local installs need upgrading.
|
||||
|
||||
`npm audit`: 9 moderate, all minimatch < 11.0.1 (GHSA-g3hv-75wg-m249) under eslint / typescript-eslint — dev-only, no fix until they accept minimatch 11. `cargo audit`: 0 vulnerabilities, 5 upstream warnings. Security settings unchanged: CodeQL default setup not configured, Dependabot security updates off; 0 open alerts, SonarQube Cloud 0 issues.
|
||||
|
||||
**v4.5.0** (2026-10-27): rate limits for the whole site — `worker/ratelimit.ts` + `RL_SITE` / `RL_IMG` / `RL_ADMIN`, every namespace moved to 8801–8806 / staging 8901–8906 (account-wide ids; 1001 / 1003 were shared with other Workers), the 429 page, admin wording, `docs/operations.md` §1 step 15 (the WAF rule: `not cf.client.bot`, not `/assets/` or `/data/pack/`, 300 requests / 10 s, block 10 s — set by the owner in the dashboard). No policy change (`LEGAL_VERSION` unchanged; SECURITY.md EN + VI describe the limits).
|
||||
|
||||
**v4.4.3** (2026-10-26): dependency and security updates only — the week's npm updates (Dependabot #159–#163 in one PR, plus lucide-react / Zustand; `knip` kept at 6.42.1 by the 3-day cooldown), wrangler 4.152 with regenerated `worker-configuration.d.ts` (a wrangler bump fails `cf:types -- --check` until it is regenerated — why Dependabot's build-tooling PR failed), `overrides.undici` (gotcha 42), zod 4.6.7, `cargo update` (tauri 2.12.5, tokio 1.54.1; `cargo audit`: 0 vulnerabilities, 5 upstream warnings — glib, zbus family, proc-macro-error), certifi / coverage / Ruff via pip-tools on 3.14, `actions/setup-python` 7.1.0. Repository security state that day: CodeQL default setup **not configured** (last analyses May 2026, 0 open alerts), Dependabot **security updates disabled** in Settings (version updates run), secret scanning + push protection on, SonarQube Cloud gate OK with 0 issues.
|
||||
|
||||
**SonarQube Cloud CI** (2026-10-22, shipped in 4.4.3's notes): CI-based analysis with test coverage replaced Automatic Analysis — `sonarcloud.yml`, `sonar-project.properties` (tests marked as tests, coverage exclusions, `.sonarcloud.properties` removed), `pytest-cov` + `@vitest/coverage-v8` (gotcha 41).
|
||||
|
||||
**Toolchain** (2026-10-22, #149 + #154, shipped in 4.4.2): TypeScript 7.0.2 (`@typescript/native`; `typescript` = the 6.0 API alias, gotcha 6), Node 26 (`webapp/.node-version`, `engines >=26`, `@types/node` 26, Workers Builds `NODE_VERSION` raised to 26 by the owner in the dashboard — `docs/operations.md` §1 step 1), Python 3.15 (`.github/python-version` — gotcha 39, ruff `py315`, `urllib3` declared since `scraper.py` imports it). No source change was needed: TS 7 reports 0 errors, the suites pass on Node 26.12 and Python 3.15.1.
|
||||
|
||||
**v4.4.2** (2026-10-22): SonarQube Cloud cleanup — the scan's 57 issues: 45 fixed in code, the 11 on the saved itch.io test pages excluded by `.sonarcloud.properties`, css:S8776 (Tailwind `@utility`) left for the owner to mark a false positive (gotcha 41). Worker paths and the gate cookie's padding are trimmed by `trimEnd()` (a `/\/+$/` on the public 404 path was quadratic), the feed / collection parsers have no backtracking regexes left, `compareCodeUnits` makes the code-unit sorts explicit, the NSFW notices are one selector list (each tested). Supply chain: hash-locked Python deps + wheels only in every workflow (gotcha 40), `npm ci --ignore-scripts` in CI and the release builds, `npm run cf:check` instead of `npx wrangler`. `scripts/i18n-edit.mjs` reads its operations from stdin (`node scripts/i18n-edit.mjs < ops.json`). Ships the toolchain upgrade and Dependabot #141–#148, #150, #152, #153.
|
||||
|
||||
**v4.4.1** (2026-10-16): the browser extension and the Telegram bot are retired — both repos (`poli0981/itch-f2p-extension`, `poli0981/telegram-scraper-bot`) were already public archives; an Announcements discussion says so. Removed: `POST /api/ingest` (`ingest.ts`, `requireService`, `RL_INGEST`, `ACCESS_AUD_INGEST`, the idempotency store — it never received a game: 0 `ext` rows in production D1), the admin's "Browser extension" auto-approve source and "Extension" label, the About page's Telegram numeric-ID note. The policies (Privacy, ToS, EULA + installer RTF, Disclaimer, Security; EN + VI) only lost the extension / ingest wording: "Last updated" 2026-10-16, `LEGAL_VERSION` deliberately unchanged (nothing new to accept, ToS §14). Unused repo secrets `GH_TOKEN`, `TELEGRAM_BOT_TOKEN`, `DISCUSSION_*` deleted. Ships Dependabot #131 (vite 8.3.4), #135 (tauri crates), #136 (serde_json), #137 (ruff).
|
||||
|
||||
**v4.4.0** (2026-10-13, PR #133): admin automation. Add page: any text / file / itch.io collection → **Check** (dry run) → batches of 200 → per-game ingest tracking (`/api/admin/track`, from the new `scripts/state/ingest_outcomes.json`). The cron runs the maintainer's automatic rules in one `[auto]` commit: auto-approve (on by default, `rss` + `form`, unflagged, after 24 h, only items found after the `since` baseline, ≤ 100 a run) and **followed collections** (≤ 30 pages a run; never-seen unflagged free games queued directly, removed or flagged ones to review). Bulk remove / edit ≤ 100 in one commit (preset reasons translated on the Removed page), New games, Activity, Settings; queue batches of 200. D1 migration `0002_automation.sql` applied to production before the merge. Policies rewritten for approval by rules (ToS §5, Privacy §2.3/§2.4, Disclaimer §4, EN + VI; `LEGAL_VERSION` 2026-10-13). Web: the theme button shows the theme in use (a v4 regression), a pre-paint theme script (no dark flash; hash in three CSPs), Charts tabs kept mounted (switching back reuses every chart, no replayed animation), 300 ms entrances, scrollbar gutter. Also ships #130 (2026-10-11, the Charts page on phones: one-row tab bar, 12 px legends / 11 px ticks, horizontal Languages / Avg session bars, all 15 Genre labels, data-order pie legends, translated removal reasons, locale axis numbers).
|
||||
|
||||
**v4.3.0** (2026-10-10, PR #117; released the same day): itch.io's newer info rows in the catalog — `ai_disclosure` / `ai_content` (generative-AI disclosure) and `accessibility` — on the game page, as `/games` filters (`ai`, `access`) and as charts (Overview: "Generative AI"; Discovery: "Accessibility Features", "What AI Was Used For"); `description` = the creator's tagline. The whole catalog was re-scraped the same day with `force_update.yml` (6 × 600 + 10, ≈14.5 games/min; an itch.io outage ~05:20–06:50Z only cost retries): 3,236 of 3,251 games carry the new fields — No AI 53 %, AI Assisted 11 %, not disclosed 36 %; accessibility on 14 % (Subtitles 257, One button 119); the other 15 are 14 dead-page strikes awaiting confirmation and one password-protected page (`everium.itch.io/underthethorns`; it failed every check until #129 taught the refresh to strike such pages). Fixed on the way, same day: #118 (`force_update.yml` had never worked in v4 — it now dispatches `refresh.yml`, whose scan reads the latest main so queued batches rotate), #119 (`tauri-plugin-opener` 2.7: every first v4.3.0 release build had failed; the tag was moved before publishing), #120 (the 5 open Dependabot alerts; `check:tauri` CI guard; weekly cargo Dependabot), then Dependabot #122–#127.
|
||||
|
||||
**v4.2.0** (2026-10-03, PR #103): catalog packs + lazy descriptions (first visit ≈ 264 KB instead of ≈ 520 KB), compressed IndexedDB cache, `/data/*.json` only for apps 4.0–4.1.1 (410 + repository links for everyone else), `/img` cache fixes, themed scrollbars + "Hide scrollbars", policies (`LEGAL_VERSION` 2026-10-03: data reuse goes through the repository). Checked on the live site the same day: TLS 1.2/1.3 only, HSTS preload header (domain not on the preload list), Cloudflare compression already on (zstd/br), Smart Tiered Cache on but irrelevant here (`docs/operations.md` §1 step 12).
|
||||
|
||||
@@ -154,4 +211,4 @@ Code **MIT** (`LICENSE`); catalog data **CC BY 4.0** for the maintainer's contri
|
||||
|
||||
**v4.1.0** (2026-09-24): the Turnstile verification gate for the web app, readable chart tooltips, the changelog split into `changelog/`, a docs refresh, updated Privacy/ToS/EULA (`LEGAL_VERSION` 2026-09-24). The gate ships switched on in `wrangler.jsonc` but stays inert until `GATE_BOT_TOKEN`, the Transform Rule and `GATE_SECRET` are in place (`docs/operations.md` §1 step 14) — `curl -s https://freeitchgames.win/api/verify` says `"enabled"`.
|
||||
|
||||
**v4.0.0** (2026-09-18) moved the site to the Cloudflare Worker at https://freeitchgames.win (PRs #81, #82, #88). The whole chain is live: Access for `/admin`, the GitHub App (verified commits to `scripts/temp_link.json` → `update.yml`), Turnstile, `ADMIN_EMAILS`; D1 `freeitchgames`, R2 `freeitchgames-thumbs`, Image Transformations (source `img.itch.zone`); Web Analytics is injected by the zone. `/api/ingest` stays unused — the browser extension is archived. **Still open (owner):** the legal-text review items; a new GPG signing key (commits are still signed with the exposed `03F965C2E2DB5C6B`); deleting the unused repo secrets `GH_TOKEN`, `TELEGRAM_BOT_TOKEN`, `DISCUSSION_*`.
|
||||
**v4.0.0** (2026-09-18) moved the site to the Cloudflare Worker at https://freeitchgames.win (PRs #81, #82, #88). The whole chain is live: Access for `/admin`, the GitHub App (verified commits to `scripts/temp_link.json` → `update.yml`), Turnstile, `ADMIN_EMAILS`; D1 `freeitchgames`, R2 `freeitchgames-thumbs`, Image Transformations (source `img.itch.zone`); Web Analytics is injected by the zone. **Still open (owner):** the legal-text review items; add the new GPG key's public half on GitHub (until then new signatures show Unverified) and remove the revoked `03F965C2E2DB5C6B` there; delete the Zero Trust Access app "Ingest" and its service token (unused since 4.4.1).
|
||||
+42
-31
@@ -2,9 +2,17 @@
|
||||
|
||||
Thanks for even thinking about contributing to this random repo! I'm just an unemployed, introvert Vietnamese dev with mediocre skills and two non-judgmental AI buddies: **Grok (xAI)** for the late-night brainstorming and **Claude Code (Anthropic)** for the heavier code/docs work. This list survives on community help, because I'm too lazy to hunt/fix everything alone :D Any contribution (even one game) makes you a legend.
|
||||
|
||||
## Project Status: Stable, Maintenance Only
|
||||
|
||||
Since version 4.6.1 (2026-11-11) the project is **stable and in maintenance mode**. It is feature-complete: the website, the apps and the data pipeline keep running, and the catalog keeps updating itself.
|
||||
|
||||
- **Still done by the Maintainer**: security fixes (CVEs and reports made through [SECURITY.md](SECURITY.md)), runtime and dependency updates, and repairs when something stops the site or the daily data updates from working.
|
||||
- **Not done any more**: new features, redesigns, refactors.
|
||||
- **Issues and pull requests are accepted for the data only**: adding games (section 1), fixing a game's data or removing a game (sections 2 and 3). Accessibility barriers (section 3) and security reports keep their own channels. Anything else is closed without review; no hard feelings.
|
||||
|
||||
## How to Contribute (Use the Right Door, I'm Lazy ;D)
|
||||
|
||||
Games go through the website; everything else goes through the GitHub issue/PR templates. They make my life easier and reduce "wtf" moments.
|
||||
Games go through the website; data fixes and removals go through the GitHub issue templates or email. They make my life easier and reduce "wtf" moments.
|
||||
|
||||
### 1. Suggest New Games (Most Welcome!)
|
||||
|
||||
@@ -12,16 +20,17 @@ Games go through the website; everything else goes through the GitHub issue/PR t
|
||||
- Optional: a short note (why it's good, content warnings…), up to 500 characters. Notes are deleted after 180 days. Please don't put personal data in it.
|
||||
- A Cloudflare Turnstile check and a rate limit keep bots out; if you get blocked, wait a bit and try again.
|
||||
- Only **free** itch.io games. Paid games are dropped automatically when the game page is scraped.
|
||||
- Nothing goes live instantly: every suggestion lands in a **review queue**, and nothing enters the catalog until the Maintainer approves it. Approved links are then scraped by the data pipeline and show up on the site after the next deploy.
|
||||
- The game must be playable or downloadable **on its itch.io page itself** (a browser build or an uploaded file). A page that only points to a launcher or a download on another site doesn't qualify, even when that is free: the [Disclaimer](docs/DISCLAIMER.md) tells visitors that any download happens on itch.io.
|
||||
- Nothing goes live instantly: every suggestion lands in a **review queue**, where the Maintainer approves or rejects it, by hand or through automatic rules (a suggestion without a warning flag that nobody rejected within about a day may be approved automatically). Approved links are then scraped by the data pipeline and show up on the site after the next deploy.
|
||||
|
||||
Got a whole list? The **[Add Games (bulk list)]** issue template takes up to 15 links at once, and a PR that adds itch.io URLs to `scripts/temp_link.json` works too (use the [Add Games] PR template). Both go through the same review: the Maintainer checks every link before it is queued, and merging such a PR is the approval. Please don't edit `data_game/` by hand: the pipeline owns those files (see [section 7](#7-submit-code-changes-pr)).
|
||||
Got a whole list? The **[Add Games (bulk list)]** issue template takes up to 15 links at once, and a PR that adds itch.io URLs to `scripts/temp_link.json` works too (use the [Add Games] PR template). Both go through the same review: the Maintainer checks every link before it is queued, and merging such a PR is the approval. Please don't edit `data_game/` by hand: the pipeline owns those files (see [section 7](#7-pull-requests)).
|
||||
|
||||
#### 1b. Other ways games get in
|
||||
|
||||
- The Maintainer's companion browser extension ([itch-f2p-extension](https://github.com/poli0981/itch-f2p-extension), separate repo, GPL-3.0) sends links through an authenticated API while browsing itch.io. It is the Maintainer's own tool, not a public submission channel.
|
||||
- The site reads itch.io's public RSS feeds of new and popular free games every 4 hours (one feed per run) and queues what it finds.
|
||||
- The site also reads the public itch.io collections the Maintainer follows and queues their new free games directly (one removed before, or with a warning flag, goes to the review queue instead).
|
||||
|
||||
Both land in the same review queue as the Suggest page. (The old Telegram bot path is retired.)
|
||||
The RSS feeds land in the same review queue as the Suggest page. (The Maintainer's browser extension and the old Telegram bot are retired; their repositories, [itch-f2p-extension](https://github.com/poli0981/itch-f2p-extension) and [telegram-scraper-bot](https://github.com/poli0981/telegram-scraper-bot), are archived.)
|
||||
|
||||
### 2. Remove Games or Fix Their Data
|
||||
|
||||
@@ -31,56 +40,58 @@ Game creators especially: if you want your game off the list, or its data correc
|
||||
- Include the game URL, who you are (the creator / rights holder, or someone authorized by them) and the reason.
|
||||
- The Maintainer removes the record from the catalog (logged with a reason on the public [removed-games page](https://freeitchgames.win/removed)) and deletes the resized cover copies the site stores; cached copies expire on their own. Target: within 7 days, urgent legal requests sooner.
|
||||
- Heads-up: this is a public git repo, so past versions stay in its history. Rewriting public history is only done in exceptional cases of legal necessity.
|
||||
- Wrong `safe_virus` / `nsfw` / notes, or other data errors that aren't a removal? A **[Bug Report]** issue is fine too.
|
||||
- Wrong `safe_virus` / `nsfw` / notes, or other data errors that aren't a removal? Use the **[Report a problem]** issue template (section 3).
|
||||
|
||||
Details live in the [Terms of Use](docs/ToS.md) and the [Disclaimer](docs/DISCLAIMER.md).
|
||||
|
||||
### 3. Report Bugs
|
||||
### 3. Report a Problem (Wrong Data, Something Broke)
|
||||
|
||||
- Open an issue → **[Bug Report]** template.
|
||||
- Checkboxes for common bugs (dead links, wrong flags, broken page, etc.).
|
||||
- Open an issue → **[Report a problem]** template ([direct link](https://github.com/poli0981/free-games-itchio-list/issues/new?template=bug_report.yml)).
|
||||
- It is for **data errors** (dead link, wrong name, genre, tags, cover, `nsfw` or `safe_virus` flag…) and for **things that broke** (a page or an app that stopped working, the catalog no longer updating). It is not for ideas: see section 4.
|
||||
- Details + screenshots + urgency level.
|
||||
- **Security problems are not bugs for the public tracker.** Report them privately: see [SECURITY.md](SECURITY.md).
|
||||
- If it's complex, see "Discuss More" below.
|
||||
- **Security problems are not for the public tracker.** Report them privately: see [SECURITY.md](SECURITY.md).
|
||||
- **Accessibility barriers** (keyboard, screen reader, zoom, contrast, motion…): use the **[Accessibility barrier]** template ([direct link](https://github.com/poli0981/free-games-itchio-list/issues/new?template=accessibility.yml)), or email contact@poli0981.dev if you'd rather not use GitHub. What happens next is in [ACCESSIBILITY.md](ACCESSIBILITY.md#7-reporting-an-accessibility-barrier).
|
||||
|
||||
### 4. Suggest Features or Improvements
|
||||
### 4. Features and Improvements (Closed)
|
||||
|
||||
- Open an issue → **[Feature Request / Improvement]** template.
|
||||
- Choose type (new feature or code fix), name, reason, priority (from "nice to have" to "repo dying").
|
||||
- Optional: pseudo-code/snippet (no malware pls, I'll check with my average skills :D).
|
||||
- The project is in maintenance mode: **feature requests, improvement ideas and code changes are no longer accepted**. Such issues and pull requests are closed without review.
|
||||
- The code is MIT-licensed: you're welcome to fork it and build your own thing ([README → License](README.md#license)).
|
||||
|
||||
### 5. Give Feedback
|
||||
### 5. Feedback, Questions, Anything Else
|
||||
|
||||
- Use the **[Feedback]** template.
|
||||
- Checkboxes (EULA/ToS too strict? Repo concept bad? Anti-AI? Delete repo? Other).
|
||||
- Roast or praise, my self-loathing can handle it.
|
||||
- Use **[GitHub Discussions](https://github.com/poli0981/free-games-itchio-list/discussions)**, the Discord servers or email (see "Discuss More" below). Roast or praise, my self-loathing can handle it.
|
||||
- They are read, but they don't turn into new features (section 4).
|
||||
|
||||
### 6. Anything Else (Questions, Memes, Off-Topic)
|
||||
### 6. Dependencies and Security Fixes
|
||||
|
||||
- Use the **[General / Off-Topic]** template.
|
||||
- Drop whatever's on your mind.
|
||||
- Dependency updates are handled by Dependabot and the Maintainer's weekly sweep: please don't send version-bump PRs.
|
||||
- Found a vulnerability? Report it privately ([SECURITY.md](SECURITY.md)); the Maintainer makes the fix.
|
||||
|
||||
### 7. Submit Code Changes (PR)
|
||||
### 7. Pull Requests
|
||||
|
||||
- Fork → branch → code → open a PR against `main` with the matching PR template ([Bug Fix], [New Feature], [Documentation]…).
|
||||
- Clear description, please. I'll review slowly (unemployed schedule + AI buddies).
|
||||
- **Accepted**: a PR that adds itch.io URLs to `scripts/temp_link.json` (use the [Add Games] PR template). Merging it is the Maintainer's approval.
|
||||
- **Not accepted**: everything else (code, UI, docs, refactors). Fixing or removing a game's data goes through an issue or email (sections 2 and 3), because the pipeline owns `data_game/`.
|
||||
- The rules below still apply to every PR, the Maintainer's own included.
|
||||
|
||||
**PR rules** (the non-negotiable part):
|
||||
|
||||
- **CI must pass.** Python CI (ruff check + format, vulture, pytest, `validate.py`) and Webapp CI (type generation check, lint, knip, tests, build, `wrangler deploy --dry-run`) both run on PRs. Red CI = no merge.
|
||||
- **CI must pass.** Python CI (ruff check + format, vulture, pytest, `validate.py`) and Webapp CI (Tauri crate/npm version check, type generation check, lint, knip, tests, build, `wrangler deploy --dry-run`) both run on PRs. Red CI = no merge. SonarQube Cloud also analyses each PR (with test coverage) and reports its quality gate as the "SonarCloud Code Analysis" check, and Qodana (JetBrains) analyses the TypeScript / JavaScript, Python and Rust code. Both skip PRs from forks, which get no repository secrets.
|
||||
- **PRs are merged with squash** (one PR becomes one commit on `main`) **or a merge commit, never by fast-forward**, so make the PR title a good commit message (the repo uses the `type(scope): summary` style, e.g. `fix(web): …`).
|
||||
- **Licensing is inbound = outbound.** By opening a PR you agree that your contribution is licensed under the same license as the part it changes: **MIT** for code, **CC BY 4.0** for catalog data and documentation (see [README → License](README.md#license)). Only submit work you have the right to submit.
|
||||
- **Never commit secrets**: no tokens, API keys, `.dev.vars` / `.env` files, private keys (such as the GitHub App key) or signing keystores. If you pushed one by accident, report it privately (security@poli0981.dev) and rotate it; deleting the commit is not enough.
|
||||
- **Don't edit `data_game/` by hand.** Data changes go through the pipeline (a patch + `apply_patch.py`, which runs `validate.py`), so concurrent writers never clobber each other.
|
||||
- Don't commit build output or generated files: `webapp/dist/`, `webapp/.wrangler/`, `webapp/src-tauri/target/`, `webapp/src-tauri/gen/`. (`webapp/src-tauri/Cargo.lock` **is** committed; keep it in sync when you change `Cargo.toml`.)
|
||||
- Adding an npm dependency? Also add it to the `THIRD_PARTY` list in `webapp/src/lib/about.ts` so the About page credits it.
|
||||
- New external link in the app? Use `<ExtLink href="…">` from `webapp/src/components/ext-link.tsx`, not a plain `<a href="…" target="_blank">`: plain anchors work on the web but silently break in the Tauri apps.
|
||||
- New external link in the app? Use `<ExtLink href="…">` from `webapp/src/components/ext-link.tsx`, not a plain `<a href="…" target="_blank">`: plain anchors work on the web but silently break in the Tauri apps (and ExtLink tells screen readers the link opens a new tab).
|
||||
- **Accessibility**: UI changes keep working with the keyboard alone and with screen readers, and keep the contrast ratios (`npm test` checks the colours). The checklist is in [ACCESSIBILITY.md → For contributors](ACCESSIBILITY.md#8-for-contributors) and in the pull request template.
|
||||
|
||||
### 8. Dev Setup (Summary)
|
||||
|
||||
For forks, and for the Maintainer's own maintenance work.
|
||||
|
||||
Full instructions (Worker, local D1, secrets, Tauri, Android) are in **[`docs/dev_env.md`](docs/dev_env.md)**; the Tauri/Android build notes are in [`webapp/TAURI.md`](webapp/TAURI.md). The short version:
|
||||
|
||||
**Python pipeline** (Python 3.14, see `.python-version`):
|
||||
**Python pipeline** (Python 3.15, see `.github/python-version`):
|
||||
|
||||
```sh
|
||||
python -m venv .venv
|
||||
@@ -96,7 +107,7 @@ To try a real scrape locally: add a URL to `scripts/temp_link.json`, then run
|
||||
`python scripts/update_info.py --out patch.json` and `python scripts/apply_patch.py patch.json`
|
||||
(don't commit the result; see the PR rules above).
|
||||
|
||||
**Webapp + Worker** (Node.js 22.22+, CI uses the version in `webapp/.node-version`):
|
||||
**Webapp + Worker** (Node.js 26+, CI uses the version in `webapp/.node-version`):
|
||||
|
||||
```sh
|
||||
cd webapp
|
||||
@@ -122,12 +133,12 @@ npm run tauri:build # installers in src-tauri/target/release/bundle/
|
||||
- **Test locally**: run the checks from section 8 before pushing; CI runs the same ones.
|
||||
- **Keep it clean**: only free itch.io games, no paid/demo/malware/duplicates.
|
||||
- **Be patient**: I'm introvert + lazy, replies might be slow.
|
||||
- **Agreement**: all issue templates have a required checkbox. Off-topic/spam/policy violations get ignored/closed without drama :D
|
||||
- **Agreement**: all issue templates have a required checkbox. Off-topic/spam/policy violations, and anything outside the maintenance scope above, get ignored/closed without drama :D
|
||||
- **Be cool**: everything here falls under the [Code of Conduct](CODE_OF_CONDUCT.md).
|
||||
|
||||
## Discuss More? (If Templates Aren't Enough)
|
||||
|
||||
Issues/PRs are best for tracking, but if you wanna describe bugs/features in depth, chit-chat, or share noob stories, there are actual servers now (introvert god-mode breached):
|
||||
Issues are best for tracking data problems, but if you wanna chit-chat, ask something, or share noob stories, there are [GitHub Discussions](https://github.com/poli0981/free-games-itchio-list/discussions) and actual servers now (introvert god-mode breached):
|
||||
|
||||
**Chat / community**
|
||||
- Discord: Repo discussion (#general): https://discord.gg/2aNR3aVt
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# Notice
|
||||
|
||||
Last updated: 2026-09-29
|
||||
Last updated: 2026-10-16
|
||||
|
||||
Applies from: the release of version 4.0.0.
|
||||
|
||||
@@ -45,7 +45,7 @@ The process is described in the [Terms of Use](docs/ToS.md).
|
||||
| **Catalog data** | `data_game/`, `scripts/deleted_games.json`, and the files built from them under <https://freeitchgames.win/data> | CC BY 4.0, for the Maintainer's contribution only. Creator descriptions, cover images, game names and trademarks are **excluded** | [`data_game/LICENSE.md`](data_game/LICENSE.md), [`LICENSES/CC-BY-4.0.txt`](LICENSES/CC-BY-4.0.txt) |
|
||||
| **Documentation** | `*.md` files in the repository root and in `docs/` (README, policies, guides and their Vietnamese translations) | CC BY 4.0 | [`LICENSES/CC-BY-4.0.txt`](LICENSES/CC-BY-4.0.txt) |
|
||||
| **Third-party components** | Libraries, frameworks and tools the project uses | Their own licenses | [`docs/THIRD_PARTY.md`](docs/THIRD_PARTY.md) and the [About page](https://freeitchgames.win/about) |
|
||||
| **Browser extension** | [poli0981/itch-f2p-extension](https://github.com/poli0981/itch-f2p-extension), a separate repository | GPL-3.0 | That repository |
|
||||
| **Browser extension** (archived) | [poli0981/itch-f2p-extension](https://github.com/poli0981/itch-f2p-extension), a separate repository, archived and no longer used | GPL-3.0 | That repository |
|
||||
|
||||
When you reuse the documentation, credit poli0981 (SkullMute), link to this repository and to CC BY 4.0,
|
||||
and say if you changed it. For the data, use the credit line in
|
||||
|
||||
@@ -1,22 +1,42 @@
|
||||
# Free Itch.io Games List
|
||||
|
||||
[](https://github.com/poli0981/free-games-itchio-list/releases/latest)
|
||||
[](https://github.com/poli0981/free-games-itchio-list/releases/latest)
|
||||
[](#project-status)
|
||||
[](https://freeitchgames.win)
|
||||
[](https://github.com/poli0981/free-games-itchio-list/stargazers)
|
||||
[](https://github.com/poli0981/free-games-itchio-list/network/members)
|
||||
[](https://github.com/poli0981/free-games-itchio-list/commits/main)
|
||||
[](https://github.com/poli0981/free-games-itchio-list/actions/workflows/python-ci.yml)
|
||||
[](https://sonarcloud.io/summary/new_code?id=poli0981_free-games-itchio-list)
|
||||
[](https://sonarcloud.io/summary/new_code?id=poli0981_free-games-itchio-list)
|
||||
[](https://github.com/poli0981/free-games-itchio-list/actions/workflows/qodana.yml)
|
||||
[](ACCESSIBILITY.md)
|
||||
[](LICENSE)
|
||||
[](data_game/LICENSE.md)
|
||||
[](README.vi.md)
|
||||
|
||||
> 🇻🇳 Tiếng Việt: see [`README.vi.md`](README.vi.md). Vietnamese translations of the policy docs live in [`docs/i18n/vi/`](docs/i18n/vi/). The English versions in this repo remain controlling for legal interpretation.
|
||||
|
||||
A curated, auto-updating catalog of **2,600+ free games on [itch.io](https://itch.io)**. Browse it at
|
||||
A curated, auto-updating catalog of **6,000+ free games on [itch.io](https://itch.io)**. Browse it at
|
||||
**<https://freeitchgames.win>**: search, filter, sort, and jump to any game's itch.io page. The site is
|
||||
read-only for everyone: no accounts, no sign-in, no comments, no ads, no payments.
|
||||
|
||||
## Project status
|
||||
|
||||
**Stable, maintenance only** (since version 4.6.1, 2026-11-11). The project is feature-complete: the
|
||||
website, the apps and the data pipeline keep running, and the catalog keeps updating itself every day.
|
||||
|
||||
- **What still happens**: security fixes (CVEs and reports made through [SECURITY.md](SECURITY.md)),
|
||||
runtime and dependency updates (Node.js, Python, Rust, npm / pip / cargo packages, GitHub Actions),
|
||||
and repairs when something stops the site or the daily data updates from working.
|
||||
- **What no longer happens**: new features, redesigns and refactors. Feature requests and code
|
||||
pull requests are closed without review.
|
||||
- **Issues and pull requests are for the data only**: adding games, fixing a game's data, removing a
|
||||
game. See [Contributing](#contributing).
|
||||
|
||||
## Table of contents
|
||||
|
||||
- [Project status](#project-status)
|
||||
- [Browse the catalog](#browse-the-catalog)
|
||||
- [Desktop and Android apps](#desktop-and-android-apps)
|
||||
- [Add a game](#add-a-game)
|
||||
@@ -45,6 +65,10 @@ Everything lives on the website, **<https://freeitchgames.win>**:
|
||||
- **18+ content is hidden by default.** Games flagged `nsfw: Yes` stay hidden (covers included) unless
|
||||
you opt in under Settings after confirming you are 18 or older. That choice is stored only in your
|
||||
browser.
|
||||
- **Made for every way of browsing.** Everything works with the keyboard alone and with screen readers,
|
||||
colours meet the WCAG contrast ratios in both themes, every chart has a data table, and the site
|
||||
follows your system's reduced-motion and contrast settings. What works, the known gaps and how to
|
||||
report a barrier: [ACCESSIBILITY.md](ACCESSIBILITY.md).
|
||||
|
||||
Every link goes to the game's own page on itch.io. Cover images on the website are resized copies served
|
||||
by freeitchgames.win, so your browser does not contact itch.io until you click a link.
|
||||
@@ -93,20 +117,26 @@ still gets security hardening and that we actually test on (≈87% of active dev
|
||||
|
||||
## Add a game
|
||||
|
||||
There are three ways a game gets into the catalog. **All three go through a review queue**: nothing is
|
||||
added until the Maintainer approves it.
|
||||
There are three ways a game gets into the catalog. Each is approved by the Maintainer, one by one in the
|
||||
review queue or through automatic rules the Maintainer sets.
|
||||
|
||||
1. **Suggest page**: <https://freeitchgames.win/suggest>. Paste an itch.io game link and, if you like, a
|
||||
short note (up to 500 characters; notes are deleted after 180 days). A Cloudflare Turnstile check and a
|
||||
rate limit keep spam out. Please don't put personal data in the note.
|
||||
2. **Browser extension**: the Maintainer's own
|
||||
[itch-f2p-extension](https://github.com/poli0981/itch-f2p-extension) (separate repo, GPL-3.0) sends
|
||||
links through an authenticated API while browsing itch.io.
|
||||
3. **Automatic discovery**: every 4 hours the site reads one of itch.io's public RSS feeds of new and
|
||||
2. **Automatic discovery**: every 4 hours the site reads one of itch.io's public RSS feeds of new and
|
||||
popular free games (one feed per run) and queues what it finds.
|
||||
3. **Followed collections**: the site also reads the public itch.io collections the Maintainer follows and
|
||||
queues their new free games directly (one removed before, or with a warning flag, goes to the review
|
||||
queue instead).
|
||||
|
||||
The Maintainer reviews the queue in a private admin area (protected by Cloudflare Access). Approved links
|
||||
are handed to the data pipeline, which scrapes each game page; paid games are dropped.
|
||||
The Maintainer's browser extension and the old Telegram bot are retired; their repositories
|
||||
([itch-f2p-extension](https://github.com/poli0981/itch-f2p-extension),
|
||||
[telegram-scraper-bot](https://github.com/poli0981/telegram-scraper-bot)) are archived.
|
||||
|
||||
The Maintainer reviews the queue in a private admin area (protected by Cloudflare Access); an item
|
||||
without a warning flag that nobody rejected within a waiting time (24 hours by default) is approved
|
||||
automatically. Approved links are handed to the data pipeline, which scrapes each game page; paid games
|
||||
are dropped.
|
||||
|
||||
Prefer GitHub, or have a long list? The "Add Games (bulk list)" issue template works too; those links go
|
||||
through the same review. See [CONTRIBUTING.md](CONTRIBUTING.md#1-suggest-new-games-most-welcome).
|
||||
@@ -120,9 +150,9 @@ Details: [Terms of Use](docs/ToS.md) and [Disclaimer](docs/DISCLAIMER.md).
|
||||
## How the data stays fresh
|
||||
|
||||
```
|
||||
Suggest page ──┐
|
||||
Extension ──┼─→ review queue ─→ Maintainer approves ─→ scripts/temp_link.json
|
||||
RSS feeds ──┘ (admin) │
|
||||
Suggest page ──┬─→ review queue ─→ Maintainer approves ─→ scripts/temp_link.json
|
||||
RSS feeds ──┘ (admin, or auto rules) │
|
||||
Followed collections ─────────────────────────────────────────┤
|
||||
▼
|
||||
update.yml → update_info.py (new games) ──┐
|
||||
refresh.yml → refresh.py (1/7 per day) ──┴─→ patch ─→ apply_patch.py
|
||||
@@ -156,14 +186,14 @@ The pipeline is polite to itch.io: it identifies itself as
|
||||
- **Web app** ([`webapp/src/`](webapp/src/)): React + TypeScript + Vite + Tailwind CSS, TanStack
|
||||
Query, React Router, Zustand. English and Vietnamese UI.
|
||||
- **Cloudflare Worker** ([`webapp/worker/`](webapp/worker/)): serves the site and `/data`, the verification gate
|
||||
(Cloudflare Turnstile), the image proxy (`/img`, resized WebP covers stored on Cloudflare R2), the Suggest and ingest APIs, the review queue
|
||||
(Cloudflare Turnstile), the image proxy (`/img`, resized WebP covers stored on Cloudflare R2), the Suggest API, the review queue
|
||||
(Cloudflare D1), the admin API and the RSS discovery schedule. Config:
|
||||
[`webapp/wrangler.jsonc`](webapp/wrangler.jsonc).
|
||||
- **Admin app** ([`webapp/admin/`](webapp/admin/)): the Maintainer-only review screen at `/admin`, behind
|
||||
Cloudflare Access. It writes to this repo as a GitHub App.
|
||||
- **Native shell** ([`webapp/src-tauri/`](webapp/src-tauri/)): Tauri 2 for Windows, macOS, Linux and
|
||||
Android. See [`webapp/TAURI.md`](webapp/TAURI.md).
|
||||
- **Data pipeline** ([`scripts/`](scripts/), Python 3.14): scraper, refresh, patch/apply and validation,
|
||||
- **Data pipeline** ([`scripts/`](scripts/), Python 3.15): scraper, refresh, patch/apply and validation,
|
||||
run by GitHub Actions.
|
||||
|
||||
Deploys happen through Cloudflare Workers Builds (root dir `webapp`, `npm run build`, then
|
||||
@@ -225,10 +255,11 @@ docs/ # Policies, dev environment, third-party list (+ Vietnam
|
||||
| Job | Schedule | Purpose |
|
||||
|---|---|---|
|
||||
| Ingest (`update.yml`) | On queue change + daily 01:23 UTC | Scrape approved links from `temp_link.json`, skip paid / dead / removed |
|
||||
| Refresh (`refresh.yml`) | Daily 02:47 UTC | Re-check 1/7 of the catalog: dead links, now-paid games, rating, status |
|
||||
| Refresh (`refresh.yml`) | Daily 02:47 UTC | Re-check 1/7 of the catalog: dead links, now-paid or password-protected games, rating, status |
|
||||
| Force update (`force_update.yml`) | Manual | Re-scrape every field (one URL or the next batch); keeps `safe_virus` / `notes` / `nsfw` |
|
||||
| RSS discovery (Cloudflare Worker) | Every 4 hours | Poll one itch.io feed per run; new games go to the review queue |
|
||||
| RSS discovery and automatic rules (Cloudflare Worker) | Every 4 hours | Poll one itch.io feed per run into the review queue; auto-approve unflagged items after the waiting time; queue new free games of followed collections |
|
||||
| Python CI / Webapp CI | Pull requests (Python CI also on pushes to `main` that touch it) | Lint, tests, data validation / type-check, tests, build |
|
||||
| Code analysis (`sonarcloud.yml`, `qodana.yml`) | Pull requests and pushes to `main` that change code | SonarQube Cloud (with test coverage) and Qodana (TypeScript / JavaScript, Python, Rust) |
|
||||
| Deploy website | On push to `main` | Cloudflare Workers Builds (`webapp/wrangler.jsonc`) → freeitchgames.win |
|
||||
| Build monitor (`deploy-status.yml`) | Hourly | Posts each failed Workers Build of `main` to Discord, once |
|
||||
| Release desktop / Android | On `v*` tag push | Tauri installers (Win/macOS/Linux) and signed APK → draft Release |
|
||||
@@ -279,8 +310,13 @@ See [CONTRIBUTING.md](CONTRIBUTING.md) for the full guide.
|
||||
- **Add games**: use the [Suggest page](https://freeitchgames.win/suggest).
|
||||
- **Remove a game / fix its data**: email takedown@poli0981.dev or open a
|
||||
["Remove a game" issue](https://github.com/poli0981/free-games-itchio-list/issues/new?template=remove_game.yml).
|
||||
- **Report bugs**: use the "Bug Report" issue template.
|
||||
- **Request features**: use the "Feature Request / Improvement" template, or send a PR.
|
||||
- **Report a problem**: wrong data, a dead link, or something broken on the site or in the apps: use the
|
||||
"Report a problem" issue template.
|
||||
- **Accessibility barriers**: use the ["Accessibility barrier" issue template](https://github.com/poli0981/free-games-itchio-list/issues/new?template=accessibility.yml) or email
|
||||
contact@poli0981.dev. See [ACCESSIBILITY.md](ACCESSIBILITY.md).
|
||||
- **Features and code changes**: not accepted any more, the project is in
|
||||
[maintenance mode](#project-status). Questions and feedback are welcome in
|
||||
[Discussions](https://github.com/poli0981/free-games-itchio-list/discussions).
|
||||
- **Security issues**: report them privately, never in a public issue. See [SECURITY.md](SECURITY.md).
|
||||
- **Privacy questions**: see the [Privacy Policy](docs/PrivacyPolicy.md) or email privacy@poli0981.dev.
|
||||
- Please follow the [Code of Conduct](CODE_OF_CONDUCT.md).
|
||||
@@ -328,8 +364,9 @@ Free itch.io games catalog by poli0981 (SkullMute) — https://freeitchgames.win
|
||||
```
|
||||
|
||||
Third-party components keep their own licenses: see [`docs/THIRD_PARTY.md`](docs/THIRD_PARTY.md) and the
|
||||
site's About page. The browser extension is a separate repo under GPL-3.0. Contributions are accepted under
|
||||
the same license as the part they change (inbound = outbound): MIT for code, CC BY 4.0 for data and docs.
|
||||
site's About page. The archived browser extension is a separate repo under GPL-3.0. Contributions are
|
||||
accepted under the same license as the part they change (inbound = outbound): MIT for code, CC BY 4.0 for
|
||||
data and docs.
|
||||
|
||||
**Not affiliated with itch.io.** This is an independent fan project. It is not affiliated with, endorsed by,
|
||||
or sponsored by itch.io, Leaf Corcoran or itch corp. "itch.io" and all game names, logos and trademarks
|
||||
@@ -343,6 +380,7 @@ belong to their respective owners.
|
||||
- [EULA](docs/EULA.md): covers the desktop and Android apps only
|
||||
- [Code of Conduct](CODE_OF_CONDUCT.md)
|
||||
- [Security Policy](SECURITY.md)
|
||||
- [Accessibility statement](ACCESSIBILITY.md): what works with assistive technology, known gaps, how to report a barrier
|
||||
- [NOTICE](NOTICE.md)
|
||||
|
||||
Contact (the Maintainer's own mailbox on poli0981.dev):
|
||||
|
||||
+38
-17
@@ -1,22 +1,37 @@
|
||||
# Danh sách Game Itch.io Miễn Phí
|
||||
|
||||
[](https://github.com/poli0981/free-games-itchio-list/releases/latest)
|
||||
[](https://github.com/poli0981/free-games-itchio-list/releases/latest)
|
||||
[](#trạng-thái-dự-án)
|
||||
[](https://freeitchgames.win)
|
||||
[](https://github.com/poli0981/free-games-itchio-list/stargazers)
|
||||
[](https://github.com/poli0981/free-games-itchio-list/network/members)
|
||||
[](https://github.com/poli0981/free-games-itchio-list/commits/main)
|
||||
[](https://github.com/poli0981/free-games-itchio-list/actions/workflows/python-ci.yml)
|
||||
[](https://sonarcloud.io/summary/new_code?id=poli0981_free-games-itchio-list)
|
||||
[](https://sonarcloud.io/summary/new_code?id=poli0981_free-games-itchio-list)
|
||||
[](https://github.com/poli0981/free-games-itchio-list/actions/workflows/qodana.yml)
|
||||
[](docs/i18n/vi/ACCESSIBILITY.md)
|
||||
[](LICENSE)
|
||||
[](data_game/LICENSE.md)
|
||||
[](README.md)
|
||||
|
||||
> Bản dịch từ bản tiếng Anh cập nhật ngày 2026-09-24 (English source revision 2026-09-24). Nếu có khác biệt, bản tiếng Anh được ưu tiên.
|
||||
> Bản dịch từ bản tiếng Anh cập nhật ngày 2026-11-11 (English source revision 2026-11-11). Nếu có khác biệt, bản tiếng Anh được ưu tiên.
|
||||
>
|
||||
> Bản tiếng Anh tại [`README.md`](README.md) là bản chính thức. Bản dịch tiếng Việt của các tài liệu chính sách nằm trong [`docs/i18n/vi/`](docs/i18n/vi/).
|
||||
|
||||
Một danh mục được tuyển chọn và tự động cập nhật gồm **hơn 2,600 game miễn phí trên [itch.io](https://itch.io)**. Duyệt tại **<https://freeitchgames.win>**: tìm kiếm, lọc, sắp xếp và mở thẳng trang itch.io của bất kỳ game nào. Website chỉ để xem, với tất cả mọi người: không tài khoản, không đăng nhập, không bình luận, không quảng cáo, không thanh toán.
|
||||
Một danh mục được tuyển chọn và tự động cập nhật gồm **hơn 6,000 game miễn phí trên [itch.io](https://itch.io)**. Duyệt tại **<https://freeitchgames.win>**: tìm kiếm, lọc, sắp xếp và mở thẳng trang itch.io của bất kỳ game nào. Website chỉ để xem, với tất cả mọi người: không tài khoản, không đăng nhập, không bình luận, không quảng cáo, không thanh toán.
|
||||
|
||||
## Trạng thái dự án
|
||||
|
||||
**Ổn định, chỉ bảo trì** (từ phiên bản 4.6.1, 2026-11-11). Dự án đã đủ tính năng: website, các ứng dụng và pipeline dữ liệu vẫn chạy, danh mục vẫn tự cập nhật mỗi ngày.
|
||||
|
||||
- **Những gì vẫn được làm**: vá bảo mật (CVE và báo cáo gửi qua [SECURITY](docs/i18n/vi/SECURITY.md)), cập nhật runtime và thư viện phụ thuộc (Node.js, Python, Rust, gói npm / pip / cargo, GitHub Actions), và sửa khi có gì đó làm website hoặc việc cập nhật dữ liệu hằng ngày ngừng chạy.
|
||||
- **Những gì không còn làm**: tính năng mới, thiết kế lại, refactor. Đề xuất tính năng và pull request về code sẽ bị đóng mà không review.
|
||||
- **Issue và pull request chỉ dành cho dữ liệu**: thêm game, sửa dữ liệu của một game, gỡ game. Xem [Đóng góp](#đóng-góp).
|
||||
|
||||
## Mục lục
|
||||
|
||||
- [Trạng thái dự án](#trạng-thái-dự-án)
|
||||
- [Duyệt danh mục](#duyệt-danh-mục)
|
||||
- [Ứng dụng desktop và Android](#ứng-dụng-desktop-và-android)
|
||||
- [Thêm game](#thêm-game)
|
||||
@@ -39,6 +54,7 @@ Mọi thứ nằm trên website **<https://freeitchgames.win>**:
|
||||
- **Đã gỡ** (Removed): mọi game bị loại khỏi danh mục, kèm lý do (<https://freeitchgames.win/removed>).
|
||||
- **Kiểm tra nhanh trước.** Lần đầu vào, rồi khoảng mỗi 48 giờ, trang sẽ chạy một bước kiểm tra Cloudflare Turnstile ngắn để chặn bot. Thường nó tự qua rồi mở đúng trang bạn cần. Dữ liệu trong `/data` và các ứng dụng không cần bước này.
|
||||
- **Nội dung 18+ bị ẩn theo mặc định.** Game được đánh dấu `nsfw: Yes` sẽ bị ẩn (kể cả ảnh bìa) trừ khi bạn tự bật trong Settings sau khi xác nhận mình đủ 18 tuổi. Lựa chọn đó chỉ được lưu trong trình duyệt của bạn.
|
||||
- **Dành cho mọi cách duyệt web.** Mọi thứ dùng được chỉ với bàn phím và với trình đọc màn hình, màu sắc đạt tỉ lệ tương phản WCAG ở cả hai giao diện, mỗi biểu đồ có bảng dữ liệu, và site làm theo thiết lập giảm chuyển động và tương phản của hệ thống. Những gì đã hỗ trợ, các hạn chế đã biết và cách báo rào cản: [Trợ năng](docs/i18n/vi/ACCESSIBILITY.md) ([EN](ACCESSIBILITY.md)).
|
||||
|
||||
Mọi link đều dẫn tới trang riêng của game trên itch.io. Ảnh bìa trên website là bản thu nhỏ do freeitchgames.win phục vụ, nên trình duyệt của bạn không kết nối tới itch.io cho tới khi bạn bấm vào một link.
|
||||
|
||||
@@ -71,13 +87,15 @@ Lưu ý: **chỉ arm64-v8a** (mọi điện thoại từ ~2017; không hỗ tr
|
||||
|
||||
## Thêm game
|
||||
|
||||
Có ba cách để một game vào danh mục. **Cả ba đều đi qua hàng chờ duyệt**: không có gì được thêm cho tới khi Maintainer duyệt.
|
||||
Có ba cách để một game vào danh mục. Mỗi game đều được Maintainer duyệt, từng game một trong hàng chờ duyệt hoặc qua các quy tắc tự động do Maintainer đặt ra.
|
||||
|
||||
1. **Trang Suggest**: <https://freeitchgames.win/suggest>. Dán link game itch.io và, nếu muốn, một ghi chú ngắn (tối đa 500 ký tự; ghi chú bị xóa sau 180 ngày). Một bước kiểm tra Cloudflare Turnstile và giới hạn tần suất giúp chặn spam. Vui lòng không ghi dữ liệu cá nhân vào ghi chú.
|
||||
2. **Extension trình duyệt**: [itch-f2p-extension](https://github.com/poli0981/itch-f2p-extension) của chính Maintainer (repo riêng, GPL-3.0) gửi link qua một API có xác thực trong lúc duyệt itch.io.
|
||||
3. **Tự động phát hiện**: cứ 4 giờ một lần, website đọc một trong các RSS feed công khai của itch.io về game miễn phí mới và phổ biến (mỗi lượt một feed) rồi đưa những gì tìm được vào hàng chờ.
|
||||
2. **Tự động phát hiện**: cứ 4 giờ một lần, website đọc một trong các RSS feed công khai của itch.io về game miễn phí mới và phổ biến (mỗi lượt một feed) rồi đưa những gì tìm được vào hàng chờ.
|
||||
3. **Collection được theo dõi**: website cũng đọc các collection công khai trên itch.io mà Maintainer theo dõi và đưa thẳng game miễn phí mới của chúng vào hàng chờ ingest (game từng bị gỡ, hoặc có cờ cảnh báo, thì vào hàng chờ duyệt).
|
||||
|
||||
Maintainer duyệt hàng chờ trong một khu vực quản trị riêng (được bảo vệ bởi Cloudflare Access). Link được duyệt sẽ được chuyển cho pipeline dữ liệu, pipeline này cào từng trang game; game trả phí bị loại.
|
||||
Extension trình duyệt của Maintainer và Telegram bot cũ đã ngừng hoạt động; repo của chúng ([itch-f2p-extension](https://github.com/poli0981/itch-f2p-extension), [telegram-scraper-bot](https://github.com/poli0981/telegram-scraper-bot)) đã được lưu trữ (archive).
|
||||
|
||||
Maintainer duyệt hàng chờ trong một khu vực quản trị riêng (được bảo vệ bởi Cloudflare Access); mục không có cờ cảnh báo mà không ai từ chối trong thời gian chờ (mặc định 24 giờ) được duyệt tự động. Link được duyệt sẽ được chuyển cho pipeline dữ liệu, pipeline này cào từng trang game; game trả phí bị loại.
|
||||
|
||||
Thích dùng GitHub hơn, hoặc có cả một danh sách dài? Issue template "Add Games (bulk list)" cũng dùng được; các link đó đi qua cùng quy trình duyệt. Xem [CONTRIBUTING](docs/i18n/vi/CONTRIBUTING.md#1-đề-xuất-game-mới-hoan-nghênh-nhất).
|
||||
|
||||
@@ -86,9 +104,9 @@ Muốn **gỡ** một game, hoặc sửa dữ liệu của nó (nhất là các
|
||||
## Dữ liệu được cập nhật thế nào
|
||||
|
||||
```
|
||||
Trang Suggest ─┐
|
||||
Extension ─┼─→ hàng chờ duyệt ─→ Maintainer duyệt ─→ scripts/temp_link.json
|
||||
RSS feed ─┘ (admin) │
|
||||
Trang Suggest ─┬─→ hàng chờ duyệt ─→ Maintainer duyệt ─→ scripts/temp_link.json
|
||||
RSS feed ─┘ (admin, hoặc quy tắc tự động) │
|
||||
Collection theo dõi ──────────────────────────────────────────┤
|
||||
▼
|
||||
update.yml → update_info.py (game mới) ──┐
|
||||
refresh.yml → refresh.py (1/7 mỗi ngày) ──┴─→ patch ─→ apply_patch.py
|
||||
@@ -108,10 +126,10 @@ Pipeline cư xử lịch sự với itch.io: nó tự xưng danh là `FreeItchGa
|
||||
## Bên trong dự án
|
||||
|
||||
- **Web app** ([`webapp/src/`](webapp/src/)): React + TypeScript + Vite + Tailwind CSS, TanStack Query, React Router, Zustand. Giao diện tiếng Anh và tiếng Việt.
|
||||
- **Cloudflare Worker** ([`webapp/worker/`](webapp/worker/)): phục vụ website và `/data`, cổng xác minh (Cloudflare Turnstile), proxy ảnh (`/img`, ảnh bìa WebP đã thu nhỏ lưu trên Cloudflare R2), API Suggest và ingest, hàng chờ duyệt (Cloudflare D1), API quản trị và lịch phát hiện qua RSS. Cấu hình: [`webapp/wrangler.jsonc`](webapp/wrangler.jsonc).
|
||||
- **Cloudflare Worker** ([`webapp/worker/`](webapp/worker/)): phục vụ website và `/data`, cổng xác minh (Cloudflare Turnstile), proxy ảnh (`/img`, ảnh bìa WebP đã thu nhỏ lưu trên Cloudflare R2), API Suggest, hàng chờ duyệt (Cloudflare D1), API quản trị và lịch phát hiện qua RSS. Cấu hình: [`webapp/wrangler.jsonc`](webapp/wrangler.jsonc).
|
||||
- **App quản trị** ([`webapp/admin/`](webapp/admin/)): màn hình duyệt chỉ dành cho Maintainer tại `/admin`, đứng sau Cloudflare Access. Nó ghi vào repo này dưới danh nghĩa một GitHub App.
|
||||
- **Vỏ native** ([`webapp/src-tauri/`](webapp/src-tauri/)): Tauri 2 cho Windows, macOS, Linux và Android. Xem [`webapp/TAURI.md`](webapp/TAURI.md).
|
||||
- **Pipeline dữ liệu** ([`scripts/`](scripts/), Python 3.14): scraper, refresh, patch/apply và validate, chạy bằng GitHub Actions.
|
||||
- **Pipeline dữ liệu** ([`scripts/`](scripts/), Python 3.15): scraper, refresh, patch/apply và validate, chạy bằng GitHub Actions.
|
||||
|
||||
Việc deploy do Cloudflare Workers Builds đảm nhận (thư mục gốc `webapp`, `npm run build`, rồi `npx wrangler deploy`): mỗi lần push vào `main` sẽ tự động lên site.
|
||||
|
||||
@@ -170,10 +188,11 @@ docs/ # Chính sách, môi trường dev, danh sách bên th
|
||||
| Tác vụ | Lịch | Mục đích |
|
||||
|---|---|---|
|
||||
| Ingest (`update.yml`) | Khi hàng chờ đổi + hằng ngày 01:23 UTC | Cào link đã duyệt từ `temp_link.json`, bỏ qua game trả phí / đã chết / từng bị gỡ |
|
||||
| Refresh (`refresh.yml`) | Hằng ngày 02:47 UTC | Kiểm tra lại 1/7 danh mục: link chết, game chuyển sang trả phí, rating, trạng thái |
|
||||
| Refresh (`refresh.yml`) | Hằng ngày 02:47 UTC | Kiểm tra lại 1/7 danh mục: link chết, game chuyển sang trả phí hoặc bị đặt mật khẩu, rating, trạng thái |
|
||||
| Force update (`force_update.yml`) | Thủ công | Cào lại mọi trường (một URL hoặc lô tiếp theo); giữ nguyên `safe_virus` / `notes` / `nsfw` |
|
||||
| Phát hiện qua RSS (Cloudflare Worker) | Mỗi 4 giờ | Đọc một feed itch.io mỗi lượt; game mới vào hàng chờ duyệt |
|
||||
| Phát hiện qua RSS và quy tắc tự động (Cloudflare Worker) | Mỗi 4 giờ | Đọc một feed itch.io mỗi lượt vào hàng chờ duyệt; tự duyệt mục không có cờ sau thời gian chờ; đưa game miễn phí mới của collection được theo dõi vào hàng chờ ingest |
|
||||
| Python CI / Webapp CI | Pull request (Python CI còn chạy khi push vào `main` chạm tới phần Python) | Lint, test, validate dữ liệu / type-check, test, build |
|
||||
| Phân tích code (`sonarcloud.yml`, `qodana.yml`) | Pull request và push vào `main` có đổi code | SonarQube Cloud (kèm test coverage) và Qodana (TypeScript / JavaScript, Python, Rust) |
|
||||
| Deploy website | Khi push vào `main` | Cloudflare Workers Builds (`webapp/wrangler.jsonc`) → freeitchgames.win |
|
||||
| Theo dõi build (`deploy-status.yml`) | Mỗi giờ | Báo mỗi Workers Build lỗi của `main` lên Discord, một lần |
|
||||
| Release desktop / Android | Khi push tag `v*` | Trình cài đặt Tauri (Win/macOS/Linux) và APK đã ký → draft Release |
|
||||
@@ -218,8 +237,9 @@ Xem [CONTRIBUTING (tiếng Việt)](docs/i18n/vi/CONTRIBUTING.md) để có hư
|
||||
|
||||
- **Thêm game**: dùng [trang Suggest](https://freeitchgames.win/suggest).
|
||||
- **Gỡ game / sửa dữ liệu**: gửi email tới takedown@poli0981.dev hoặc mở issue ["Remove a game"](https://github.com/poli0981/free-games-itchio-list/issues/new?template=remove_game.yml).
|
||||
- **Báo lỗi**: dùng issue template "Bug Report".
|
||||
- **Đề xuất tính năng**: dùng template "Feature Request / Improvement", hoặc gửi PR.
|
||||
- **Báo sự cố**: dữ liệu sai, link chết, hoặc có gì đó hỏng trên website hay trong ứng dụng: dùng issue template "Report a problem".
|
||||
- **Rào cản trợ năng**: dùng [issue template "Accessibility barrier"](https://github.com/poli0981/free-games-itchio-list/issues/new?template=accessibility.yml) hoặc gửi email tới contact@poli0981.dev. Xem [Trợ năng](docs/i18n/vi/ACCESSIBILITY.md) ([EN](ACCESSIBILITY.md)).
|
||||
- **Tính năng và thay đổi code**: không còn được nhận, dự án đang ở [chế độ bảo trì](#trạng-thái-dự-án). Câu hỏi và góp ý xin gửi vào [Discussions](https://github.com/poli0981/free-games-itchio-list/discussions).
|
||||
- **Vấn đề bảo mật**: báo cáo riêng tư, đừng bao giờ mở issue công khai. Xem [SECURITY](docs/i18n/vi/SECURITY.md) ([EN](SECURITY.md)).
|
||||
- **Câu hỏi về quyền riêng tư**: xem [Chính sách quyền riêng tư](docs/i18n/vi/PrivacyPolicy.md) ([EN](docs/PrivacyPolicy.md)) hoặc gửi email tới privacy@poli0981.dev.
|
||||
- Vui lòng tuân thủ [Quy tắc ứng xử](docs/i18n/vi/CODE_OF_CONDUCT.md) ([EN](CODE_OF_CONDUCT.md)).
|
||||
@@ -261,7 +281,7 @@ Khi tái sử dụng dữ liệu, vui lòng ghi công như sau:
|
||||
Free itch.io games catalog by poli0981 (SkullMute) — https://freeitchgames.win — CC BY 4.0
|
||||
```
|
||||
|
||||
Các thành phần bên thứ ba giữ giấy phép riêng của chúng: xem [`docs/THIRD_PARTY.md`](docs/THIRD_PARTY.md) và trang About của website. Extension trình duyệt là một repo riêng theo GPL-3.0. Đóng góp được nhận theo cùng giấy phép với phần mà nó thay đổi (inbound = outbound): MIT cho mã nguồn, CC BY 4.0 cho dữ liệu và tài liệu.
|
||||
Các thành phần bên thứ ba giữ giấy phép riêng của chúng: xem [`docs/THIRD_PARTY.md`](docs/THIRD_PARTY.md) và trang About của website. Extension trình duyệt (đã archive) là một repo riêng theo GPL-3.0. Đóng góp được nhận theo cùng giấy phép với phần mà nó thay đổi (inbound = outbound): MIT cho mã nguồn, CC BY 4.0 cho dữ liệu và tài liệu.
|
||||
|
||||
**Không liên kết với itch.io.** Đây là một dự án độc lập do người hâm mộ làm. Dự án không liên kết với, không được chứng thực hay tài trợ bởi itch.io, Leaf Corcoran hoặc itch corp. "itch.io" cùng mọi tên game, logo và nhãn hiệu thuộc về chủ sở hữu tương ứng.
|
||||
|
||||
@@ -275,6 +295,7 @@ Bản tiếng Việt nằm trong [`docs/i18n/vi/`](docs/i18n/vi/); bản tiếng
|
||||
- [EULA](docs/i18n/vi/EULA.md) ([EN](docs/EULA.md)): chỉ áp dụng cho app desktop và Android
|
||||
- [Quy tắc ứng xử](docs/i18n/vi/CODE_OF_CONDUCT.md) ([EN](CODE_OF_CONDUCT.md))
|
||||
- [Chính sách bảo mật (Security Policy)](docs/i18n/vi/SECURITY.md) ([EN](SECURITY.md))
|
||||
- [Tuyên bố trợ năng (Accessibility)](docs/i18n/vi/ACCESSIBILITY.md) ([EN](ACCESSIBILITY.md)): những gì đã hỗ trợ cho công cụ trợ năng, các hạn chế đã biết, cách báo rào cản
|
||||
- [NOTICE](NOTICE.md)
|
||||
|
||||
Liên hệ (hộp thư riêng của Maintainer trên poli0981.dev):
|
||||
|
||||
+6
-4
@@ -1,6 +1,6 @@
|
||||
# Security Policy
|
||||
|
||||
Last updated: 2026-09-29
|
||||
Last updated: 2026-11-11
|
||||
|
||||
Applies from: the release of version 4.0.0.
|
||||
|
||||
@@ -24,7 +24,7 @@ A good report includes:
|
||||
|
||||
**In scope**
|
||||
|
||||
- The website https://freeitchgames.win and its Cloudflare Worker, including the image proxy (`/img`), the Suggest API (`/api/suggest`), the ingest API used by the Maintainer's browser extension (`/api/ingest`), and the admin app and API (`/admin`, `/api/admin`).
|
||||
- The website https://freeitchgames.win and its Cloudflare Worker, including the image proxy (`/img`), the Suggest API (`/api/suggest`), and the admin app and API (`/admin`, `/api/admin`).
|
||||
- The data pipeline (`scripts/`) and the GitHub Actions workflows (`.github/workflows/`).
|
||||
- The desktop apps and the Android APK published on [GitHub Releases](https://github.com/poli0981/free-games-itchio-list/releases).
|
||||
- The published data (`data_game/`, `scripts/deleted_games.json`, and https://freeitchgames.win/data) — for example, a way to get content into the catalog without the Maintainer's approval.
|
||||
@@ -37,7 +37,7 @@ A good report includes:
|
||||
- Volumetric denial-of-service (DoS/DDoS) and load testing.
|
||||
- Reports from automated scanners without a working proof of concept.
|
||||
|
||||
The browser extension (poli0981/itch-f2p-extension) lives in its own repository; report issues in the extension itself there. Issues in the ingest API it talks to are in scope here.
|
||||
The browser extension (poli0981/itch-f2p-extension) and the Telegram bot (poli0981/telegram-scraper-bot) are archived and no longer supported, so they are out of scope.
|
||||
|
||||
## 3. Supported versions
|
||||
|
||||
@@ -49,6 +49,8 @@ The browser extension (poli0981/itch-f2p-extension) lives in its own repository;
|
||||
|
||||
Fixes to the website go live when they are deployed. The apps do not update themselves: fixes ship in a new release, which you download from GitHub Releases.
|
||||
|
||||
Since version 4.6.1 the project is in **maintenance mode**: no new features, but security fixes and runtime and dependency updates continue as described here.
|
||||
|
||||
## 4. What to expect
|
||||
|
||||
- **Acknowledgement**: target within **7 days**. This is a solo hobby project, so that is a target rather than a guarantee, and often it will be much sooner.
|
||||
@@ -76,7 +78,7 @@ What the repository actually does:
|
||||
- **Dependabot** ([`.github/dependabot.yml`](.github/dependabot.yml)) is configured to keep npm, pip, GitHub Actions and cargo dependencies current.
|
||||
- Every third-party **GitHub Action is pinned by full commit SHA**, and each workflow declares least-privilege `permissions`.
|
||||
- Writes to the repository from the website's admin go through a **GitHub App** (verified commits), and the admin page is behind Cloudflare Access (GitHub login or one-time email PIN) and limited to the Maintainer.
|
||||
- The Suggest form is protected by Cloudflare Turnstile and rate limiting.
|
||||
- The website limits how many requests one address can send in a short time (a Cloudflare WAF rule, then per-route limits in the Worker that answer HTTP 429), and the Suggest form adds Cloudflare Turnstile and a stricter limit of its own.
|
||||
- The Android APK is signed with the project's key. Install it, and the desktop apps, only from the project's [GitHub Releases](https://github.com/poli0981/free-games-itchio-list/releases) page.
|
||||
|
||||
If a known vulnerability in a dependency actually affects a deployed component (the website, the Worker, the pipeline or the apps), report it privately as in [§1](#1-reporting-a-vulnerability). If it is just an outdated dependency with no practical impact, a normal issue or pull request is fine.
|
||||
|
||||
@@ -36,7 +36,7 @@ api() {
|
||||
}
|
||||
|
||||
output() {
|
||||
if [ -n "${GITHUB_OUTPUT:-}" ]; then echo "$1" >>"$GITHUB_OUTPUT"; fi
|
||||
if [[ -n "${GITHUB_OUTPUT:-}" ]]; then echo "$1" >>"$GITHUB_OUTPUT"; fi
|
||||
}
|
||||
|
||||
commits=$(api "repos/$GITHUB_REPOSITORY/commits?sha=main&per_page=100" \
|
||||
@@ -44,14 +44,14 @@ commits=$(api "repos/$GITHUB_REPOSITORY/commits?sha=main&per_page=100" \
|
||||
declare -A parent=()
|
||||
sha=""
|
||||
while read -r commit first_parent; do
|
||||
[ -n "$commit" ] || continue
|
||||
[ -n "$sha" ] || sha=$commit
|
||||
[[ -n "$commit" ]] || continue
|
||||
[[ -n "$sha" ]] || sha=$commit
|
||||
parent[$commit]=$first_parent
|
||||
done <<<"$commits"
|
||||
|
||||
now=$(date -u +%s)
|
||||
for _ in $(seq 1 "$MAX_COMMITS"); do
|
||||
[ -n "$sha" ] && [ -n "${parent[$sha]+set}" ] || break
|
||||
[[ -n "$sha" && -n "${parent[$sha]+set}" ]] || break
|
||||
run=$(api --method GET "repos/$GITHUB_REPOSITORY/commits/$sha/check-runs" \
|
||||
-f check_name="$CHECK_NAME" -f filter=latest --jq \
|
||||
'[.check_runs[] | select(.app.slug == "cloudflare-workers-and-pages")] | first
|
||||
@@ -67,7 +67,7 @@ for _ in $(seq 1 "$MAX_COMMITS"); do
|
||||
;;
|
||||
*)
|
||||
age_h=$(((now - $(date -u -d "$completed" +%s)) / 3600))
|
||||
if [ "$age_h" -lt "$WINDOW_H" ]; then
|
||||
if [[ "$age_h" -lt "$WINDOW_H" ]]; then
|
||||
echo "::error::The Cloudflare build of ${sha:0:7} ended '$conclusion' — freeitchgames.win is not up to date: $url"
|
||||
output "failed_id=$id"
|
||||
output "failed_url=$url"
|
||||
|
||||
+1
-1
@@ -3,7 +3,7 @@
|
||||
#
|
||||
# Usage: bash bash/commit_push.sh PATCH.json "commit message"
|
||||
#
|
||||
# Every data writer (refresh, ingest, admin Worker, browser extension) pushes
|
||||
# Every data writer (refresh, ingest, the admin Worker and its cron) pushes
|
||||
# to main. Instead of rebasing whole-file JSON rewrites (which conflict), each
|
||||
# attempt starts from a fresh origin/main and re-applies the URL-keyed patch;
|
||||
# apply_patch.py is idempotent and validates before anything is committed.
|
||||
|
||||
@@ -0,0 +1,192 @@
|
||||
# Changelog — 4.4.x
|
||||
|
||||
Release notes for 4.4.0 to 4.4.3, newest first. Every version: [CHANGELOG.md](../../CHANGELOG.md).
|
||||
|
||||
## [4.4.3] - 2026-10-26 (Dependency and security updates)
|
||||
|
||||
A maintenance release: nothing changes on the site or in the apps. It brings the week's dependency
|
||||
updates and closes the open security advisories in the project's build tools.
|
||||
|
||||
### Upgrade notes
|
||||
|
||||
- **Nothing to accept again**: no policy changed.
|
||||
- **Desktop and Android apps**: install 4.4.3 over 4.4.2 as usual.
|
||||
|
||||
### Security
|
||||
|
||||
- **Build tools**: wrangler's local development server (miniflare) pins `undici` 7.29.1, which has
|
||||
three advisories (GHSA-xjj6-f33q-929c, high; GHSA-4qv8-2p9j-2685 and GHSA-f72v-6w45-q472,
|
||||
moderate). An npm `overrides` entry lifts it to 7.30.1 until miniflare does so itself. `zod`,
|
||||
which the lint tools use, moves to 4.6.7 (GHSA-mrhx-c7xc-m3w5). Neither package is part of the site,
|
||||
the Worker or the apps; `npm audit` now reports none.
|
||||
- **Desktop and Android apps**: the Rust dependencies are refreshed, among them `tokio` 1.54.1
|
||||
(RUSTSEC-2026-0386) and a `yoke-derive` release that replaces a yanked one. `cargo audit` reports no
|
||||
vulnerabilities; its remaining warnings are on Linux libraries that Tauri depends on (`glib`, the
|
||||
`zbus` family), which have no fixed release yet.
|
||||
|
||||
### Changed
|
||||
|
||||
- **Code scanning** (#157): SonarQube Cloud analyses the repository in CI instead of its automatic
|
||||
analysis, and imports the test coverage of the Python and TypeScript suites.
|
||||
- **Dependencies** (the updates of Dependabot #159–#163, and a few more): React Router 8.5.0,
|
||||
TanStack Query 5.104.5, jose 6.2.13, lucide-react 1.61.0, Zustand 5.0.16, Vite 8.3.5,
|
||||
wrangler 4.152.0 (its generated Worker types refreshed), ESLint 10.13.0, typescript-eslint 8.72.0,
|
||||
knip 6.42.1 (it now follows the stylesheet's imports, so its config no longer has to exempt
|
||||
Tailwind), the Tauri CLI 2.12.4 and the `tauri` crate 2.12.5; Ruff 0.17.2, coverage 7.17.0 and
|
||||
certifi 2026.10.23 for the pipeline; `actions/setup-python` 7.1.0 in the workflows.
|
||||
|
||||
## [4.4.2] - 2026-10-22 (Toolchain upgrade, code-scan fixes)
|
||||
|
||||
A maintenance release: nothing you would notice changes on the site or in the apps. The project now
|
||||
builds with TypeScript 7, Node 26 and Python 3.15, and the issues a SonarQube Cloud scan of the
|
||||
repository reported are fixed — the one that mattered was a path check in the Worker's not-found
|
||||
handler that a crafted address could make expensive.
|
||||
|
||||
### Upgrade notes
|
||||
|
||||
- **Nothing to accept again**: no policy changed.
|
||||
- **Desktop and Android apps**: install 4.4.2 over 4.4.1 as usual.
|
||||
- **Building or running your own copy?** Use Node 26 for the web app and Python 3.15 for the
|
||||
pipeline. The Python dependencies are now pinned with hashes: `pip install -r requirements-dev.txt`
|
||||
works as before; to change one, edit `requirements.in` or `requirements-dev.in` and recompile with
|
||||
pip-tools (the command is at the top of each file).
|
||||
|
||||
### Fixed
|
||||
|
||||
- **Worker**: trailing slashes on request paths (not-found handler, admin routes, the Access issuer)
|
||||
and the verification cookie's base64 padding are trimmed by a loop instead of a regular expression
|
||||
that backtracked — a path with a long run of slashes cost quadratic CPU time on a public route. The
|
||||
itch.io feed and collection parsers lost three more expressions of that kind; a collection link's
|
||||
attributes are now read by splitting on quotes.
|
||||
- **Pipeline**: itch.io's two mature-content notices are matched by one CSS selector, so either of
|
||||
them still marks a game NSFW (each now has a test). A few checks are written out so the scanner can
|
||||
follow them, without a change in behaviour, and the scraper no longer sets up plain-http requests
|
||||
(every page it fetches is https).
|
||||
|
||||
### Changed
|
||||
|
||||
- **Build tooling** (#149, #154): TypeScript 7.0, the native compiler, runs the type check, with the
|
||||
6.0 API installed beside it for typescript-eslint. Node 26 builds the web app and the release apps,
|
||||
and npm runs only the install scripts of esbuild and workerd. Python 3.15 runs the pipeline (UTF-8
|
||||
mode is now the default); its CI pin moved to `.github/python-version`, out of Dependabot's way.
|
||||
- **Supply chain**: the pipeline's Python dependencies, indirect ones included, are locked with hashes
|
||||
(`requirements.txt`, `requirements-dev.txt`, compiled from `requirements*.in`) and installed from
|
||||
wheels only, so a new release of a dependency can no longer slip into the jobs that commit to the
|
||||
catalog. CI and the release builds install npm packages with `--ignore-scripts`, and the Workers
|
||||
config check runs the project's own wrangler (`npm run cf:check`).
|
||||
- **Code scanning**: `.sonarcloud.properties` keeps the saved itch.io test pages out of the scan;
|
||||
the maintainer's `i18n-edit` script reads its operations from stdin instead of a file path.
|
||||
- **Dependencies**: React 19.3.1 (#141), TanStack Query 5.104.4 (#142, #150), Radix UI primitives
|
||||
(#143), `@tauri-apps/api` 2.12.4, CLI 2.12.3 and `plugin-opener` 2.7.2 (#144) with the matching
|
||||
crates `tauri-build` 2.7.3, `tauri-plugin-opener` 2.7.2 and `tauri-plugin-single-instance` 2.5.4
|
||||
(#146), lucide-react 1.59.0 (#152), Vitest 5.0.5 (#153), Ruff 0.17.1 and Pillow 13 (#147),
|
||||
`actions/setup-java` 6.1.0 and `dtolnay/rust-toolchain` in the release workflows (#148).
|
||||
|
||||
## [4.4.1] - 2026-10-16 (Extension and bot retired)
|
||||
|
||||
The maintainer's browser extension and the old Telegram bot were hardly used, and both repositories
|
||||
are now public archives (read-only):
|
||||
[itch-f2p-extension](https://github.com/poli0981/itch-f2p-extension) and
|
||||
[telegram-scraper-bot](https://github.com/poli0981/telegram-scraper-bot). This version removes what was
|
||||
left of them here. Games still come in through the Suggest page, itch.io's RSS feeds and the itch.io
|
||||
collections the maintainer follows.
|
||||
|
||||
### Upgrade notes
|
||||
|
||||
- **Nothing to accept again.** The Privacy Policy, Terms of Use, EULA, Disclaimer and Security Policy
|
||||
(EN + VI) only lose their mentions of the extension and its API; nothing new is collected, so the
|
||||
legal check does not ask again.
|
||||
- **Desktop and Android apps**: install 4.4.1 over 4.4.0 as usual.
|
||||
- **Running your own copy of the Worker?** The `RL_INGEST` rate limit and the `ACCESS_AUD_INGEST`
|
||||
variable are gone from `wrangler.jsonc`; delete the Access application that protected
|
||||
`/api/ingest` and its service token. No D1 migration: the `idempotency` table stays and is no longer
|
||||
used.
|
||||
|
||||
### Removed
|
||||
|
||||
- **The ingest API** (`POST /api/ingest`), which the browser extension used to send links to the review
|
||||
queue with an Access service token. It never received a game since 4.0; the address now answers 404
|
||||
like any unknown API path.
|
||||
- **Admin:** the "Browser extension" choice in the auto-approve settings and the "Extension" source in
|
||||
the review queue.
|
||||
- **About page:** the old note asking to send a Telegram numeric ID privately (that was for the bot).
|
||||
The Telegram link stays as a way to reach the maintainer.
|
||||
|
||||
### Changed
|
||||
|
||||
- **Policies** (2026-10-16, EN + VI): the Privacy Policy no longer lists the extension as a source of
|
||||
games or its duplicate-submission records (7 days); the Terms of Use, the EULA (also in the
|
||||
installers) and the Security Policy no longer name the ingest API; the Disclaimer lists the three
|
||||
remaining ways games arrive. The extension and the bot are out of the Security Policy's scope.
|
||||
- **Docs**: the READMEs, contributing guide, notices, acknowledgements and operations guide describe
|
||||
three ways games get in, and mark the extension and the bot as archived.
|
||||
- **Dependencies**: Vite 8.3.4 (#131); Tauri 2.12.2 with `tauri-build` 2.7.2, `tauri-plugin-opener`
|
||||
2.7.1 and `tauri-plugin-single-instance` 2.5.3 (#135); `serde_json` 1.0.154 (#136); Ruff 0.17 for
|
||||
the pipeline's lint (#137).
|
||||
|
||||
## [4.4.0] - 2026-10-13 (Admin automation, bulk actions, smoother charts)
|
||||
|
||||
Version 4.4 lets the maintainer add whole lists of games, follow itch.io collections and approve the
|
||||
review queue by rule, remove or edit up to 100 games at once, and look back at everything the admin
|
||||
did. On the site, the theme button shows the theme in use again, dark mode no longer flashes white
|
||||
while a page loads, and the Charts tabs switch without rebuilding their charts.
|
||||
|
||||
### Upgrade notes
|
||||
|
||||
- **The policies changed: accept them once more.** The Terms of Use (§5), the Privacy Policy (§2.3,
|
||||
§2.4) and the Disclaimer (§4) now say that the maintainer approves games one by one **or through
|
||||
rules the maintainer sets**: a suggestion or a discovered game without a warning flag that nobody
|
||||
rejected within a waiting time (about a day), and new free games in public itch.io collections the
|
||||
maintainer follows. The website and the 4.4 apps ask you to accept the updated policies.
|
||||
- **Running your own copy of the Worker?** Apply the D1 migration `0002_automation.sql`
|
||||
(`npx wrangler d1 migrations apply <database> --remote`) before deploying.
|
||||
- **Reusing the data?** The catalog files are unchanged. The pipeline keeps one more bookkeeping file,
|
||||
`scripts/state/ingest_outcomes.json` (how each queued link ended); the website does not publish it.
|
||||
|
||||
### Added
|
||||
|
||||
- **Admin: add games from any list.** Paste text (plain links, Markdown, CSV, HTML or JSON) or load a
|
||||
file: every itch.io game link in it is found, de-duplicated and normalized. **Check** shows what Add
|
||||
would do with each one (new, waiting in the queue, already in the catalog, removed or rejected
|
||||
before, not a game) before anything is written; **Add** sends lists of any length in batches of 200.
|
||||
- **Admin: import an itch.io collection.** Paste a collection link: the admin reads all its pages
|
||||
(games with a price are skipped) and passes them through the same Check and Add.
|
||||
- **Admin: follow collections.** Every 4 hours the site reads the collections the maintainer follows
|
||||
(up to 30 pages a run, one a second) and queues their new free games directly. A game removed before,
|
||||
or one whose title raises a flag (18+, demo), goes to the review queue instead.
|
||||
- **Admin: auto-approve.** Pending suggestions and RSS discoveries without a flag that nobody rejected
|
||||
within 24 hours are approved automatically (at most 100 a run, and only items found after the rule
|
||||
was switched on). The sources and the waiting time are set in the admin's Settings.
|
||||
- **Admin: follow each game's ingest.** Batches queued from the admin show, game by game, whether the
|
||||
ingest added it, is still trying, or dropped it and why (paid, page gone, password-protected, failed
|
||||
three times). The pipeline now records these outcomes.
|
||||
- **Admin: remove or edit up to 100 games at once.** Select games (or paste their links under "Remove
|
||||
by list") and remove them with one public reason, or set their 18+ flag, virus check and notes, in
|
||||
one commit. The preset reasons have translated labels on the Removed page.
|
||||
- **Admin: New games, Activity, Settings.** The games added in the last 7 or 30 days, to review their
|
||||
18+ flag and virus check in bulk; every admin action and automatic run with its commit; the
|
||||
automatic rules, the followed collections and what the last automatic run did.
|
||||
|
||||
### Changed
|
||||
|
||||
- **The theme button shows the theme in use** (sun, moon or screen) instead of the same icon for every
|
||||
choice. The admin follows the theme chosen on the site, and a change in one tab applies to the others.
|
||||
- **Charts: switching tabs is instant.** A tab shown once stays as it is: switching back no longer
|
||||
rebuilds its charts or replays their entrance. Entrances are shorter (300 ms, no delay), the other
|
||||
tabs load in the background, and the placeholders have the height of the real cards.
|
||||
- **Pages no longer shift sideways** when they grow taller or shorter than the window: on computers the
|
||||
scrollbar's room stays reserved.
|
||||
- **The browser's toolbar colour** follows the theme chosen on the site, not only the system's.
|
||||
- **Charts on phones** (#130, live on the website since 2026-10-11, now in the apps too): one row of
|
||||
four equal tabs, smaller legends and ticks, horizontal bars for Languages and Average session, the
|
||||
reason under each recent removal, and the total spanning the row. At every size: all 15 genre labels,
|
||||
pie legends in data order with readable text, translated removal reasons and locale numbers on the
|
||||
axes.
|
||||
|
||||
### Fixed
|
||||
|
||||
- **Dark mode no longer flashes white** while a page loads.
|
||||
- **Admin:** "Select all" on a long review queue no longer fails (selections go out in batches of 200);
|
||||
removing a game no longer reports an error when only the cleanup of its resized covers failed; every
|
||||
error has a readable message; confirmations are in-app dialogs.
|
||||
- **Queue commits** name the number of games really queued.
|
||||
@@ -0,0 +1,44 @@
|
||||
# Changelog — 4.5.x
|
||||
|
||||
Release notes for 4.5.0, newest first. Every version: [CHANGELOG.md](../../CHANGELOG.md).
|
||||
|
||||
## [4.5.0] - 2026-10-27 (Rate limits for the whole site)
|
||||
|
||||
The website now limits how many requests one connection can send in a short time, on every page,
|
||||
cover image and API address — not only on the Suggest form and the verification check. Normal
|
||||
browsing never comes close to the limits; a script that floods the site gets HTTP 429 ("Too many
|
||||
requests") and has to wait a minute. Nothing changes in the desktop and Android apps.
|
||||
|
||||
### Upgrade notes
|
||||
|
||||
- **Nothing to accept again**: no policy changed. The Privacy Policy already says that your IP
|
||||
address is used, without being stored, to count requests and limit abuse.
|
||||
- **Desktop and Android apps**: install 4.5.0 over 4.4.3 as usual; they don't use the limited
|
||||
addresses (4.0–4.1.1 count against the site limit when they read the old catalog files).
|
||||
|
||||
### Added
|
||||
|
||||
- **Per-connection limits in the Worker**: every request that runs the site's server code counts,
|
||||
per minute and per address (an IPv6 connection by its /64): 120 for pages, the public API and the
|
||||
catalog files of the old apps, 600 for cover images (a Games page shows up to 100), 300 for the
|
||||
admin. The Suggest form (5 a minute) and the verification check (20 a minute) keep their own,
|
||||
stricter limits on top. Search engines that Cloudflare has verified are not counted.
|
||||
- **The "Too many requests" answer**: pages get a short page in English or Vietnamese (no scripts),
|
||||
the API and cover images a JSON `{"error":"rate_limited"}`; both say when to retry
|
||||
(`Retry-After: 60`) and are never cached. The admin shows "Too many requests from this connection".
|
||||
- **A first layer in front of the Worker**: the maintainer's runbook (`docs/operations.md`, section 1
|
||||
step 15) sets up a Cloudflare WAF rate-limiting rule that blocks floods before they reach the site's
|
||||
code, and covers the static files the Worker never sees. The Worker's own counts are approximate
|
||||
(Cloudflare counts them per server and syncs them late), so the WAF rule is what holds against a
|
||||
flood that opens a new connection for every request.
|
||||
|
||||
### Fixed
|
||||
|
||||
- **Suggest and verification limits counted other sites too**: a rate limit's namespace is shared by
|
||||
every Worker of the Cloudflare account, and the two existing limits used the same numbers as other
|
||||
Workers there, so their visits could use up this site's Suggest or verification allowance. All of
|
||||
this site's limits now have namespaces of their own.
|
||||
|
||||
### Changed
|
||||
|
||||
- **Security policy**: says how the site limits requests (EN + VI); no new obligations.
|
||||
@@ -0,0 +1,173 @@
|
||||
# Changelog — 4.6.x
|
||||
|
||||
Release notes for 4.6.0 – 4.6.2, newest first. Every version: [CHANGELOG.md](../../CHANGELOG.md).
|
||||
|
||||
## [4.6.2] - 2026-11-16 (Dependency updates)
|
||||
|
||||
Update deps:
|
||||
|
||||
- **Desktop and Android apps**: wry 0.57.2 (Android crash and memory-leak fixes, macOS crash fixes,
|
||||
a Windows focus fix), tauri-plugin-opener 2.7.3, and the other Rust crates (`cargo update`).
|
||||
- **Website**: TanStack Query 5.107.1, Zustand 5.1.0, lucide-react 1.72.0, jose 6.2.17.
|
||||
- **Data pipeline**: Soup Sieve 4.1.
|
||||
- **Tooling**: Vite 8.3.8, @vitejs/plugin-react 6.3.0, Tailwind CSS 4.3.5, Wrangler 4.161.0,
|
||||
typescript-eslint 8.72.2, knip 6.45.1, coverage 7.17.3, Ruff 0.17.5.
|
||||
|
||||
No policy changed: nothing to accept again.
|
||||
|
||||
## [4.6.1] - 2026-11-11 (Stable: maintenance mode)
|
||||
|
||||
The project is now **stable and in maintenance mode**. It is feature-complete: the website, the apps
|
||||
and the data pipeline keep running, and the catalog keeps updating itself every day. Nothing changes
|
||||
for visitors.
|
||||
|
||||
### What maintenance mode means
|
||||
|
||||
- **Still done**: security fixes (CVEs and reports made through [SECURITY.md](../../SECURITY.md)),
|
||||
runtime and dependency updates (Node.js, Python, Rust, npm / pip / cargo packages, GitHub Actions),
|
||||
and repairs when something stops the site or the daily data updates from working.
|
||||
- **Not done any more**: new features, redesigns and refactors.
|
||||
- **Issues and pull requests are for the data only**: adding games, fixing a game's data, removing a
|
||||
game. Accessibility barriers and security reports keep their own channels
|
||||
([ACCESSIBILITY.md](../../ACCESSIBILITY.md), [SECURITY.md](../../SECURITY.md)). Feature requests
|
||||
and code pull requests are closed without review; questions and feedback are welcome in
|
||||
[Discussions](https://github.com/poli0981/free-games-itchio-list/discussions).
|
||||
|
||||
### Upgrade notes
|
||||
|
||||
- **Nothing to accept again**: no policy changed.
|
||||
- **Desktop and Android apps**: 4.6.1 behaves like 4.6.0. Install it over 4.6.0 if you want the
|
||||
current version number; there is no need to.
|
||||
|
||||
### Added
|
||||
|
||||
- **Qodana (JetBrains) code analysis in CI** (`qodana.yml`): three jobs, one per Qodana Cloud
|
||||
project — TypeScript / JavaScript (`webapp/`), Python (the data pipeline) and Rust (the Tauri
|
||||
shell) — on pull requests and on pushes to `main` that change code. It runs next to SonarQube
|
||||
Cloud and, like it, skips Dependabot and fork pull requests, which get no repository secrets.
|
||||
All three projects start at 0 problems, and a new one fails its job.
|
||||
- **Badges** in both READMEs: project status, Python CI, SonarQube Cloud quality gate and coverage,
|
||||
Qodana, and the accessibility target.
|
||||
|
||||
### Changed
|
||||
|
||||
- **Docs for maintenance mode** (EN + VI): a "Project status" section in the READMEs, CONTRIBUTING
|
||||
rewritten around the data-only scope, a note in SECURITY.md, and the runbook
|
||||
([docs/operations.md](../../docs/operations.md)) with the Qodana setup.
|
||||
- **Issue and pull request templates**: "Bug Report" became "Report a problem" (wrong data, or
|
||||
something that broke); the Feature Request, Feedback and General templates and the Bug Fix, New
|
||||
Feature and Documentation pull request templates are gone; the issue chooser points to
|
||||
Discussions.
|
||||
- **The README's game count**: 5,900+ (it still said 2,600+).
|
||||
|
||||
### Fixed
|
||||
|
||||
Findings of the first Qodana reports. None changes what the site or the apps do.
|
||||
|
||||
- **Pie charts no longer use Recharts' deprecated `Cell`** (removed in Recharts 4.0): each slice
|
||||
takes its colour from its data entry. Colours and legends are unchanged.
|
||||
- **React 19 types**: `ElementRef` → `ComponentRef` in the UI components, `FormEvent` →
|
||||
`SubmitEvent` on the Suggest form, and a `React.` type used without an import.
|
||||
- **Small cleanups**: an awaited `res.json()` in the Worker's data loader, a simpler regular
|
||||
expression and return statement in the Games filters, and three Python nits in the pipeline (a
|
||||
shadowed name and an untyped number format in `refresh.py`, a value assigned but never read in
|
||||
`update_info.py`).
|
||||
- **The Tauri shell no longer declares `serde_json`**, which its own code never used (Tauri still
|
||||
brings it in).
|
||||
|
||||
## [4.6.0] - 2026-11-09 (Accessibility)
|
||||
|
||||
The website and the apps work better with a keyboard, a screen reader, Windows contrast themes and
|
||||
reduced motion, and the project now has an accessibility statement,
|
||||
[ACCESSIBILITY.md](../../ACCESSIBILITY.md) (in Vietnamese:
|
||||
[docs/i18n/vi/ACCESSIBILITY.md](../../docs/i18n/vi/ACCESSIBILITY.md)). It says what works, what
|
||||
doesn't yet, and how to report a barrier. The Maintainer had already tested the website and the
|
||||
Windows app with the keyboard only and Windows Narrator; this release fixes the gaps a review against
|
||||
WCAG 2.2 AA found.
|
||||
|
||||
### Upgrade notes
|
||||
|
||||
- **Nothing to accept again**: no policy changed. The accessibility statement isn't a policy you
|
||||
accept, so the first-visit notice doesn't come back.
|
||||
- **A new setting**: **Settings → Accessibility** turns off the "/" shortcut that jumps to the search
|
||||
box (useful with speech input, or when the key clashes with a screen reader or your browser's quick
|
||||
find).
|
||||
- **Colours**: buttons and purple text are a shade darker, form fields have darker borders, and the
|
||||
selected tab, the current page and the highlighted search suggestion are marked with an outline, an
|
||||
underline or a bar. This brings the contrast up to WCAG 2.2 AA. The logo and the app icons are
|
||||
unchanged.
|
||||
- **Desktop and Android apps**: install 4.6.0 over 4.5.0 as usual.
|
||||
|
||||
### Added
|
||||
|
||||
- **Accessibility statement** ([ACCESSIBILITY.md](../../ACCESSIBILITY.md), EN + VI): the WCAG 2.2
|
||||
AA target, what works, how it is tested, supported browsers and assistive technology, known
|
||||
limitations, and how to report a barrier, with severity levels and response targets. It is
|
||||
linked from the About page, the footer, Settings and the README.
|
||||
- **Reporting a barrier**: an "Accessibility barrier" issue form (label `accessibility`), or email
|
||||
contact@poli0981.dev, no GitHub account needed.
|
||||
- **Charts you can read**: every chart is named after its heading, reads each value aloud as you
|
||||
step through it with the left and right arrow keys, and has a **Data table** under it with the
|
||||
same numbers (plus each part's share for pie charts).
|
||||
- **Settings → Accessibility**: the "/" shortcut switch and a link to the statement.
|
||||
- **A contrast check in CI**: a test fails if a colour token or a chart colour drops below the
|
||||
WCAG 2.2 AA ratios.
|
||||
- **A default pull request template** with an accessibility checklist.
|
||||
|
||||
### Changed
|
||||
|
||||
- **Focus follows the page**: after you follow a link inside the site, focus moves to the new page's
|
||||
heading, so a screen reader announces it and Tab continues from there. Back returns focus to the
|
||||
link you used, for example the game you opened from the list. Links to a section (About →
|
||||
Support) move focus there too.
|
||||
- **Contrast**: white text on buttons goes from 4.35 to 5.44:1, purple text from 4.2 to 5.2:1 (6.6:1
|
||||
in dark mode), field borders and the off position of switches reach 3:1. Chart colours reach 3:1 on
|
||||
the light theme too, treemap labels pick a readable colour per cell, and axis labels are readable
|
||||
in dark mode. The Online/Offline chart is blue and orange, which colour-blind readers can tell
|
||||
apart.
|
||||
- **Windows contrast themes**: the selected tab, pressed toggles, the current page, the active
|
||||
search suggestion and switches use the system's highlight colours, and chart text follows the
|
||||
system text colour.
|
||||
- **Screen readers hear more**: the number of search suggestions, loading states, rating counts,
|
||||
filter counts ("Genre, 2 selected"), the reason and date of each removed game, and that a link
|
||||
opens a new tab (in the apps: your browser). Card titles on the About and Charts pages are real
|
||||
headings, and the game-not-found page and the 18+ notice have their own page titles.
|
||||
- **Language**: text in the other language (the language names, the English-only names of the legal
|
||||
documents) is marked as such, the page's language switches to Vietnamese only once the Vietnamese
|
||||
text has loaded, and the Suggest page's anti-spam check uses the site's language.
|
||||
- **Search box**: "See all results" can be reached with the arrow keys.
|
||||
- **Suggest form**: the game link is checked when you leave the field or send the form, not at the
|
||||
first keystroke, and the Send button stays reachable and says what is missing.
|
||||
- **First-visit notice**: "Accept & continue" can be reached with Tab before the box is ticked
|
||||
(pressing it moves you to the box), and focus moves to the page once you accept.
|
||||
- **Links inside sentences are underlined.**
|
||||
|
||||
### Fixed
|
||||
|
||||
- **The 18+ dialog lost keyboard focus when it closed**; focus now returns to the button or switch
|
||||
that opened it.
|
||||
- **The sticky header could cover the element that had keyboard focus.**
|
||||
- **Focus was lost** when the control you used disappeared: clearing the search, removing a filter,
|
||||
"Clear" in a filter menu, "back to top".
|
||||
- **Reduced motion**: looping loading animations now stop and "back to top" no longer scrolls
|
||||
smoothly when your system asks for less motion.
|
||||
- **Short screens**: the 18+ dialog, the phone menu and the display menu scroll instead of being cut
|
||||
off.
|
||||
- **Docs**: the catalog data license still listed the @freeitchgames.win addresses retired in 4.1.1;
|
||||
the About page's "Content removal" link opened the YAML source of the issue form; some "Last
|
||||
updated" dates, translation notes and library versions were behind.
|
||||
|
||||
### Dependencies
|
||||
|
||||
The two weekly updates since 4.5.0, which have been on the website since they were merged:
|
||||
|
||||
- **2026-11-02** (#176, Dependabot #171–#175 and a few more): React Router 8.5.1, TanStack Query
|
||||
5.105.0, lucide-react 1.64.0, knip 6.44.0, typescript-eslint 8.72.1, wrangler 4.156.0 (its
|
||||
generated Worker types refreshed), jose 6.2.14; the `undici` override dropped (wrangler's own
|
||||
version now has the fix); pytest 9.2.0 and Ruff 0.17.3 for the pipeline;
|
||||
`sonarqube-scan-action` 8.4.0; the Rust dependencies refreshed.
|
||||
- **2026-11-09** (#182, Dependabot #177–#181 and a few more): TanStack Query 5.106.1, Vitest 5.1.0,
|
||||
Vite 8.3.6, @vitejs/plugin-react 6.2.1, Tailwind CSS 4.3.4, ESLint 10.14.0, knip 6.44.1,
|
||||
wrangler 4.158.0 (types refreshed), jose 6.2.15, globals 17.14.0, lucide-react 1.69.0;
|
||||
soupsieve 4.0.1, coverage 7.17.2 and Ruff 0.17.4 for the pipeline; `actions/setup-java` 6.2.0 and
|
||||
`sonarqube-scan-action` 8.4.1; the Rust dependencies refreshed (wasm-bindgen 0.2.130 and others).
|
||||
@@ -1,6 +1,6 @@
|
||||
# Catalog data license
|
||||
|
||||
Last updated: 2026-10-03
|
||||
Last updated: 2026-11-09
|
||||
|
||||
Applies from: the release of version 4.0.0.
|
||||
|
||||
@@ -113,7 +113,7 @@ a guarantee. The project does not scan downloads. See the [Disclaimer](../docs/D
|
||||
## 7. Corrections and removals
|
||||
|
||||
Game creators and rights holders can ask for a game to be removed or its data corrected. Email
|
||||
**takedown@freeitchgames.win** or open the
|
||||
**takedown@poli0981.dev** or open the
|
||||
["Remove a game" issue](https://github.com/poli0981/free-games-itchio-list/issues/new?template=remove_game.yml).
|
||||
Include the game URL, who you are (creator, rights holder, or someone acting for them) and the reason. The
|
||||
full process is in the [Terms of Use](../docs/ToS.md).
|
||||
@@ -134,4 +134,4 @@ to the Data from version 4.0.0 on.
|
||||
|
||||
*This is a plain-language summary written by a hobby maintainer, not a lawyer, and it is not legal advice.
|
||||
If this file and the CC BY 4.0 legal code disagree, the legal code wins. Questions:
|
||||
**legal@freeitchgames.win**.*
|
||||
**legal@poli0981.dev**.*
|
||||
Generated
+141
-1
@@ -409,6 +409,146 @@
|
||||
},
|
||||
{
|
||||
"date": "2026-10-10",
|
||||
"total": 3251
|
||||
"total": 3262
|
||||
},
|
||||
{
|
||||
"date": "2026-10-11",
|
||||
"total": 3254
|
||||
},
|
||||
{
|
||||
"date": "2026-10-12",
|
||||
"total": 3276
|
||||
},
|
||||
{
|
||||
"date": "2026-10-14",
|
||||
"total": 3358
|
||||
},
|
||||
{
|
||||
"date": "2026-10-15",
|
||||
"total": 3369
|
||||
},
|
||||
{
|
||||
"date": "2026-10-16",
|
||||
"total": 3406
|
||||
},
|
||||
{
|
||||
"date": "2026-10-17",
|
||||
"total": 3415
|
||||
},
|
||||
{
|
||||
"date": "2026-10-18",
|
||||
"total": 3430
|
||||
},
|
||||
{
|
||||
"date": "2026-10-19",
|
||||
"total": 3451
|
||||
},
|
||||
{
|
||||
"date": "2026-10-20",
|
||||
"total": 3483
|
||||
},
|
||||
{
|
||||
"date": "2026-10-21",
|
||||
"total": 3507
|
||||
},
|
||||
{
|
||||
"date": "2026-10-22",
|
||||
"total": 3528
|
||||
},
|
||||
{
|
||||
"date": "2026-10-23",
|
||||
"total": 3561
|
||||
},
|
||||
{
|
||||
"date": "2026-10-24",
|
||||
"total": 3571
|
||||
},
|
||||
{
|
||||
"date": "2026-10-25",
|
||||
"total": 3612
|
||||
},
|
||||
{
|
||||
"date": "2026-10-26",
|
||||
"total": 4184
|
||||
},
|
||||
{
|
||||
"date": "2026-10-27",
|
||||
"total": 4849
|
||||
},
|
||||
{
|
||||
"date": "2026-10-28",
|
||||
"total": 5426
|
||||
},
|
||||
{
|
||||
"date": "2026-10-29",
|
||||
"total": 5536
|
||||
},
|
||||
{
|
||||
"date": "2026-10-30",
|
||||
"total": 5573
|
||||
},
|
||||
{
|
||||
"date": "2026-10-31",
|
||||
"total": 5615
|
||||
},
|
||||
{
|
||||
"date": "2026-11-01",
|
||||
"total": 5641
|
||||
},
|
||||
{
|
||||
"date": "2026-11-02",
|
||||
"total": 5674
|
||||
},
|
||||
{
|
||||
"date": "2026-11-03",
|
||||
"total": 5702
|
||||
},
|
||||
{
|
||||
"date": "2026-11-04",
|
||||
"total": 5720
|
||||
},
|
||||
{
|
||||
"date": "2026-11-05",
|
||||
"total": 5737
|
||||
},
|
||||
{
|
||||
"date": "2026-11-06",
|
||||
"total": 5771
|
||||
},
|
||||
{
|
||||
"date": "2026-11-07",
|
||||
"total": 5798
|
||||
},
|
||||
{
|
||||
"date": "2026-11-08",
|
||||
"total": 5818
|
||||
},
|
||||
{
|
||||
"date": "2026-11-09",
|
||||
"total": 5858
|
||||
},
|
||||
{
|
||||
"date": "2026-11-10",
|
||||
"total": 5875
|
||||
},
|
||||
{
|
||||
"date": "2026-11-11",
|
||||
"total": 5922
|
||||
},
|
||||
{
|
||||
"date": "2026-11-12",
|
||||
"total": 5966
|
||||
},
|
||||
{
|
||||
"date": "2026-11-13",
|
||||
"total": 5991
|
||||
},
|
||||
{
|
||||
"date": "2026-11-14",
|
||||
"total": 6028
|
||||
},
|
||||
{
|
||||
"date": "2026-11-15",
|
||||
"total": 6069
|
||||
}
|
||||
]
|
||||
Generated
+3281
-1343
File diff suppressed because it is too large.
Load diff
Generated
+3475
-1589
File diff suppressed because it is too large.
Load diff
Generated
+3459
-1648
File diff suppressed because it is too large.
Load diff
Generated
+3643
-1684
File diff suppressed because it is too large.
Load diff
Generated
+3748
-1952
File diff suppressed because it is too large.
Load diff
Generated
+5349
-2798
File diff suppressed because it is too large.
Load diff
Generated
+13782
-2827
File diff suppressed because it is too large.
Load diff
Generated
+17165
File diff suppressed because it is too large.
Load diff
Generated
+18205
File diff suppressed because it is too large.
Load diff
Generated
+19533
File diff suppressed because it is too large.
Load diff
Generated
+18773
File diff suppressed because it is too large.
Load diff
Generated
+19092
File diff suppressed because it is too large.
Load diff
Generated
+2533
File diff suppressed because it is too large.
Load diff
Generated
+32
-8
@@ -1,7 +1,7 @@
|
||||
{
|
||||
"total_games": 3251,
|
||||
"total_games": 6069,
|
||||
"max_per_file": 500,
|
||||
"last_updated": "2026-10-10T03:56:42Z",
|
||||
"last_updated": "2026-11-15T20:24:18Z",
|
||||
"files": [
|
||||
{
|
||||
"name": "game_info_001.json",
|
||||
@@ -9,27 +9,51 @@
|
||||
},
|
||||
{
|
||||
"name": "game_info_002.json",
|
||||
"count": 499
|
||||
"count": 500
|
||||
},
|
||||
{
|
||||
"name": "game_info_003.json",
|
||||
"count": 499
|
||||
"count": 500
|
||||
},
|
||||
{
|
||||
"name": "game_info_004.json",
|
||||
"count": 499
|
||||
"count": 500
|
||||
},
|
||||
{
|
||||
"name": "game_info_005.json",
|
||||
"count": 499
|
||||
"count": 500
|
||||
},
|
||||
{
|
||||
"name": "game_info_006.json",
|
||||
"count": 496
|
||||
"count": 500
|
||||
},
|
||||
{
|
||||
"name": "game_info_007.json",
|
||||
"count": 259
|
||||
"count": 500
|
||||
},
|
||||
{
|
||||
"name": "game_info_008.json",
|
||||
"count": 500
|
||||
},
|
||||
{
|
||||
"name": "game_info_009.json",
|
||||
"count": 500
|
||||
},
|
||||
{
|
||||
"name": "game_info_010.json",
|
||||
"count": 500
|
||||
},
|
||||
{
|
||||
"name": "game_info_011.json",
|
||||
"count": 500
|
||||
},
|
||||
{
|
||||
"name": "game_info_012.json",
|
||||
"count": 500
|
||||
},
|
||||
{
|
||||
"name": "game_info_013.json",
|
||||
"count": 69
|
||||
}
|
||||
]
|
||||
}
|
||||
@@ -19,7 +19,7 @@ This repo wouldn't exist without a lot of help — mostly from tools and platfor
|
||||
|
||||
The website, the Worker and the desktop / Android apps build on a stack of open-source libraries. The full list with licenses lives in [`THIRD_PARTY.md`](THIRD_PARTY.md), and the runtime libraries are also on the [About page](https://freeitchgames.win/about) (from the `THIRD_PARTY` array in [`webapp/src/lib/about.ts`](../webapp/src/lib/about.ts)). Highlights:
|
||||
|
||||
- **Core**: React 19, TypeScript 6, Vite 8, React Router 8, Zustand 5
|
||||
- **Core**: React 19, TypeScript 7, Vite 8, React Router 8, Zustand 5
|
||||
- **UI**: Tailwind CSS, tw-animate-css, shadcn/ui (pattern), Radix UI primitives, lucide-react, class-variance-authority, tailwind-merge, clsx, Recharts, the Geist and Geist Mono typefaces (via Fontsource)
|
||||
- **Data**: TanStack Query, idb-keyval
|
||||
- **Worker**: jose, Wrangler
|
||||
@@ -27,9 +27,9 @@ The website, the Worker and the desktop / Android apps build on a stack of open-
|
||||
|
||||
When you add a new dep to `webapp/package.json`, also add it to the `THIRD_PARTY` array so the About page lists it, and to [`THIRD_PARTY.md`](THIRD_PARTY.md). House rules are in [CONTRIBUTING.md](../CONTRIBUTING.md).
|
||||
|
||||
## Browser extension — the other way in
|
||||
## Retired helpers
|
||||
|
||||
[poli0981/itch-f2p-extension](https://github.com/poli0981/itch-f2p-extension) (GPL-3.0, separate repo) lets me queue itch.io games straight from the browser. It sends them through an authenticated API into the same review queue as the public [Suggest page](https://freeitchgames.win/suggest) and the RSS discovery. Nothing goes live until I approve it. (The old Telegram bot did this job in v3 and is now retired.)
|
||||
Two side projects used to feed the catalog: the browser extension [poli0981/itch-f2p-extension](https://github.com/poli0981/itch-f2p-extension) (GPL-3.0) and, in v3, the Telegram bot [poli0981/telegram-scraper-bot](https://github.com/poli0981/telegram-scraper-bot) (MIT). Both were hardly used, so they are archived now (October 2026). Games come in through the public [Suggest page](https://freeitchgames.win/suggest), the RSS discovery and the itch.io collections I follow, and nothing goes live until it is approved.
|
||||
|
||||
## Find me / Support me
|
||||
Real channels exist now (still introvert max level, replies slow):
|
||||
|
||||
+2
-2
@@ -1,6 +1,6 @@
|
||||
# Disclaimer
|
||||
|
||||
Last updated: 2026-09-29
|
||||
Last updated: 2026-10-16
|
||||
|
||||
Applies from: the release of version 4.0.0.
|
||||
|
||||
@@ -31,7 +31,7 @@ The Project is independent. It is **not affiliated with, endorsed by, or sponsor
|
||||
|
||||
The Project **does not make, host, distribute, sell or endorse** the games it lists. Every game links to its own page on itch.io, and any download happens there, under itch.io's terms and the creator's own terms or license.
|
||||
|
||||
Games reach the catalog through the public Suggest page, the Maintainer's browser extension, or itch.io's public RSS feeds, and nothing is added until the Maintainer approves it. That approval is **not** a security audit, a quality check or an endorsement.
|
||||
Games reach the catalog through the public Suggest page, itch.io's public RSS feeds, or public itch.io collections the Maintainer follows. Each one is approved by the Maintainer, one by one or through automatic rules the Maintainer sets. That approval is **not** a security audit, a quality check or an endorsement.
|
||||
|
||||
## 5. No warranty as to the games
|
||||
|
||||
|
||||
+2
-2
@@ -1,6 +1,6 @@
|
||||
# End-User License Agreement (EULA)
|
||||
|
||||
Last updated: 2026-10-03
|
||||
Last updated: 2026-10-16
|
||||
|
||||
Applies from: the release of version 4.2.0.
|
||||
|
||||
@@ -82,7 +82,7 @@ You agree not to:
|
||||
|
||||
- Present a modified build as an official release, for example by distributing it under the project's name and icon, or with the official app identifier `com.poli0981.freegamesitchio`, without clearly marking it as unofficial. Forks are welcome under the MIT License; just make it obvious they are Yours.
|
||||
- Use the Maintainer's name, the GitHub handle `poli0981`, or the alias "SkullMute" to endorse or promote derivative works without prior written permission.
|
||||
- Use the App, or a modified version of it, in a way that breaks the Website's [Terms of Use](ToS.md), for example automated bulk requests to the Website (the data is in the Repository), or attempts to reach the admin area or the ingest API without authorization.
|
||||
- Use the App, or a modified version of it, in a way that breaks the Website's [Terms of Use](ToS.md), for example automated bulk requests to the Website (the data is in the Repository), or attempts to reach the admin area without authorization.
|
||||
- Use the App or its installers to host, distribute or facilitate malware, phishing, or content that violates applicable law.
|
||||
|
||||
These rules are about how You use the App and the project's name and services. They sit alongside the MIT License and do not limit the rights it grants over the source code.
|
||||
|
||||
+9
-10
@@ -1,8 +1,8 @@
|
||||
# Privacy Policy
|
||||
|
||||
Last updated: 2026-10-03
|
||||
Last updated: 2026-10-16
|
||||
|
||||
Applies from: 2026-10-03 on the Website, and from version 4.2.0 of the Apps.
|
||||
Applies from: 2026-10-13 on the Website, and from version 4.4.0 of the Apps.
|
||||
|
||||
This Privacy Policy explains what personal data the `free-games-itchio-list` project processes, why, who helps process it, how long it is kept, and what rights you have. It covers the website **https://freeitchgames.win**, the desktop and Android apps, the public catalog data and the repository. The short version: there are no accounts, no ads and no tracking cookies. The Project keeps as little as it can, and most of what exists stays in your own browser.
|
||||
|
||||
@@ -36,7 +36,7 @@ The controller of the personal data described in this Policy is **the Maintainer
|
||||
|
||||
### 1.3 What this Policy does not cover
|
||||
|
||||
This Policy does not cover services that handle data on their own account: itch.io (every game link and every download goes there), GitHub for your GitHub account and your activity on github.com, Cloudflare's use of data for its own purposes as described in its privacy policy, the games themselves, or the Maintainer's browser extension, which is a separate project with its own documentation. Their own policies apply (links in section 4).
|
||||
This Policy does not cover services that handle data on their own account: itch.io (every game link and every download goes there), GitHub for your GitHub account and your activity on github.com, Cloudflare's use of data for its own purposes as described in its privacy policy, or the games themselves. Their own policies apply (links in section 4).
|
||||
|
||||
## 2. What is processed and why
|
||||
|
||||
@@ -65,14 +65,14 @@ When you use the Suggest page (https://freeitchgames.win/suggest):
|
||||
- **What is stored**: the game URL, your optional note (up to 500 characters) and the time of submission, in the review queue (section 2.4). No name, email address or account is asked for or stored.
|
||||
- **Anti-spam**: Cloudflare Turnstile processes signals about your device and browser to tell people from bots. To check the result, the Website sends the Turnstile token and your IP address to Cloudflare's verification service.
|
||||
- **Rate limiting**: your IP address is used transiently to count requests. The Project does not store it.
|
||||
- **Purpose**: to review your suggestion. If it is approved, the game URL becomes part of the public Catalog. Your note is never published and is **deleted automatically after 180 days**.
|
||||
- **Purpose**: to review your suggestion, by the Maintainer or by the automatic rules the Maintainer sets (section 2.4). If it is approved, the game URL becomes part of the public Catalog. Your note is never published and is **deleted automatically after 180 days**.
|
||||
- **Please don't put personal data in the note**, yours or anyone else's. The form is for game links only.
|
||||
|
||||
### 2.4 The review queue and the admin area
|
||||
|
||||
- **How games arrive**: suggestions from the Suggest page; submissions from the Maintainer's browser extension through an authenticated API (the game URL, an optional title and note, and the extension's service-token ID; the records that prevent duplicate submissions are kept for 7 days); and automatic discovery from itch.io's public RSS feeds.
|
||||
- **The review queue** (Cloudflare D1) holds candidate game URLs with their source, the title, cover-image URL and genre hint taken from itch.io, automatic flags, notes, timestamps and the Maintainer's decision. Nothing enters the Catalog until the Maintainer approves it. Rejected URLs are kept indefinitely as a blocklist; only the URL is needed to avoid reviewing the same game again.
|
||||
- **The admin area** (https://freeitchgames.win/admin) is for the Maintainer only. It is protected by Cloudflare Access (GitHub login or a one-time PIN sent by email), which sets a `CF_Authorization` session cookie in the Maintainer's browser. Admin actions are recorded in an audit log together with the Maintainer's email address. The audit log is never published.
|
||||
- **How games arrive**: suggestions from the Suggest page; automatic discovery from itch.io's public RSS feeds; and new free games in public itch.io collections the Maintainer follows (the Website reads those public pages; nothing about you is involved).
|
||||
- **The review queue** (Cloudflare D1) holds candidate game URLs with their source, the title, cover-image URL and genre hint taken from itch.io, automatic flags, notes, timestamps and the Maintainer's decision. Games enter the Catalog when the Maintainer approves them: one by one, or through automatic rules the Maintainer sets and can change at any time (items without a warning flag that nobody rejected within a waiting time; new free games in collections the Maintainer follows). Automatic approvals are recorded in the audit log like the Maintainer's own. Rejected URLs are kept indefinitely as a blocklist; only the URL is needed to avoid reviewing the same game again.
|
||||
- **The admin area** (https://freeitchgames.win/admin) is for the Maintainer only. It is protected by Cloudflare Access (GitHub login or a one-time PIN sent by email), which sets a `CF_Authorization` session cookie in the Maintainer's browser. Admin actions, including changes to the automatic rules, are recorded in an audit log together with the Maintainer's email address. The audit log is never published.
|
||||
|
||||
### 2.5 Public game data in the Catalog
|
||||
|
||||
@@ -145,7 +145,6 @@ Cloudflare and Google may process data anywhere on their global networks (see se
|
||||
| IP address used for rate limiting and Turnstile | Used transiently; never stored by the Project |
|
||||
| Suggest note | Deleted automatically after **180 days** |
|
||||
| Suggested or discovered game URLs, with source and timestamps | In the review queue while needed to avoid reviewing the same game twice. Approved URLs become part of the public Catalog; rejected URLs are kept indefinitely as a blocklist |
|
||||
| Duplicate-submission records from the browser extension | **7 days** |
|
||||
| Admin audit log (with the Maintainer's email address) | Kept as the record of admin changes; never published |
|
||||
| Catalog entries (including developer and publisher names) | While the game is listed. Removal records stay in the public removed-games list, and the Repository's Git history keeps past versions (see section 7.3) |
|
||||
| Emails, including removal and copyright requests | As long as needed to handle the request |
|
||||
@@ -219,8 +218,8 @@ Under the GDPR and the UK GDPR, you can also ask for processing to be restricted
|
||||
|
||||
- The Website is served only over HTTPS.
|
||||
- Automated traffic has to pass a Cloudflare Turnstile check before the Website's pages and cover images load (section 2.1).
|
||||
- Data minimization: no accounts, no IP addresses stored by the Project's code, Suggest notes deleted after 180 days, duplicate-submission records after 7 days.
|
||||
- The admin area and the ingest API are protected by Cloudflare Access, and the Website's server code verifies the Access token itself on every protected request.
|
||||
- Data minimization: no accounts, no IP addresses stored by the Project's code, Suggest notes deleted after 180 days.
|
||||
- The admin area is protected by Cloudflare Access, and the Website's server code verifies the Access token itself on every protected request.
|
||||
- Secrets (such as the GitHub App's private key) are kept in Cloudflare's secret storage, never in the Repository. The admin area writes to the Repository as a GitHub App, with verified commits.
|
||||
- A strict Content Security Policy limits scripts to the Website itself plus Cloudflare Web Analytics and Turnstile.
|
||||
- GitHub Actions are pinned to exact commit SHAs with least-privilege permissions, and Dependabot keeps dependencies up to date.
|
||||
|
||||
+20
-13
@@ -1,6 +1,6 @@
|
||||
# Third-party components
|
||||
|
||||
Last updated: 2026-10-03
|
||||
Last updated: 2026-11-09
|
||||
|
||||
Applies from: the release of version 4.0.0.
|
||||
|
||||
@@ -28,22 +28,22 @@ shared UI components).
|
||||
| Component | Version | Used for | License |
|
||||
|---|---|---|---|
|
||||
| [React](https://react.dev) (`react`, `react-dom`) | 19.3 | UI framework | MIT |
|
||||
| [React Router](https://reactrouter.com) (`react-router`) | 8.4 | Routing | MIT |
|
||||
| [React Router](https://reactrouter.com) (`react-router`) | 8.5 | Routing | MIT |
|
||||
| [Zustand](https://github.com/pmndrs/zustand) | 5.0 | Preference and theme stores | MIT |
|
||||
| [TanStack Query](https://tanstack.com/query) (`@tanstack/react-query`, `react-query-persist-client`) | 5.103 | Data fetching and the local catalog cache | MIT |
|
||||
| [TanStack Query](https://tanstack.com/query) (`@tanstack/react-query`, `react-query-persist-client`) | 5.106 | Data fetching and the local catalog cache | MIT |
|
||||
| [idb-keyval](https://github.com/jakearchibald/idb-keyval) | 6.3 | IndexedDB storage for the compressed catalog cache | Apache-2.0 |
|
||||
| [fflate](https://github.com/101arrowz/fflate) | 0.8 | Decompressing the catalog where the browser has no Compression Streams (older Safari / iOS) | MIT |
|
||||
| [Recharts](https://recharts.org) | 3.10 | Charts | MIT |
|
||||
| [Radix UI](https://www.radix-ui.com) primitives (`@radix-ui/react-checkbox`, `-dialog`, `-label`, `-popover`, `-separator`, `-slot`, `-switch`, `-tabs`) | 1.x / 2.x | Accessible UI building blocks | MIT |
|
||||
| [shadcn/ui](https://ui.shadcn.com) | pattern | Component patterns copied into `webapp/src/components/ui/` | MIT |
|
||||
| [lucide-react](https://lucide.dev) | 1.47 | Icons | ISC |
|
||||
| [lucide-react](https://lucide.dev) | 1.69 | Icons | ISC |
|
||||
| [class-variance-authority](https://cva.style) | 0.7 | Component variants | Apache-2.0 |
|
||||
| [clsx](https://github.com/lukeed/clsx) | 2.1 | Class-name helper | MIT |
|
||||
| [tailwind-merge](https://github.com/dcastil/tailwind-merge) | 3.7 | Class-name merging | MIT |
|
||||
| [Tailwind CSS](https://tailwindcss.com) (`tailwindcss`, `@tailwindcss/vite`) and [tw-animate-css](https://github.com/Wombosvideo/tw-animate-css) | 4.3 / 1.4 | Generate the site's CSS at build time | MIT |
|
||||
| [Geist and Geist Mono](https://vercel.com/font) (`@fontsource-variable/geist`, `@fontsource-variable/geist-mono`) | 5.3 | The site's typefaces | OFL-1.1 (fonts), MIT (Fontsource packaging) |
|
||||
| [`@tauri-apps/api`](https://github.com/tauri-apps/tauri/tree/dev/packages/api) | 2.11 | App-only bridge to the native shell | Apache-2.0 OR MIT |
|
||||
| [`@tauri-apps/plugin-opener`](https://github.com/tauri-apps/plugins-workspace/tree/v2/plugins/opener) | 2.5 | App-only: opens itch.io links in the system browser | Apache-2.0 OR MIT |
|
||||
| [`@tauri-apps/api`](https://github.com/tauri-apps/tauri/tree/dev/packages/api) | 2.12 | App-only bridge to the native shell | Apache-2.0 OR MIT |
|
||||
| [`@tauri-apps/plugin-opener`](https://github.com/tauri-apps/plugins-workspace/tree/v2/plugins/opener) | 2.7 | App-only: opens itch.io links in the system browser | Apache-2.0 OR MIT |
|
||||
|
||||
`@tanstack/react-query-devtools` (MIT) is listed as a dependency but only renders in development builds.
|
||||
|
||||
@@ -69,20 +69,21 @@ components. Section 7 lists every service the project uses.
|
||||
| [tauri](https://tauri.app), `tauri-build` | 2 | App shell and build helper | Apache-2.0 OR MIT |
|
||||
| [tauri-plugin-opener](https://github.com/tauri-apps/plugins-workspace/tree/v2/plugins/opener) | 2 | Opening links in the system browser | Apache-2.0 OR MIT |
|
||||
| [tauri-plugin-single-instance](https://github.com/tauri-apps/plugins-workspace/tree/v2/plugins/single-instance) | 2 | Desktop only: focuses the running window instead of starting a second copy | Apache-2.0 OR MIT |
|
||||
| [serde](https://serde.rs), [serde_json](https://github.com/serde-rs/json) | 1 | Serialization | MIT OR Apache-2.0 |
|
||||
| [serde](https://serde.rs) | 1 | Serialization | MIT OR Apache-2.0 |
|
||||
|
||||
The apps render with the system web view that the operating system provides: WebView2 on Windows,
|
||||
WKWebView on macOS (Safari/WebKit 16.4 or later), WebKitGTK on Linux and Android System WebView on Android.
|
||||
|
||||
## 4. Data pipeline (Python 3.14)
|
||||
## 4. Data pipeline (Python 3.15)
|
||||
|
||||
| Package | Version | Used for | License |
|
||||
|---|---|---|---|
|
||||
| [requests](https://requests.readthedocs.io) | 2.34+ | HTTP requests to public itch.io pages | Apache-2.0 |
|
||||
| [beautifulsoup4](https://www.crummy.com/software/BeautifulSoup/) | 4.15+ | Parsing itch.io pages | MIT |
|
||||
| [urllib3](https://urllib3.readthedocs.io) | 2.8+ | Retry policy of the scraper's HTTP session | MIT |
|
||||
|
||||
These pull in `urllib3` (MIT), `certifi` (MPL-2.0), `charset-normalizer` (MIT), `idna` (BSD-3-Clause) and
|
||||
`soupsieve` (MIT).
|
||||
These pull in `certifi` (MPL-2.0), `charset-normalizer` (MIT), `idna` (BSD-3-Clause) and `soupsieve`
|
||||
(MIT).
|
||||
|
||||
## 5. Development and test tooling (never shipped)
|
||||
|
||||
@@ -104,8 +105,9 @@ These tools never end up in a build, but they keep the code honest.
|
||||
- **[ESLint](https://eslint.org)** with `@eslint/js`, **[typescript-eslint](https://typescript-eslint.io)**,
|
||||
`eslint-plugin-react-hooks`, `eslint-plugin-react-refresh` and `globals` (all MIT): webapp linting.
|
||||
Config: [`webapp/eslint.config.js`](../webapp/eslint.config.js). Run: `cd webapp && npm run lint`
|
||||
- **[TypeScript](https://www.typescriptlang.org)** 6.0 (Apache-2.0): `noUnusedLocals` and
|
||||
`noUnusedParameters` reject unused code at build time. Run: `cd webapp && npx tsc -b`
|
||||
- **[TypeScript](https://www.typescriptlang.org)** 7.0 (Apache-2.0): `noUnusedLocals` and
|
||||
`noUnusedParameters` reject unused code at build time. Run: `cd webapp && npx tsc -b`. The 6.0 API
|
||||
(`@typescript/typescript6`, installed as `typescript`) stays for typescript-eslint, which needs it
|
||||
|
||||
### Build, test and deploy
|
||||
|
||||
@@ -113,10 +115,12 @@ These tools never end up in a build, but they keep the code honest.
|
||||
|---|---|---|
|
||||
| [Vite](https://vite.dev) 8 and `@vitejs/plugin-react` | Bundling the site, the admin app and the apps' front end | MIT |
|
||||
| [Vitest](https://vitest.dev) 5 | Tests (`npm test`) | MIT |
|
||||
| [`@vitest/coverage-v8`](https://vitest.dev/guide/coverage) 5 | Test coverage for SonarQube Cloud (`npm run test:coverage`) | MIT |
|
||||
| [Wrangler](https://developers.cloudflare.com/workers/wrangler/) 4 | Local Worker dev, D1 migrations, deploys | MIT OR Apache-2.0 |
|
||||
| [`@tauri-apps/cli`](https://tauri.app) 2 | Building the desktop and Android apps | Apache-2.0 OR MIT |
|
||||
| `@types/node`, `@types/react`, `@types/react-dom` | Type definitions | MIT |
|
||||
| [pytest](https://pytest.org) | Python tests (network blocked) | MIT |
|
||||
| [pytest-cov](https://pytest-cov.readthedocs.io) and [coverage.py](https://coverage.readthedocs.io) | Python test coverage for SonarQube Cloud (`pytest --cov`) | MIT; Apache-2.0 |
|
||||
| [Pillow](https://python-pillow.github.io) | [`webapp/scripts/gen_assets.py`](../webapp/scripts/gen_assets.py), which generates the icons and the social preview image | MIT-CMU |
|
||||
|
||||
## 6. GitHub Actions
|
||||
@@ -124,7 +128,8 @@ These tools never end up in a build, but they keep the code honest.
|
||||
The workflows in [`.github/workflows/`](../.github/workflows/) use `actions/checkout`, `actions/setup-node`,
|
||||
`actions/setup-python`, `actions/setup-java`, `actions/cache`, `actions/upload-artifact`,
|
||||
`actions/download-artifact`, `android-actions/setup-android`, `dtolnay/rust-toolchain`,
|
||||
`tauri-apps/tauri-action` and reusable workflows from [poli0981/.github](https://github.com/poli0981/.github).
|
||||
`tauri-apps/tauri-action`, `SonarSource/sonarqube-scan-action`, `JetBrains/qodana-action` and reusable workflows from
|
||||
[poli0981/.github](https://github.com/poli0981/.github).
|
||||
Every external action is pinned to a commit SHA. The actions run on GitHub's runners and are not
|
||||
distributed with the project; each one is under the license in its own repository.
|
||||
|
||||
@@ -135,6 +140,8 @@ distributed with the project; each one is under the license in its own repositor
|
||||
| **Cloudflare** | DNS, CDN, WAF, TLS; Workers and static assets (the website); R2 (resized cover images); D1 (the review queue); Images (resizing); Turnstile (the verification page and the Suggest page); Web Analytics (cookieless, aggregate); Workers Logs; Access (admin login); Rate Limiting |
|
||||
| **Google Workspace** | The Maintainer's mailbox on poli0981.dev, which receives the project's contact addresses |
|
||||
| **GitHub** | Code, catalog data, issues and discussions, Actions (the pipeline), release downloads |
|
||||
| **SonarQube Cloud** (SonarSource) | Code analysis and test coverage of the public repository, on pushes to `main` and on pull requests |
|
||||
| **Qodana** (JetBrains) | Code analysis of the public repository (TypeScript / JavaScript, Python, Rust), on pushes to `main` and on pull requests |
|
||||
| **itch.io** | Where the games live; the pipeline and RSS discovery read public itch.io pages and feeds |
|
||||
| **Discord** | Receives automated CI and release notifications only |
|
||||
|
||||
|
||||
+4
-4
@@ -1,8 +1,8 @@
|
||||
# Terms of Use
|
||||
|
||||
Last updated: 2026-10-03
|
||||
Last updated: 2026-10-16
|
||||
|
||||
Applies from: 2026-10-03 on the Website, and from version 4.2.0 of the Apps.
|
||||
Applies from: 2026-10-13 on the Website, and from version 4.4.0 of the Apps.
|
||||
|
||||
These Terms of Use ("Terms") govern your use of the website **https://freeitchgames.win**, the desktop and Android apps, and the public catalog data of `free-games-itchio-list`. They are written in plain language, but they are a real agreement. They replace the older Terms and also cover what the old web-app "EULA" used to say; the [EULA](EULA.md) now covers only the app installers and the Android APK.
|
||||
|
||||
@@ -47,7 +47,7 @@ These Terms of Use ("Terms") govern your use of the website **https://freeitchga
|
||||
|
||||
- **Suggest page** (https://freeitchgames.win/suggest): you can submit an itch.io game link and an optional note of up to 500 characters. The page uses Cloudflare Turnstile against spam and is rate limited.
|
||||
- The note is seen only by the Maintainer and is deleted after 180 days. **Do not put personal data in it.** See the [Privacy Policy](PrivacyPolicy.md).
|
||||
- Every suggestion goes into a **review queue**. Nothing enters the Catalog until the Maintainer approves it, and the Maintainer has no obligation to accept a suggestion or to reply. Approved links are then scraped by the pipeline, and games that turn out to be paid are dropped.
|
||||
- Every suggestion goes into a **review queue**. The Maintainer approves or rejects it there, one by one or through automatic rules the Maintainer sets: a suggestion that raises no warning flag and that nobody rejected within the waiting time the Maintainer chose (currently about a day) may be approved automatically. The Maintainer has no obligation to accept a suggestion or to reply. Approved links are then scraped by the pipeline, and games that turn out to be paid are dropped.
|
||||
- Only genuinely **free-to-play** games on itch.io qualify. Demos of paid games, "name your own price" titles with a minimum above zero, and time-limited free promotions do not.
|
||||
- By submitting anything to the Project (a suggestion, an issue, a pull request or a comment), you confirm that:
|
||||
- it is your own work, or you have the right to share it;
|
||||
@@ -62,7 +62,7 @@ You agree **not** to:
|
||||
|
||||
1. **Bulk-scrape** the Website or its API, including the files under `/data`. Get the data from the Repository instead; it is cheaper for everyone.
|
||||
2. **Abuse the image proxy** (`/img`): it exists only to show cover images on the Website. Don't hotlink `/img` URLs from other sites or apps, and don't use it to fetch images in bulk.
|
||||
3. **Access restricted areas without authorization**: `/admin`, the admin API (`/api/admin/…`) and the ingest API (`/api/ingest`) are for the Maintainer only. Good-faith security research is welcome under the rules of the [Security Policy](../SECURITY.md).
|
||||
3. **Access restricted areas without authorization**: `/admin` and the admin API (`/api/admin/…`) are for the Maintainer only. Good-faith security research is welcome under the rules of the [Security Policy](../SECURITY.md).
|
||||
4. **Spam the Suggest form**, or circumvent the Website's verification check, Turnstile or the rate limits (for example with scripts, shared verification cookies or rotating IP addresses).
|
||||
5. **Submit links to malware**, scams, phishing, or illegal content, anywhere in the Project.
|
||||
6. **Misrepresent affiliation**: don't claim to be the Maintainer or the Project, don't present a fork or copy as the official Project, don't claim that the Project is run or endorsed by itch.io, and don't use the names "poli0981" or "SkullMute" to endorse your own work without prior written permission.
|
||||
|
||||
+26
-5
@@ -15,12 +15,17 @@ JetBrains 2026.x (paid lineup):
|
||||
VS Code, Sublime, vim, etc. all work fine; nothing JetBrains-specific is
|
||||
checked into the repo.
|
||||
|
||||
TypeScript 7 (the `tsc` that `npm run build` runs) is a native binary without `tsserver`. In VS Code,
|
||||
install the TypeScript Native Preview extension (`TypeScriptTeam.native-preview`) for the TS 7
|
||||
language server. In WebStorm, use its TypeScript 7 support or point *Languages & Frameworks →
|
||||
TypeScript* at `webapp/node_modules/@typescript/old` (TypeScript 6.0, which reports the same errors).
|
||||
|
||||
## Language toolchains
|
||||
|
||||
| Stack | Required | Used for |
|
||||
|-------|----------|----------|
|
||||
| Python | 3.14 (`.python-version`) | Data pipeline (`scripts/`) and its tests |
|
||||
| Node.js | 22.22+ (CI uses `webapp/.node-version`) | Web app, admin app, Worker, Tauri front end |
|
||||
| Python | 3.15 (`.github/python-version`) | Data pipeline (`scripts/`) and its tests |
|
||||
| Node.js | 26+ (CI uses `webapp/.node-version`) | Web app, admin app, Worker, Tauri front end |
|
||||
| npm | ships with Node.js | Dependencies (`npm ci` from `package-lock.json`) |
|
||||
| Wrangler | project dependency (`npx wrangler`) | Local Worker, local D1, deploys |
|
||||
| Rust | stable (via `rustup`) | Tauri desktop / Android builds only |
|
||||
@@ -39,8 +44,13 @@ python -m venv .venv
|
||||
pip install -r requirements-dev.txt
|
||||
```
|
||||
|
||||
On Windows, set `PYTHONUTF8=1` (PowerShell: `$env:PYTHONUTF8 = "1"`) so Python reads and writes
|
||||
the catalog files as UTF-8.
|
||||
Python 3.15 reads and writes files as UTF-8 by default (UTF-8 mode, PEP 686), so Windows no longer
|
||||
needs `PYTHONUTF8=1`.
|
||||
|
||||
Both requirements files pin every package with its hashes; pip checks them on install. To add or
|
||||
change a dependency, edit `requirements.in` or `requirements-dev.in` and recompile the lock with
|
||||
pip-tools — the command is at the top of each `.in` file (run it on Python 3.14, which Dependabot
|
||||
can read; CLAUDE.md, gotcha 40).
|
||||
|
||||
### Checks (same as `python-ci.yml`)
|
||||
|
||||
@@ -52,6 +62,9 @@ vulture # dead code
|
||||
python scripts/validate.py # checks every catalog data file
|
||||
```
|
||||
|
||||
`pytest --cov --cov-report=xml` also measures coverage and writes `coverage.xml`, as the SonarQube
|
||||
Cloud workflow (`sonarcloud.yml`) does.
|
||||
|
||||
### Try a real scrape
|
||||
|
||||
These make real requests to itch.io:
|
||||
@@ -160,15 +173,23 @@ the queue bookkeeping. Use it sparingly.
|
||||
|
||||
```sh
|
||||
cd webapp
|
||||
npm run check:tauri # Tauri crates and their npm packages share major.minor
|
||||
npm run cf:types -- --check # worker-configuration.d.ts matches wrangler.jsonc
|
||||
npm run lint # ESLint
|
||||
npm run knip # unused files / exports / dependencies
|
||||
npm test # Vitest: app + Worker; D1 tests start a local workerd
|
||||
npx tsc -b # type-check only (npm run build runs it too)
|
||||
npm run build
|
||||
npx wrangler deploy --dry-run --env="" # validates the Worker config, deploys nothing
|
||||
npm run cf:check # wrangler deploy --dry-run: validates the Worker config, deploys nothing
|
||||
```
|
||||
|
||||
`npm run test:coverage` runs the tests with v8 coverage and writes `coverage/lcov.info`, as the
|
||||
SonarQube Cloud workflow (`sonarcloud.yml`) does.
|
||||
|
||||
Qodana (JetBrains) also analyses the code in CI (`qodana.yml`: TypeScript / JavaScript, Python and
|
||||
Rust, each with its own `qodana.yaml`). It needs the project tokens, so it has no local command here;
|
||||
the same inspections are built into WebStorm, PyCharm and RustRover.
|
||||
|
||||
After editing `wrangler.jsonc`, run `npm run cf:types` and commit the regenerated
|
||||
`worker-configuration.d.ts`.
|
||||
|
||||
|
||||
@@ -0,0 +1,196 @@
|
||||
# Trợ năng (Accessibility)
|
||||
|
||||
Cập nhật lần cuối: 2026-11-09
|
||||
|
||||
Áp dụng từ: khi phát hành phiên bản 4.6.0 (website và các ứng dụng desktop, Android).
|
||||
|
||||
> Bản dịch từ bản tiếng Anh cập nhật ngày 2026-11-09 (English source revision 2026-11-09). Nếu có khác biệt, bản tiếng Anh được ưu tiên. Bản gốc: [`ACCESSIBILITY.md`](../../../ACCESSIBILITY.md).
|
||||
|
||||
Đây là một dự án sở thích do một người vận hành, poli0981 (SkullMute), dưới đây gọi là "Người duy trì": một danh mục game itch.io miễn phí, có trên website https://freeitchgames.win và trong các ứng dụng desktop, Android hiển thị cùng các trang đó. Ai cũng nên dùng được, dù bạn chỉ dùng bàn phím, trình đọc màn hình, phóng to, giao diện tương phản cao, nhập liệu bằng giọng nói hay bất cứ công cụ nào khác. Tuyên bố này cho biết những gì đã hoạt động, cách kiểm tra, những gì chưa ổn, và cách báo cho Người duy trì khi có gì đó cản trở bạn.
|
||||
|
||||
> **Tóm tắt (TL;DR)**
|
||||
>
|
||||
> - Mục tiêu là [WCAG 2.2](https://www.w3.org/TR/WCAG22/) mức AA cho website và các ứng dụng. Đó là mục tiêu, không phải chứng nhận: chưa có ai ngoài dự án đánh giá.
|
||||
> - Mọi trang đều dùng được chỉ với bàn phím và với trình đọc màn hình. Người duy trì kiểm tra bằng bàn phím (không dùng chuột), Windows Narrator, và VoiceOver trên iPhone.
|
||||
> - Màu sắc đạt tỉ lệ tương phản WCAG ở cả giao diện sáng và tối, và một bài test kiểm tra lại sau mỗi thay đổi. Hỗ trợ chế độ tương phản (Contrast themes) của Windows và làm theo thiết lập "giảm chuyển động" của hệ thống.
|
||||
> - Mỗi biểu đồ đều có bảng dữ liệu đi kèm.
|
||||
> - Các hạn chế đã biết nằm ở [§6](#6-các-hạn-chế-đã-biết).
|
||||
> - Có gì cản trở bạn? Hãy mở một [issue trợ năng](https://github.com/poli0981/free-games-itchio-list/issues/new?template=accessibility.yml) hoặc email **contact@poli0981.dev**.
|
||||
|
||||
## 1. Phạm vi
|
||||
|
||||
Tuyên bố này áp dụng cho:
|
||||
|
||||
- **website** https://freeitchgames.win: mọi trang công khai (Trang chủ, Games, trang từng game, Charts, Removed, Suggest, Settings, About, các trang lỗi) và trang xác minh hiện ra trước đó;
|
||||
- **các ứng dụng desktop** (Windows, macOS, Linux) **và ứng dụng Android**, vốn hiển thị cùng các trang trong web view của hệ thống.
|
||||
|
||||
Tuyên bố này không áp dụng cho:
|
||||
|
||||
- bản thân các game, trang itch.io của chúng, và những gì người tạo game viết hay làm ra (tên, mô tả, tag, ảnh bìa);
|
||||
- Cloudflare Turnstile, bước kiểm tra của bên thứ ba trên trang xác minh và trên form Suggest (Cloudflare chịu trách nhiệm về trợ năng của nó);
|
||||
- trang quản trị của Người duy trì, vốn chỉ có một người dùng;
|
||||
- các trang web khác được liên kết tới, kể cả GitHub.
|
||||
|
||||
## 2. Mục tiêu và ưu tiên
|
||||
|
||||
- **Mục tiêu**: [WCAG 2.2](https://www.w3.org/TR/WCAG22/) mức AA, trong khả năng của một dự án sở thích do một người làm.
|
||||
- **Trước hết**: các việc chính dùng được với bàn phím và trình đọc màn hình: tìm game, đọc thông tin, mở game trên itch.io, đổi cài đặt, gợi ý game.
|
||||
- **Tiếp theo**: chữ và nút dễ đọc (tương phản, phóng to, dàn lại bố cục), không có chuyển động bạn không yêu cầu, và đúng ngôn ngữ cho trình đọc màn hình (tiếng Anh hoặc tiếng Việt).
|
||||
- **Luôn luôn**: tính năng mới phải giữ được tất cả những điều trên (xem [§8](#8-dành-cho-người-đóng-góp)).
|
||||
|
||||
## 3. Những gì đã hoạt động
|
||||
|
||||
### Di chuyển trong trang
|
||||
|
||||
- "Chuyển đến nội dung" (Skip to content) là thứ đầu tiên phím Tab chạm tới.
|
||||
- Mỗi trang có các vùng mốc (landmark) được đặt tên (đầu trang, menu chính, tìm kiếm, nội dung chính, phân trang, chân trang), một tiêu đề cấp 1 và tiêu đề trang riêng.
|
||||
- Khi bạn bấm một liên kết bên trong site, focus chuyển tới tiêu đề của trang mới, nên trình đọc màn hình đọc tên trang và phím Tab đi tiếp từ đó. Khi quay lại, focus trở về liên kết bạn vừa dùng, ví dụ game bạn mở từ danh sách.
|
||||
- Thanh đầu trang cố định không bao giờ che phần tử đang có focus bàn phím.
|
||||
|
||||
### Bàn phím
|
||||
|
||||
- Mọi thứ đều dùng được chỉ với bàn phím: menu, bộ lọc, hộp thoại và biểu đồ.
|
||||
- Focus luôn nhìn thấy được: một đường viền tím, hoặc màu tô sáng của hệ thống trong chế độ tương phản.
|
||||
- Hộp thoại giữ focus bên trong khi đang mở và trả focus về chỗ cũ khi đóng.
|
||||
- Phím "/" đưa bạn tới ô tìm kiếm. Bạn có thể tắt phím tắt này trong **Settings → Trợ năng**, hữu ích khi nhập liệu bằng giọng nói hoặc khi phím này xung đột với trình đọc màn hình hay chức năng tìm nhanh của trình duyệt.
|
||||
- Khi một nút biến mất sau khi bạn dùng nó (xoá ô tìm kiếm, bỏ một bộ lọc), focus chuyển tới chỗ hợp lý tiếp theo thay vì bị mất.
|
||||
|
||||
### Trình đọc màn hình
|
||||
|
||||
- Mọi nút điều khiển đều có tên, bằng tiếng Anh hoặc tiếng Việt. Biểu tượng được ẩn khỏi trình đọc màn hình.
|
||||
- Số kết quả, gợi ý tìm kiếm, trạng thái đang tải và thông báo của form đều được đọc lên.
|
||||
- Trên màn hình rộng, danh sách game là một bảng có tiêu đề cột; trên điện thoại là một danh sách đơn giản.
|
||||
- Liên kết mở thẻ mới (trong ứng dụng: mở trình duyệt) đều nói rõ điều đó.
|
||||
- Chữ thuộc ngôn ngữ kia, như tên các ngôn ngữ và tên tiếng Anh của các văn bản pháp lý, được đánh dấu đúng ngôn ngữ.
|
||||
|
||||
### Nhìn nội dung
|
||||
|
||||
- Chữ và nút đạt tỉ lệ tương phản WCAG 2.2 AA ở cả hai giao diện: 4.5:1 cho chữ, 3:1 cho viền ô nhập, đường viền focus và màu biểu đồ. Bài test [`webapp/scripts/check-contrast.test.mjs`](../../../webapp/scripts/check-contrast.test.mjs) kiểm tra màu sau mỗi thay đổi.
|
||||
- Giao diện sáng, tối hoặc theo hệ thống; dòng gọn hoặc thường; ẩn thanh cuộn: tất cả nằm trong Settings.
|
||||
- Chế độ tương phản của Windows (forced colors): tab đang chọn, nút bật/tắt đang bấm, trang hiện tại và các công tắc dùng màu tô sáng của hệ thống.
|
||||
- Không bao giờ chặn phóng to. Ở mức phóng 400 % hoặc cửa sổ rộng 320 pixel, bố cục điện thoại được dùng và trang không phải cuộn ngang.
|
||||
- Liên kết nằm trong câu đều được gạch chân. Không có gì chỉ dựa vào màu sắc: trạng thái luôn kèm thay đổi chữ, viền hoặc gạch chân.
|
||||
|
||||
### Chuyển động
|
||||
|
||||
- Khi bạn bật "giảm chuyển động" trong hệ thống, hiệu ứng, phần biểu đồ hiện ra và cuộn mượt đều tắt.
|
||||
- Trên website, ảnh bìa thường được hiển thị dạng ảnh tĩnh (ảnh bìa động được chuyển thành ảnh tĩnh).
|
||||
- Ngoài các khối giữ chỗ khi đang tải, không có gì tự chuyển động.
|
||||
|
||||
### Biểu đồ
|
||||
|
||||
- Mỗi biểu đồ được đặt tên theo tiêu đề của nó. Đưa focus vào biểu đồ rồi dùng phím mũi tên trái, phải: giá trị bạn chuyển tới sẽ được đọc lên.
|
||||
- Dưới mỗi biểu đồ, **Bảng dữ liệu** mở cùng các số liệu dưới dạng bảng, kèm tỉ lệ từng phần với biểu đồ tròn.
|
||||
|
||||
### Ngôn ngữ
|
||||
|
||||
- Các trang có tiếng Anh và tiếng Việt (Settings), và ngôn ngữ của trang đi theo lựa chọn của bạn, nên trình đọc màn hình chọn đúng giọng đọc. Số và ngày tháng cũng theo ngôn ngữ đó.
|
||||
|
||||
## 4. Cách kiểm tra
|
||||
|
||||
- **Người duy trì kiểm tra thủ công** (tháng 11/2026): website trên Windows 11 và ứng dụng desktop Windows, chỉ dùng bàn phím (tắt chuột) và Windows Narrator. Không thấy lỗi nào chặn việc sử dụng.
|
||||
- **Trên điện thoại thật** (tháng 11/2026, phiên bản 4.6.0): website trên iPhone 14 Pro với VoiceOver, trong Safari, Chrome và Brave. Kết quả: đạt.
|
||||
- **Cho bản 4.6.0**: các trang chính và hộp thoại được đi hết bằng bàn phím, và cây trợ năng (accessibility tree) của chúng được kiểm tra (tên, vai trò, tiêu đề, vùng mốc, thông báo) bằng tiếng Anh và tiếng Việt, trên màn hình máy tính và màn hình cỡ điện thoại.
|
||||
- **Tự động, sau mỗi thay đổi**: bài test tương phản ở trên và các unit test của ứng dụng (focus đi đâu sau khi đổi trang, bảng dữ liệu biểu đồ).
|
||||
- **Trước mỗi lần phát hành**: một lượt kiểm tra nhanh. Gồm đi hết các việc chính bằng bàn phím, thử nhanh với trình đọc màn hình, phóng to 200 % và cửa sổ hẹp, giảm chuyển động, và một chế độ tương phản của Windows.
|
||||
- **Chưa có**: quét tự động trên trình duyệt (như axe hay Lighthouse) trong CI, và việc kiểm tra bởi những người dùng hằng ngày nhiều công cụ hỗ trợ khác nhau. Mọi sự giúp đỡ đều được hoan nghênh.
|
||||
|
||||
## 5. Môi trường được hỗ trợ
|
||||
|
||||
| | Phiên bản |
|
||||
|---|---|
|
||||
| Website | Chrome, Edge, Firefox và Safari hiện hành trên máy tính và điện thoại. Các phiên bản cũ nhất mà site được build cho là Chrome và Edge 111, Firefox 114, Safari và iOS 15.4. |
|
||||
| Ứng dụng desktop | Windows 10 và 11 (Microsoft Edge WebView2), macOS (WebKit 16.4 trở lên), Linux (WebKitGTK 4.1) |
|
||||
| Ứng dụng Android | Android 11 trở lên |
|
||||
|
||||
Công cụ hỗ trợ (assistive technology):
|
||||
|
||||
- **Đã kiểm tra**: Windows Narrator trên Windows 11, VoiceOver trên iOS (iPhone 14 Pro: Safari, Chrome và Brave), và dùng chỉ bàn phím.
|
||||
- **Dự kiến dùng được, chưa kiểm tra thường xuyên**: NVDA và JAWS trên Windows, VoiceOver trên macOS, TalkBack trên Android, phóng to của trình duyệt, chế độ tương phản của Windows, nhập liệu bằng giọng nói. Chúng dựa trên cùng mã HTML chuẩn.
|
||||
- **Hạn chế**: Orca trong ứng dụng desktop Linux, vì WebKitGTK hỗ trợ trình đọc màn hình kém hơn các trình duyệt.
|
||||
|
||||
## 6. Các hạn chế đã biết
|
||||
|
||||
- **Chữ của người tạo game không được đánh dấu ngôn ngữ.** Tên, mô tả và tag của game lấy từ itch.io bằng nhiều ngôn ngữ, và trình đọc màn hình đọc chúng theo ngôn ngữ của trang.
|
||||
- **Ảnh bìa chỉ có mô tả chung** ("Tên game cover"). Nội dung bức ảnh không được mô tả.
|
||||
- **Biểu đồ**: phím mũi tên chỉ di chuyển trái và phải. Biểu đồ treemap thể loại không đi từng phần được, nhưng số liệu của nó có trong bảng dữ liệu và trong biểu đồ Genres. Chữ trong biểu đồ có cỡ pixel cố định, nên tăng cỡ chữ mặc định của trình duyệt không làm nó to lên (phóng to trang thì có).
|
||||
- **Ứng dụng desktop**: không có phím phóng to bên trong ứng dụng, cửa sổ không phóng to toàn màn hình (maximize) được, và không thu nhỏ hơn 900 × 600. Nếu cần chữ lớn hơn, hãy dùng tỉ lệ hiển thị (display scaling) của hệ thống hoặc mở website trong trình duyệt.
|
||||
- **Ứng dụng Android**: không phóng to bằng hai ngón tay được. Website trong trình duyệt điện thoại thì phóng to được.
|
||||
- **Ảnh bìa động trong ứng dụng**: ứng dụng tải ảnh bìa trực tiếp từ itch.io, nên ảnh bìa động vẫn chạy ở đó.
|
||||
- **Bước kiểm tra của Cloudflare**: bước xác minh (chỉ trên website) và bước chống spam của form Suggest là widget Cloudflare Turnstile. Thường chúng tự qua mà bạn không cần làm gì. Nếu có lúc chúng yêu cầu điều bạn không làm được, hãy email Người duy trì.
|
||||
- **Trang trên GitHub**: các chính sách, tuyên bố này và các form issue nằm trên GitHub, nên trợ năng của chính GitHub áp dụng ở đó.
|
||||
- **Chưa có đánh giá độc lập**, và chỉ có một người duy trì.
|
||||
|
||||
## 7. Báo cáo rào cản trợ năng
|
||||
|
||||
Nếu có gì ngăn bạn hoặc làm bạn chậm lại, hãy cho biết. Báo cáo chưa đầy đủ cũng có ích.
|
||||
|
||||
- **GitHub**: mở một [issue Accessibility barrier](https://github.com/poli0981/free-games-itchio-list/issues/new?template=accessibility.yml).
|
||||
- **Email**: **contact@poli0981.dev**. Không cần tài khoản GitHub; viết tiếng Anh hay tiếng Việt đều được.
|
||||
|
||||
Những chi tiết có ích, trong chừng mực bạn thấy thoải mái chia sẻ (đừng bao giờ gửi thông tin sức khoẻ):
|
||||
|
||||
- bạn đang định làm gì, và điều gì đã xảy ra;
|
||||
- trang (địa chỉ) hoặc ứng dụng và phiên bản của nó, xem trên trang About;
|
||||
- thiết bị, hệ điều hành và trình duyệt;
|
||||
- công cụ hỗ trợ bạn dùng và phiên bản, nếu có;
|
||||
- ảnh chụp màn hình hoặc video, nếu được.
|
||||
|
||||
Mức độ ảnh hưởng:
|
||||
|
||||
| Mức độ | Ý nghĩa |
|
||||
|---|---|
|
||||
| Critical (nghiêm trọng nhất) | Bạn hoàn toàn không làm được một việc chính, ví dụ mở game hay đọc thông tin của nó. |
|
||||
| Serious (nghiêm trọng) | Bạn làm được, nhưng rất vất vả hoặc phải đi đường vòng. |
|
||||
| Moderate (trung bình) | Gây phiền hoặc không nhất quán, nhưng vẫn làm được. |
|
||||
| Minor (nhỏ) | Một chi tiết nhỏ cần chỉnh. |
|
||||
|
||||
Điều gì xảy ra tiếp theo. Đây là mục tiêu, không phải cam kết, vì đây là dự án sở thích của một người:
|
||||
|
||||
- **Xác nhận đã nhận** trong vòng 7 ngày, thường sớm hơn.
|
||||
- **Sửa lỗi hoặc đưa cách khắc phục tạm**: Critical trong 30 ngày, Serious trong 60 ngày, Moderate và Minor ở một bản phát hành sau.
|
||||
- **Bản sửa cho website** có hiệu lực khi được deploy; **bản sửa cho ứng dụng** đi kèm bản phát hành tiếp theo.
|
||||
- Bạn sẽ được hỏi bản sửa đã ổn với bạn chưa, và được ghi công trong release notes nếu muốn.
|
||||
|
||||
Lỗ hổng bảo mật không nên đưa vào issue công khai: xem [Chính sách bảo mật](SECURITY.md).
|
||||
|
||||
## 8. Dành cho người đóng góp
|
||||
|
||||
Thay đổi giao diện phải giữ đúng những điều ở [§3](#3-những-gì-đã-hoạt-động):
|
||||
|
||||
- **Bàn phím**: mọi nút đều tới được và dùng được, focus luôn nhìn thấy và không bị mất.
|
||||
- **Tên**: mọi nút có nhãn, với chữ có trong cả `webapp/src/lib/i18n/en.ts` và `vi.ts`.
|
||||
- **Màu sắc**: dùng các token của theme. `npm test` kiểm tra tương phản (4.5:1 cho chữ, 3:1 cho viền, focus và màu biểu đồ), và màu sắc không bao giờ là tín hiệu duy nhất.
|
||||
- **Chuyển động**: tôn trọng `prefers-reduced-motion`; quy tắc CSS dùng chung và `SERIES_ANIMATION` đã làm việc đó.
|
||||
- **Trình đọc màn hình**: kiểm tra thay đổi ít nhất một lần với một trình đọc (Narrator, NVDA, VoiceOver hoặc TalkBack).
|
||||
- **Mã HTML**: ưu tiên phần tử gốc và các component Radix / shadcn đang dùng, chỉ thêm ARIA khi thật cần.
|
||||
|
||||
Tài liệu: tiêu đề theo đúng thứ tự, chữ của liên kết nói rõ nó dẫn tới đâu, ảnh có alt, bảng có ô tiêu đề, và bản tiếng Việt được cập nhật (hoặc ghi rõ trong pull request là chưa).
|
||||
|
||||
[Pull request template](../../../.github/pull_request_template.md) có sẵn danh sách kiểm tra.
|
||||
|
||||
## 9. Tìm game có hỗ trợ tiếp cận
|
||||
|
||||
Danh mục hiển thị các tính năng hỗ trợ tiếp cận mà người tạo game liệt kê trên trang itch.io của họ, như phụ đề, điều khiển tuỳ chỉnh được hay chế độ cho người mù màu:
|
||||
|
||||
- trên trang của từng game, ở mục "Hỗ trợ tiếp cận";
|
||||
- trong bộ lọc Hỗ trợ tiếp cận ở trang Games, ví dụ https://freeitchgames.win/games?access=Subtitles;
|
||||
- trong biểu đồ "Tính năng hỗ trợ tiếp cận" (Charts → Khám phá).
|
||||
|
||||
Người tạo game tự khai báo các tính năng này, và dự án không kiểm chứng. Nếu thông tin của một game sai, hãy báo bằng issue template "Bug Report".
|
||||
|
||||
## 10. Tài liệu tham khảo
|
||||
|
||||
- [Open Source Guides: Accessibility best practices for your project](https://opensource.guide/accessibility-best-practices-for-your-project/)
|
||||
- [Open Source Accessibility toolkit](https://github.com/open-source-accessibility/accessibility-toolkit): tuyên bố này theo dàn ý của mẫu ACCESSIBILITY.md trong đó, với lời văn riêng.
|
||||
- [Web Content Accessibility Guidelines (WCAG) 2.2](https://www.w3.org/TR/WCAG22/)
|
||||
- [W3C: Developing an accessibility statement](https://www.w3.org/WAI/planning/statements/)
|
||||
|
||||
## 11. Liên hệ
|
||||
|
||||
- **Rào cản trợ năng**: [form issue](https://github.com/poli0981/free-games-itchio-list/issues/new?template=accessibility.yml) hoặc **contact@poli0981.dev**.
|
||||
- **Mọi việc khác**: xem các địa chỉ trong [README → Pháp lý](../../../README.vi.md#pháp-lý).
|
||||
|
||||
## 12. Lời cuối
|
||||
|
||||
Một người, một danh mục, và mọi cách duyệt web. Nếu có gì ở đây không hợp với cách bạn dùng web, Người duy trì thật sự muốn được biết — đó là cách danh sách này ngày càng tốt hơn. 🚀
|
||||
@@ -4,7 +4,7 @@ Cập nhật lần cuối: 2026-09-29
|
||||
|
||||
Áp dụng từ: khi phát hành phiên bản 4.0.0.
|
||||
|
||||
> Bản dịch từ bản tiếng Anh cập nhật ngày 2026-09-18 (English source revision 2026-09-18). Nếu có khác biệt, bản tiếng Anh được ưu tiên. Bản gốc: [`CODE_OF_CONDUCT.md`](../../../CODE_OF_CONDUCT.md).
|
||||
> Bản dịch từ bản tiếng Anh cập nhật ngày 2026-09-29 (English source revision 2026-09-29). Nếu có khác biệt, bản tiếng Anh được ưu tiên. Bản gốc: [`CODE_OF_CONDUCT.md`](../../../CODE_OF_CONDUCT.md).
|
||||
|
||||
Đây là một repo sở thích nhỏ về game itch.io miễn phí, do một dev noob đang thất nghiệp vận hành: poli0981 (SkullMute), dưới đây gọi là "Người duy trì". Nói đơn giản: hãy cư xử đàng hoàng. Người duy trì là introvert max level với kỹ năng xã hội bằng không, nên mình cùng giữ mọi thứ tích cực nhé.
|
||||
|
||||
|
||||
@@ -1,14 +1,22 @@
|
||||
# Hướng dẫn đóng góp
|
||||
|
||||
> Bản dịch từ bản tiếng Anh cập nhật ngày 2026-09-24 (English source revision 2026-09-24). Nếu có khác biệt, bản tiếng Anh được ưu tiên.
|
||||
> Bản dịch từ bản tiếng Anh cập nhật ngày 2026-11-11 (English source revision 2026-11-11). Nếu có khác biệt, bản tiếng Anh được ưu tiên.
|
||||
>
|
||||
> Bản tiếng Anh tại [`CONTRIBUTING.md`](../../../CONTRIBUTING.md) là bản chính thức.
|
||||
|
||||
Cảm ơn bạn vì đã có suy nghĩ đóng góp cho cái repo random này! Tôi chỉ là một dev người Việt thất nghiệp, hướng nội, kỹ năng tầm tầm, có hai trợ lý AI không phán xét: **Grok (xAI)** cho brainstorming đêm khuya và **Claude Code (Anthropic)** cho phần việc code/docs nặng hơn. Danh sách này sống nhờ sự giúp đỡ của cộng đồng, vì tôi quá lười để tự đi săn/sửa hết một mình :D Bất kỳ đóng góp nào (kể cả chỉ một game) cũng khiến bạn thành huyền thoại.
|
||||
|
||||
## Trạng thái dự án: ổn định, chỉ bảo trì
|
||||
|
||||
Từ phiên bản 4.6.1 (2026-11-11), dự án ở trạng thái **ổn định và chỉ bảo trì**. Dự án đã đủ tính năng: website, các ứng dụng và pipeline dữ liệu vẫn chạy, danh mục vẫn tự cập nhật.
|
||||
|
||||
- **Maintainer vẫn làm**: vá bảo mật (CVE và báo cáo gửi qua [SECURITY](SECURITY.md)), cập nhật runtime và thư viện phụ thuộc, và sửa khi có gì đó làm website hoặc việc cập nhật dữ liệu hằng ngày ngừng chạy.
|
||||
- **Không còn làm**: tính năng mới, thiết kế lại, refactor.
|
||||
- **Issue và pull request chỉ được nhận cho dữ liệu**: thêm game (mục 1), sửa dữ liệu của một game hoặc gỡ game (mục 2 và 3). Rào cản trợ năng (mục 3) và báo cáo bảo mật vẫn giữ kênh riêng. Mọi thứ khác sẽ bị đóng mà không review; không giận gì nhau cả.
|
||||
|
||||
## Cách đóng góp (Đi đúng cửa, tôi lười ;D)
|
||||
|
||||
Game thì gửi qua website; mọi thứ khác thì qua các template issue/PR trên GitHub. Chúng làm cuộc đời tôi dễ hơn và giảm các khoảnh khắc "wtf".
|
||||
Game thì gửi qua website; sửa dữ liệu và gỡ game thì qua các issue template trên GitHub hoặc email. Chúng làm cuộc đời tôi dễ hơn và giảm các khoảnh khắc "wtf".
|
||||
|
||||
### 1. Đề xuất game mới (Hoan nghênh nhất!)
|
||||
|
||||
@@ -16,16 +24,17 @@ Game thì gửi qua website; mọi thứ khác thì qua các template issue/PR t
|
||||
- Tùy chọn: một ghi chú ngắn (vì sao game hay, cảnh báo nội dung…), tối đa 500 ký tự. Ghi chú bị xóa sau 180 ngày. Vui lòng đừng ghi dữ liệu cá nhân vào đó.
|
||||
- Một bước kiểm tra Cloudflare Turnstile và giới hạn tần suất giúp chặn bot; nếu bị chặn, đợi một lúc rồi thử lại.
|
||||
- Chỉ game itch.io **miễn phí**. Game trả phí sẽ tự động bị loại khi trang game được cào.
|
||||
- Không có gì lên site ngay lập tức: mọi đề xuất đều vào **hàng chờ duyệt**, và không có gì vào danh mục cho tới khi Maintainer duyệt. Link được duyệt sau đó được pipeline dữ liệu cào và xuất hiện trên site sau lần deploy kế tiếp.
|
||||
- Game phải chơi được hoặc tải được **ngay trên trang itch.io của nó** (bản chạy trên trình duyệt hoặc file đã tải lên). Trang chỉ dẫn sang launcher hay link tải ở site khác thì không đủ điều kiện, kể cả khi miễn phí: [Tuyên bố miễn trừ](DISCLAIMER.md) nói với người dùng rằng mọi lượt tải diễn ra trên itch.io.
|
||||
- Không có gì lên site ngay lập tức: mọi đề xuất đều vào **hàng chờ duyệt**, nơi Maintainer duyệt hoặc từ chối, bằng tay hoặc qua quy tắc tự động (một đề xuất không có cờ cảnh báo mà không ai từ chối trong khoảng một ngày có thể được duyệt tự động). Link được duyệt sau đó được pipeline dữ liệu cào và xuất hiện trên site sau lần deploy kế tiếp.
|
||||
|
||||
Có cả một danh sách? Issue template **[Add Games (bulk list)]** nhận tối đa 15 link một lần, và một PR thêm URL itch.io vào `scripts/temp_link.json` cũng được (dùng PR template [Add Games]). Cả hai đều đi qua cùng quy trình duyệt: Maintainer kiểm tra từng link trước khi đưa vào hàng chờ, và việc merge một PR như vậy chính là sự phê duyệt. Vui lòng đừng sửa tay `data_game/`: các file đó do pipeline quản lý (xem [mục 7](#7-gửi-thay-đổi-code-pr)).
|
||||
Có cả một danh sách? Issue template **[Add Games (bulk list)]** nhận tối đa 15 link một lần, và một PR thêm URL itch.io vào `scripts/temp_link.json` cũng được (dùng PR template [Add Games]). Cả hai đều đi qua cùng quy trình duyệt: Maintainer kiểm tra từng link trước khi đưa vào hàng chờ, và việc merge một PR như vậy chính là sự phê duyệt. Vui lòng đừng sửa tay `data_game/`: các file đó do pipeline quản lý (xem [mục 7](#7-pull-request)).
|
||||
|
||||
#### 1b. Những cách khác để game được thêm vào
|
||||
|
||||
- Extension trình duyệt đi kèm của Maintainer ([itch-f2p-extension](https://github.com/poli0981/itch-f2p-extension), repo riêng, GPL-3.0) gửi link qua một API có xác thực trong lúc duyệt itch.io. Đây là công cụ riêng của Maintainer, không phải kênh gửi công khai.
|
||||
- Website đọc các RSS feed công khai của itch.io về game miễn phí mới và phổ biến mỗi 4 giờ (mỗi lượt một feed) và đưa những gì tìm được vào hàng chờ.
|
||||
- Website cũng đọc các collection công khai trên itch.io mà Maintainer theo dõi và đưa thẳng game miễn phí mới của chúng vào hàng chờ ingest (game từng bị gỡ, hoặc có cờ cảnh báo, thì vào hàng chờ duyệt).
|
||||
|
||||
Cả hai đều vào cùng hàng chờ duyệt với trang Suggest. (Đường thêm game qua Telegram bot cũ đã ngừng hoạt động.)
|
||||
RSS feed vào cùng hàng chờ duyệt với trang Suggest. (Extension trình duyệt của Maintainer và Telegram bot cũ đã ngừng hoạt động; repo của chúng, [itch-f2p-extension](https://github.com/poli0981/itch-f2p-extension) và [telegram-scraper-bot](https://github.com/poli0981/telegram-scraper-bot), đã được lưu trữ (archive).)
|
||||
|
||||
### 2. Gỡ game hoặc sửa dữ liệu game
|
||||
|
||||
@@ -35,56 +44,58 @@ Cả hai đều vào cùng hàng chờ duyệt với trang Suggest. (Đường t
|
||||
- Ghi rõ URL game, bạn là ai (người tạo / chủ sở hữu quyền, hoặc người được họ ủy quyền) và lý do.
|
||||
- Maintainer sẽ gỡ bản ghi khỏi danh mục (ghi kèm lý do trên [trang game đã gỡ](https://freeitchgames.win/removed) công khai) và xóa các bản ảnh bìa thu nhỏ mà site lưu trữ; các bản trong cache sẽ tự hết hạn. Mục tiêu: trong vòng 7 ngày, yêu cầu pháp lý khẩn cấp thì sớm hơn.
|
||||
- Lưu ý: đây là một repo git công khai, nên các phiên bản cũ vẫn còn trong lịch sử. Việc viết lại lịch sử công khai chỉ được làm trong trường hợp ngoại lệ vì bắt buộc về pháp lý.
|
||||
- `safe_virus` / `nsfw` / ghi chú bị sai, hoặc lỗi dữ liệu khác không phải yêu cầu gỡ? Mở issue **[Bug Report]** cũng được.
|
||||
- `safe_virus` / `nsfw` / ghi chú bị sai, hoặc lỗi dữ liệu khác không phải yêu cầu gỡ? Dùng issue template **[Report a problem]** (mục 3).
|
||||
|
||||
Chi tiết có trong [Điều khoản sử dụng](ToS.md) và [Tuyên bố miễn trừ](DISCLAIMER.md).
|
||||
|
||||
### 3. Báo lỗi
|
||||
### 3. Báo sự cố (dữ liệu sai, có gì đó bị hỏng)
|
||||
|
||||
- Mở issue → template **[Bug Report]**.
|
||||
- Checkbox cho các lỗi thường gặp (link chết, cờ sai, trang hỏng, v.v.).
|
||||
- Mở issue → template **[Report a problem]** ([link trực tiếp](https://github.com/poli0981/free-games-itchio-list/issues/new?template=bug_report.yml)).
|
||||
- Dành cho **lỗi dữ liệu** (link chết, sai tên, thể loại, tag, ảnh bìa, cờ `nsfw` hoặc `safe_virus`…) và cho **những thứ bị hỏng** (một trang hay ứng dụng ngừng hoạt động, danh mục không còn cập nhật). Không dành cho ý tưởng: xem mục 4.
|
||||
- Chi tiết + ảnh chụp màn hình + mức độ khẩn cấp.
|
||||
- **Vấn đề bảo mật không phải lỗi để đăng lên tracker công khai.** Hãy báo cáo riêng tư: xem [SECURITY](SECURITY.md).
|
||||
- Nếu phức tạp, xem mục "Muốn thảo luận thêm?" bên dưới.
|
||||
- **Vấn đề bảo mật không dành cho tracker công khai.** Hãy báo cáo riêng tư: xem [SECURITY](SECURITY.md).
|
||||
- **Rào cản trợ năng** (bàn phím, trình đọc màn hình, phóng to, tương phản, chuyển động…): dùng template **[Accessibility barrier]** ([link trực tiếp](https://github.com/poli0981/free-games-itchio-list/issues/new?template=accessibility.yml)), hoặc gửi email tới contact@poli0981.dev nếu bạn không muốn dùng GitHub. Điều gì xảy ra tiếp theo nằm trong [Trợ năng](ACCESSIBILITY.md#7-báo-cáo-rào-cản-trợ-năng).
|
||||
|
||||
### 4. Đề xuất tính năng / cải tiến
|
||||
### 4. Tính năng và cải tiến (đã đóng)
|
||||
|
||||
- Mở issue → template **[Feature Request / Improvement]**.
|
||||
- Chọn loại (tính năng mới hoặc sửa code), tên, lý do, độ ưu tiên (từ "nice to have" tới "repo sắp chết").
|
||||
- Tùy chọn: pseudo-code/snippet (đừng có malware nhé, tôi sẽ check bằng kỹ năng tầm thường của mình :D).
|
||||
- Dự án đang ở chế độ bảo trì: **đề xuất tính năng, ý tưởng cải tiến và thay đổi code không còn được nhận**. Issue và pull request loại này sẽ bị đóng mà không review.
|
||||
- Code dùng giấy phép MIT: bạn cứ thoải mái fork và tự làm phiên bản của mình ([README → Giấy phép](../../../README.vi.md#giấy-phép)).
|
||||
|
||||
### 5. Gửi góp ý
|
||||
### 5. Góp ý, câu hỏi, mọi thứ khác
|
||||
|
||||
- Dùng template **[Feedback]**.
|
||||
- Checkbox (EULA/ToS quá khắt khe? Concept repo dở? Anti-AI? Xóa repo? Khác).
|
||||
- Chê hay khen đều được, sự tự ti của tôi chịu được.
|
||||
- Dùng **[GitHub Discussions](https://github.com/poli0981/free-games-itchio-list/discussions)**, các server Discord hoặc email (xem "Muốn thảo luận thêm?" bên dưới). Chê hay khen đều được, sự tự ti của tôi chịu được.
|
||||
- Tôi có đọc, nhưng chúng không biến thành tính năng mới (mục 4).
|
||||
|
||||
### 6. Mọi thứ khác (câu hỏi, meme, lạc đề)
|
||||
### 6. Thư viện phụ thuộc và vá bảo mật
|
||||
|
||||
- Dùng template **[General / Off-Topic]**.
|
||||
- Có gì trong đầu cứ đăng.
|
||||
- Việc cập nhật thư viện phụ thuộc do Dependabot và đợt rà soát hằng tuần của Maintainer lo: xin đừng gửi PR nâng phiên bản.
|
||||
- Tìm thấy lỗ hổng? Hãy báo cáo riêng tư ([SECURITY](SECURITY.md)); Maintainer sẽ tự vá.
|
||||
|
||||
### 7. Gửi thay đổi code (PR)
|
||||
### 7. Pull request
|
||||
|
||||
- Fork → tạo branch → code → mở PR vào `main` với PR template phù hợp ([Bug Fix], [New Feature], [Documentation]…).
|
||||
- Mô tả rõ ràng giúp nhé. Tôi sẽ review chậm (lịch thất nghiệp + hai AI buddy).
|
||||
- **Được nhận**: PR thêm URL itch.io vào `scripts/temp_link.json` (dùng PR template [Add Games]). Merge PR chính là sự chấp thuận của Maintainer.
|
||||
- **Không được nhận**: mọi thứ khác (code, giao diện, tài liệu, refactor). Sửa hoặc gỡ dữ liệu của một game thì đi qua issue hoặc email (mục 2 và 3), vì pipeline quản lý `data_game/`.
|
||||
- Các quy tắc dưới đây vẫn áp dụng cho mọi PR, kể cả PR của chính Maintainer.
|
||||
|
||||
**Quy tắc PR** (phần không thương lượng):
|
||||
|
||||
- **CI phải pass.** Python CI (ruff check + format, vulture, pytest, `validate.py`) và Webapp CI (kiểm tra type sinh ra, lint, knip, test, build, `wrangler deploy --dry-run`) đều chạy trên PR. CI đỏ = không merge.
|
||||
- **CI phải pass.** Python CI (ruff check + format, vulture, pytest, `validate.py`) và Webapp CI (kiểm tra phiên bản Tauri crate/npm, kiểm tra type sinh ra, lint, knip, test, build, `wrangler deploy --dry-run`) đều chạy trên PR. CI đỏ = không merge. SonarQube Cloud cũng phân tích mỗi PR (kèm test coverage) và báo quality gate qua check "SonarCloud Code Analysis", còn Qodana (JetBrains) phân tích code TypeScript / JavaScript, Python và Rust. Cả hai bỏ qua PR từ fork, vì fork không nhận được secret của repo.
|
||||
- **PR được merge bằng squash** (một PR thành một commit trên `main`) **hoặc merge commit, không bao giờ fast-forward**, nên hãy đặt tiêu đề PR như một commit message tốt (repo dùng kiểu `type(scope): tóm tắt`, ví dụ `fix(web): …`).
|
||||
- **Giấy phép theo nguyên tắc inbound = outbound.** Khi mở PR, bạn đồng ý rằng đóng góp của mình được cấp phép theo cùng giấy phép với phần mà nó thay đổi: **MIT** cho mã nguồn, **CC BY 4.0** cho dữ liệu danh mục và tài liệu (xem [README → Giấy phép](../../../README.vi.md#giấy-phép)). Chỉ gửi những gì bạn có quyền gửi.
|
||||
- **Không bao giờ commit secret**: không token, API key, file `.dev.vars` / `.env`, private key (chẳng hạn khóa của GitHub App) hay keystore dùng để ký. Nếu lỡ push một cái, hãy báo riêng (security@poli0981.dev) và thay mới (rotate) nó; chỉ xóa commit là không đủ.
|
||||
- **Không sửa tay `data_game/`.** Thay đổi dữ liệu phải đi qua pipeline (một patch + `apply_patch.py`, có chạy `validate.py`), để các tiến trình ghi đồng thời không đè lên nhau.
|
||||
- Không commit output build hay file sinh ra: `webapp/dist/`, `webapp/.wrangler/`, `webapp/src-tauri/target/`, `webapp/src-tauri/gen/`. (`webapp/src-tauri/Cargo.lock` **có** được commit; hãy cập nhật nó khi bạn sửa `Cargo.toml`.)
|
||||
- Thêm dependency npm? Thêm luôn vào danh sách `THIRD_PARTY` trong `webapp/src/lib/about.ts` để trang About ghi công.
|
||||
- Link ngoài mới trong app? Dùng `<ExtLink href="…">` từ `webapp/src/components/ext-link.tsx`, đừng dùng `<a href="…" target="_blank">` thuần: anchor thuần chạy được trên web nhưng im lặng hỏng trong các app Tauri.
|
||||
- Link ngoài mới trong app? Dùng `<ExtLink href="…">` từ `webapp/src/components/ext-link.tsx`, đừng dùng `<a href="…" target="_blank">` thuần: anchor thuần chạy được trên web nhưng im lặng hỏng trong các app Tauri (và ExtLink báo cho trình đọc màn hình rằng link mở thẻ mới).
|
||||
- **Trợ năng**: thay đổi giao diện phải vẫn dùng được chỉ với bàn phím và với trình đọc màn hình, và giữ tỉ lệ tương phản (`npm test` kiểm tra màu). Danh sách kiểm tra nằm trong [Trợ năng → Dành cho người đóng góp](ACCESSIBILITY.md#8-dành-cho-người-đóng-góp) và trong pull request template.
|
||||
|
||||
### 8. Thiết lập môi trường dev (tóm tắt)
|
||||
|
||||
Dành cho các bản fork, và cho việc bảo trì của chính Maintainer.
|
||||
|
||||
Hướng dẫn đầy đủ (Worker, D1 cục bộ, secret, Tauri, Android) nằm trong **[`docs/dev_env.md`](../../dev_env.md)** ([VI](dev_env.md)); ghi chú build Tauri/Android nằm trong [`webapp/TAURI.md`](../../../webapp/TAURI.md). Bản ngắn gọn:
|
||||
|
||||
**Pipeline Python** (Python 3.14, xem `.python-version`):
|
||||
**Pipeline Python** (Python 3.15, xem `.github/python-version`):
|
||||
|
||||
```sh
|
||||
python -m venv .venv
|
||||
@@ -100,7 +111,7 @@ Muốn thử cào thật trên máy: thêm một URL vào `scripts/temp_link.jso
|
||||
`python scripts/update_info.py --out patch.json` và `python scripts/apply_patch.py patch.json`
|
||||
(đừng commit kết quả; xem quy tắc PR ở trên).
|
||||
|
||||
**Webapp + Worker** (Node.js 22.22+, CI dùng phiên bản trong `webapp/.node-version`):
|
||||
**Webapp + Worker** (Node.js 26+, CI dùng phiên bản trong `webapp/.node-version`):
|
||||
|
||||
```sh
|
||||
cd webapp
|
||||
@@ -126,12 +137,12 @@ npm run tauri:build # trình cài đặt trong src-tauri/target/release/bundle/
|
||||
- **Test cục bộ**: chạy các bước kiểm tra ở mục 8 trước khi push; CI chạy đúng những bước đó.
|
||||
- **Giữ sạch**: chỉ game itch.io miễn phí, không trả phí/demo/malware/trùng lặp.
|
||||
- **Kiên nhẫn**: tôi hướng nội + lười, trả lời có thể chậm.
|
||||
- **Đồng ý**: mọi issue template đều có một checkbox bắt buộc. Lạc đề/spam/vi phạm chính sách sẽ bị bỏ qua/đóng không drama :D
|
||||
- **Đồng ý**: mọi issue template đều có một checkbox bắt buộc. Lạc đề/spam/vi phạm chính sách, và mọi thứ nằm ngoài phạm vi bảo trì ở trên, sẽ bị bỏ qua/đóng không drama :D
|
||||
- **Cư xử đẹp**: mọi thứ ở đây đều theo [Quy tắc ứng xử](CODE_OF_CONDUCT.md).
|
||||
|
||||
## Muốn thảo luận thêm? (Nếu template không đủ)
|
||||
|
||||
Issue/PR là tốt nhất để theo dõi, nhưng nếu bạn muốn mô tả bug/tính năng kỹ hơn, tán gẫu, hoặc kể chuyện noob, giờ đã có server thật (introvert god-mode bị xuyên thủng):
|
||||
Issue là tốt nhất để theo dõi vấn đề dữ liệu, nhưng nếu bạn muốn tán gẫu, hỏi gì đó, hoặc kể chuyện noob, giờ đã có [GitHub Discussions](https://github.com/poli0981/free-games-itchio-list/discussions) và server thật (introvert god-mode bị xuyên thủng):
|
||||
|
||||
**Chat / cộng đồng**
|
||||
- Discord: Repo discussion (#general): https://discord.gg/2aNR3aVt
|
||||
|
||||
@@ -1,10 +1,10 @@
|
||||
# Tuyên bố miễn trừ trách nhiệm (Disclaimer)
|
||||
|
||||
Cập nhật lần cuối: 2026-09-29
|
||||
Cập nhật lần cuối: 2026-10-16
|
||||
|
||||
Áp dụng từ: khi phát hành phiên bản 4.0.0.
|
||||
|
||||
> Bản dịch từ bản tiếng Anh cập nhật ngày 2026-09-18 (English source revision 2026-09-18). Nếu có khác biệt, bản tiếng Anh được ưu tiên. Bản gốc: [`docs/DISCLAIMER.md`](../../DISCLAIMER.md).
|
||||
> Bản dịch từ bản tiếng Anh cập nhật ngày 2026-10-16 (English source revision 2026-10-16). Nếu có khác biệt, bản tiếng Anh được ưu tiên. Bản gốc: [`docs/DISCLAIMER.md`](../../DISCLAIMER.md).
|
||||
|
||||
Dự án này — repository `free-games-itchio-list` và website **[freeitchgames.win](https://freeitchgames.win)** — là một dự án sở thích: một danh mục được tuyển chọn và tự động cập nhật gồm các game miễn phí trên [itch.io](https://itch.io). Dự án do một dev người Việt đang thất nghiệp, poli0981 (SkullMute), vận hành — dưới đây gọi là "Người duy trì" — với các trợ lý AI gánh phần lớn việc nặng. Làm ra vì vibes, để khám phá game indie và giải khuây. Không hứa hẹn gì lớn lao — nhưng các điều khoản mang tính pháp lý dưới đây là thật.
|
||||
|
||||
@@ -33,7 +33,7 @@ Dự án hoạt động độc lập. Dự án **không liên kết với, khôn
|
||||
|
||||
Dự án **không làm, không lưu trữ, không phân phối, không bán và không chứng thực** các game được liệt kê. Mỗi game liên kết tới trang riêng của nó trên itch.io, và mọi lượt tải về đều diễn ra tại đó, theo điều khoản của itch.io và điều khoản hoặc giấy phép riêng của người làm game.
|
||||
|
||||
Game được đưa vào catalog qua trang Suggest công khai, tiện ích trình duyệt của Người duy trì, hoặc các RSS feed công khai của itch.io, và không có gì được thêm vào cho đến khi Người duy trì duyệt. Việc duyệt đó **không phải** là kiểm tra bảo mật, đánh giá chất lượng hay sự chứng thực.
|
||||
Game được đưa vào catalog qua trang Suggest công khai, các RSS feed công khai của itch.io, hoặc các collection công khai trên itch.io mà Người duy trì theo dõi. Mỗi game đều được Người duy trì duyệt, từng game một hoặc qua các quy tắc tự động do Người duy trì đặt ra. Việc duyệt đó **không phải** là kiểm tra bảo mật, đánh giá chất lượng hay sự chứng thực.
|
||||
|
||||
## 5. Không bảo đảm về các game
|
||||
|
||||
|
||||
@@ -1,10 +1,10 @@
|
||||
# Thỏa thuận cấp phép cho người dùng cuối (EULA)
|
||||
|
||||
Cập nhật lần cuối: 2026-10-03
|
||||
Cập nhật lần cuối: 2026-10-16
|
||||
|
||||
Áp dụng từ: khi phát hành phiên bản 4.2.0.
|
||||
|
||||
Bản dịch từ bản tiếng Anh cập nhật ngày 2026-10-03 (English source revision 2026-10-03). Nếu có khác biệt, bản tiếng Anh được ưu tiên.
|
||||
Bản dịch từ bản tiếng Anh cập nhật ngày 2026-10-16 (English source revision 2026-10-16). Nếu có khác biệt, bản tiếng Anh được ưu tiên.
|
||||
|
||||
> Bản tiếng Anh: [`docs/EULA.md`](../../EULA.md).
|
||||
|
||||
@@ -86,7 +86,7 @@ Bạn đồng ý không:
|
||||
|
||||
- Trình bày một bản build đã sửa đổi như một bản phát hành chính thức, ví dụ phân phối nó dưới tên và biểu tượng của dự án, hoặc với app identifier chính thức `com.poli0981.freegamesitchio`, mà không ghi rõ đó là bản không chính thức. Fork luôn được chào đón theo Giấy phép MIT; chỉ cần làm rõ rằng đó là bản của Bạn.
|
||||
- Sử dụng tên Người duy trì, GitHub handle `poli0981`, hoặc alias "SkullMute" để chứng thực hoặc quảng bá tác phẩm phái sinh mà không có sự cho phép trước bằng văn bản.
|
||||
- Sử dụng Ứng dụng, hoặc một phiên bản đã sửa đổi của nó, theo cách vi phạm [Điều khoản sử dụng](ToS.md) của Website, ví dụ gửi yêu cầu tự động hàng loạt tới Website (dữ liệu có sẵn trong Repository), hoặc cố truy cập khu vực quản trị (admin) hay ingest API khi không được phép.
|
||||
- Sử dụng Ứng dụng, hoặc một phiên bản đã sửa đổi của nó, theo cách vi phạm [Điều khoản sử dụng](ToS.md) của Website, ví dụ gửi yêu cầu tự động hàng loạt tới Website (dữ liệu có sẵn trong Repository), hoặc cố truy cập khu vực quản trị (admin) khi không được phép.
|
||||
- Sử dụng Ứng dụng hoặc các bộ cài của nó để lưu trữ, phân phối hoặc tạo điều kiện phân phối malware, trang phishing, hoặc nội dung vi phạm pháp luật hiện hành.
|
||||
|
||||
Các quy tắc này là về cách Bạn sử dụng Ứng dụng cũng như tên và dịch vụ của dự án. Chúng tồn tại song song với Giấy phép MIT và không hạn chế các quyền mà giấy phép đó trao đối với mã nguồn.
|
||||
|
||||
@@ -1,10 +1,10 @@
|
||||
# Chính sách quyền riêng tư (Privacy Policy)
|
||||
|
||||
Cập nhật lần cuối: 2026-10-03
|
||||
Cập nhật lần cuối: 2026-10-16
|
||||
|
||||
Áp dụng từ: ngày 2026-10-03 đối với Website, và từ phiên bản 4.2.0 đối với các Ứng dụng.
|
||||
Áp dụng từ: ngày 2026-10-13 đối với Website, và từ phiên bản 4.4.0 đối với các Ứng dụng.
|
||||
|
||||
> Bản dịch từ bản tiếng Anh cập nhật ngày 2026-10-03 (English source revision 2026-10-03). Nếu có khác biệt, bản tiếng Anh được ưu tiên. Bản gốc: [`docs/PrivacyPolicy.md`](../../PrivacyPolicy.md).
|
||||
> Bản dịch từ bản tiếng Anh cập nhật ngày 2026-10-16 (English source revision 2026-10-16). Nếu có khác biệt, bản tiếng Anh được ưu tiên. Bản gốc: [`docs/PrivacyPolicy.md`](../../PrivacyPolicy.md).
|
||||
|
||||
Chính sách quyền riêng tư này giải thích dự án `free-games-itchio-list` xử lý những dữ liệu cá nhân nào, vì sao, ai hỗ trợ xử lý, dữ liệu được lưu trong bao lâu và bạn có những quyền gì. Chính sách áp dụng cho website **https://freeitchgames.win**, các ứng dụng desktop và Android, dữ liệu danh mục công khai và repository. Nói ngắn gọn: không có tài khoản, không quảng cáo, không cookie theo dõi. Dự án giữ ít dữ liệu nhất có thể, và phần lớn những gì tồn tại chỉ nằm trong trình duyệt của chính bạn.
|
||||
|
||||
@@ -36,7 +36,7 @@ Bên kiểm soát dữ liệu cá nhân được mô tả trong Chính sách nà
|
||||
|
||||
### 1.3 Những gì Chính sách này không áp dụng
|
||||
|
||||
Chính sách này không áp dụng cho các dịch vụ tự xử lý dữ liệu với tư cách của chính họ: itch.io (mọi link game và mọi lượt tải đều dẫn tới đó), GitHub đối với tài khoản GitHub và hoạt động của bạn trên github.com, việc Cloudflare dùng dữ liệu cho mục đích riêng của họ như mô tả trong chính sách quyền riêng tư của Cloudflare, bản thân các game, và tiện ích trình duyệt của Người duy trì (một dự án riêng, có tài liệu riêng). Chính sách của từng bên sẽ được áp dụng (link ở mục 4).
|
||||
Chính sách này không áp dụng cho các dịch vụ tự xử lý dữ liệu với tư cách của chính họ: itch.io (mọi link game và mọi lượt tải đều dẫn tới đó), GitHub đối với tài khoản GitHub và hoạt động của bạn trên github.com, việc Cloudflare dùng dữ liệu cho mục đích riêng của họ như mô tả trong chính sách quyền riêng tư của Cloudflare, và bản thân các game. Chính sách của từng bên sẽ được áp dụng (link ở mục 4).
|
||||
|
||||
## 2. Dữ liệu nào được xử lý và vì sao
|
||||
|
||||
@@ -65,14 +65,14 @@ Khi bạn dùng trang Suggest (https://freeitchgames.win/suggest):
|
||||
- **Những gì được lưu**: URL game, ghi chú tùy chọn của bạn (tối đa 500 ký tự) và thời điểm gửi, trong hàng chờ duyệt (mục 2.4). Trang không yêu cầu và không lưu tên, địa chỉ email hay tài khoản nào.
|
||||
- **Chống spam**: Cloudflare Turnstile xử lý các tín hiệu về thiết bị và trình duyệt của bạn để phân biệt người thật với bot. Để kiểm tra kết quả, Website gửi token Turnstile và địa chỉ IP của bạn tới dịch vụ xác minh của Cloudflare.
|
||||
- **Giới hạn tần suất**: địa chỉ IP của bạn chỉ được dùng tạm thời để đếm số request. Dự án không lưu nó.
|
||||
- **Mục đích**: để xem xét đề xuất của bạn. Nếu được duyệt, URL game trở thành một phần của Danh mục công khai. Ghi chú của bạn không bao giờ được công bố và **tự động bị xóa sau 180 ngày**.
|
||||
- **Mục đích**: để xem xét đề xuất của bạn, do Người duy trì hoặc các quy tắc tự động do Người duy trì đặt ra (mục 2.4). Nếu được duyệt, URL game trở thành một phần của Danh mục công khai. Ghi chú của bạn không bao giờ được công bố và **tự động bị xóa sau 180 ngày**.
|
||||
- **Vui lòng không đưa dữ liệu cá nhân vào ghi chú**, dù là của bạn hay của người khác. Biểu mẫu này chỉ dành cho link game.
|
||||
|
||||
### 2.4 Hàng chờ duyệt và khu vực quản trị
|
||||
|
||||
- **Game đến từ đâu**: đề xuất từ trang Suggest; dữ liệu gửi từ tiện ích trình duyệt của Người duy trì qua một API có xác thực (URL game, tiêu đề và ghi chú tùy chọn, và ID service token của tiện ích; các bản ghi chống gửi trùng được giữ 7 ngày); và tự động phát hiện từ các RSS feed công khai của itch.io.
|
||||
- **Hàng chờ duyệt** (Cloudflare D1) chứa các URL game ứng viên cùng nguồn gửi, tiêu đề, URL ảnh bìa và gợi ý thể loại lấy từ itch.io, các cờ tự động, ghi chú, mốc thời gian và quyết định của Người duy trì. Không game nào được đưa vào Danh mục cho tới khi Người duy trì duyệt. Các URL bị từ chối được giữ vô thời hạn làm danh sách chặn; chỉ cần URL là đủ để không phải xét lại cùng một game.
|
||||
- **Khu vực quản trị** (https://freeitchgames.win/admin) chỉ dành cho Người duy trì. Khu vực này được bảo vệ bằng Cloudflare Access (đăng nhập bằng GitHub hoặc mã PIN dùng một lần gửi qua email); Cloudflare Access đặt cookie phiên `CF_Authorization` trong trình duyệt của Người duy trì. Các thao tác quản trị được ghi vào nhật ký kiểm tra (audit log) kèm địa chỉ email của Người duy trì. Nhật ký này không bao giờ được công bố.
|
||||
- **Game đến từ đâu**: đề xuất từ trang Suggest; tự động phát hiện từ các RSS feed công khai của itch.io; và game miễn phí mới trong các collection công khai trên itch.io mà Người duy trì theo dõi (Website đọc các trang công khai đó; không liên quan gì tới dữ liệu của bạn).
|
||||
- **Hàng chờ duyệt** (Cloudflare D1) chứa các URL game ứng viên cùng nguồn gửi, tiêu đề, URL ảnh bìa và gợi ý thể loại lấy từ itch.io, các cờ tự động, ghi chú, mốc thời gian và quyết định của Người duy trì. Game được đưa vào Danh mục khi Người duy trì duyệt: từng game một, hoặc qua các quy tắc tự động do Người duy trì đặt ra và có thể thay đổi bất cứ lúc nào (mục không có cờ cảnh báo mà không ai từ chối trong thời gian chờ; game miễn phí mới trong các collection Người duy trì theo dõi). Các lượt duyệt tự động được ghi vào nhật ký kiểm tra như thao tác của chính Người duy trì. Các URL bị từ chối được giữ vô thời hạn làm danh sách chặn; chỉ cần URL là đủ để không phải xét lại cùng một game.
|
||||
- **Khu vực quản trị** (https://freeitchgames.win/admin) chỉ dành cho Người duy trì. Khu vực này được bảo vệ bằng Cloudflare Access (đăng nhập bằng GitHub hoặc mã PIN dùng một lần gửi qua email); Cloudflare Access đặt cookie phiên `CF_Authorization` trong trình duyệt của Người duy trì. Các thao tác quản trị, kể cả thay đổi quy tắc tự động, được ghi vào nhật ký kiểm tra (audit log) kèm địa chỉ email của Người duy trì. Nhật ký này không bao giờ được công bố.
|
||||
|
||||
### 2.5 Dữ liệu game công khai trong Danh mục
|
||||
|
||||
@@ -145,7 +145,6 @@ Cloudflare và Google có thể xử lý dữ liệu ở bất kỳ đâu trên
|
||||
| Địa chỉ IP dùng cho giới hạn tần suất và Turnstile | Chỉ dùng tạm thời; Dự án không bao giờ lưu |
|
||||
| Ghi chú trên trang Suggest | Tự động xóa sau **180 ngày** |
|
||||
| URL game được đề xuất hoặc được phát hiện, kèm nguồn và mốc thời gian | Nằm trong hàng chờ duyệt chừng nào còn cần để không phải xét cùng một game hai lần. URL được duyệt trở thành một phần của Danh mục công khai; URL bị từ chối được giữ vô thời hạn làm danh sách chặn |
|
||||
| Bản ghi chống gửi trùng từ tiện ích trình duyệt | **7 ngày** |
|
||||
| Nhật ký kiểm tra quản trị (kèm địa chỉ email của Người duy trì) | Được giữ làm hồ sơ các thay đổi quản trị; không bao giờ công bố |
|
||||
| Mục trong Danh mục (bao gồm tên nhà phát triển và nhà phát hành) | Khi game còn được liệt kê. Bản ghi gỡ bỏ vẫn nằm trong danh sách game đã gỡ công khai, và lịch sử Git của Repository giữ các phiên bản trước (xem mục 7.3) |
|
||||
| Email, bao gồm yêu cầu gỡ game và yêu cầu liên quan đến bản quyền | Trong thời gian cần thiết để xử lý yêu cầu |
|
||||
@@ -219,8 +218,8 @@ Theo GDPR và UK GDPR, bạn cũng có thể yêu cầu hạn chế việc xử
|
||||
|
||||
- Website chỉ được phục vụ qua HTTPS.
|
||||
- Truy cập tự động phải qua bước kiểm tra Cloudflare Turnstile trước khi các trang và ảnh bìa của Website được tải (mục 2.1).
|
||||
- Tối thiểu hóa dữ liệu: không tài khoản, mã nguồn của Dự án không lưu địa chỉ IP, ghi chú Suggest bị xóa sau 180 ngày, bản ghi chống gửi trùng bị xóa sau 7 ngày.
|
||||
- Khu vực quản trị và API ingest được bảo vệ bằng Cloudflare Access, và mã máy chủ của Website tự xác minh token Access ở mọi request được bảo vệ.
|
||||
- Tối thiểu hóa dữ liệu: không tài khoản, mã nguồn của Dự án không lưu địa chỉ IP, ghi chú Suggest bị xóa sau 180 ngày.
|
||||
- Khu vực quản trị được bảo vệ bằng Cloudflare Access, và mã máy chủ của Website tự xác minh token Access ở mọi request được bảo vệ.
|
||||
- Các thông tin bí mật (như private key của GitHub App) được giữ trong kho lưu trữ bí mật của Cloudflare, không bao giờ nằm trong Repository. Khu vực quản trị ghi vào Repository dưới danh nghĩa một GitHub App, với các commit đã được xác minh (verified).
|
||||
- Content Security Policy chặt chẽ chỉ cho phép script từ chính Website, cộng với Cloudflare Web Analytics và Turnstile.
|
||||
- Các GitHub Actions được ghim theo commit SHA cụ thể với quyền tối thiểu cần thiết, và Dependabot giữ cho các dependency luôn được cập nhật.
|
||||
|
||||
@@ -1,10 +1,10 @@
|
||||
# Chính sách bảo mật (Security Policy)
|
||||
|
||||
Cập nhật lần cuối: 2026-09-29
|
||||
Cập nhật lần cuối: 2026-11-11
|
||||
|
||||
Áp dụng từ: khi phát hành phiên bản 4.0.0.
|
||||
|
||||
> Bản dịch từ bản tiếng Anh cập nhật ngày 2026-09-18 (English source revision 2026-09-18). Nếu có khác biệt, bản tiếng Anh được ưu tiên. Bản gốc: [`SECURITY.md`](../../../SECURITY.md).
|
||||
> Bản dịch từ bản tiếng Anh cập nhật ngày 2026-10-27 (English source revision 2026-10-27). Nếu có khác biệt, bản tiếng Anh được ưu tiên. Bản gốc: [`SECURITY.md`](../../../SECURITY.md).
|
||||
|
||||
Chào bạn — đây là một dự án sở thích do một người vận hành, poli0981 (SkullMute), dưới đây gọi là "Người duy trì": một danh mục được tuyển chọn gồm các game itch.io miễn phí. Từ v4, dự án gồm một **website chỉ đọc** tại https://freeitchgames.win (chạy trên một Cloudflare Worker), một **pipeline dữ liệu Python** trên GitHub Actions, và các **ứng dụng desktop và Android chỉ đọc**. Không có tài khoản công khai, không đăng nhập và không thanh toán; lần đăng nhập duy nhất là trang quản trị riêng của Người duy trì, được bảo vệ bởi Cloudflare Access. Bề mặt tấn công nhỏ — nhưng nếu bạn tìm thấy lỗ hổng, Người duy trì thực sự muốn được biết.
|
||||
|
||||
@@ -26,7 +26,7 @@ Một báo cáo tốt nên có:
|
||||
|
||||
**Trong phạm vi**
|
||||
|
||||
- Website https://freeitchgames.win và Cloudflare Worker của nó, bao gồm proxy ảnh (`/img`), API Suggest (`/api/suggest`), API ingest mà tiện ích trình duyệt của Người duy trì sử dụng (`/api/ingest`), cùng ứng dụng và API quản trị (`/admin`, `/api/admin`).
|
||||
- Website https://freeitchgames.win và Cloudflare Worker của nó, bao gồm proxy ảnh (`/img`), API Suggest (`/api/suggest`), cùng ứng dụng và API quản trị (`/admin`, `/api/admin`).
|
||||
- Pipeline dữ liệu (`scripts/`) và các workflow GitHub Actions (`.github/workflows/`).
|
||||
- Các ứng dụng desktop và file APK Android được phát hành trên [GitHub Releases](https://github.com/poli0981/free-games-itchio-list/releases).
|
||||
- Dữ liệu được công bố (`data_game/`, `scripts/deleted_games.json` và https://freeitchgames.win/data) — ví dụ: một cách đưa nội dung vào catalog mà không cần Người duy trì phê duyệt.
|
||||
@@ -39,7 +39,7 @@ Một báo cáo tốt nên có:
|
||||
- Tấn công từ chối dịch vụ theo lưu lượng (DoS/DDoS) và kiểm thử tải.
|
||||
- Báo cáo từ công cụ quét tự động mà không có proof of concept chạy được.
|
||||
|
||||
Tiện ích trình duyệt (poli0981/itch-f2p-extension) nằm trong repository riêng; lỗi của chính tiện ích xin báo ở đó. Lỗi trong API ingest mà tiện ích kết nối tới thì thuộc phạm vi ở đây.
|
||||
Tiện ích trình duyệt (poli0981/itch-f2p-extension) và Telegram bot (poli0981/telegram-scraper-bot) đã được lưu trữ (archive) và không còn được hỗ trợ, nên nằm ngoài phạm vi.
|
||||
|
||||
## 3. Phiên bản được hỗ trợ
|
||||
|
||||
@@ -51,6 +51,8 @@ Tiện ích trình duyệt (poli0981/itch-f2p-extension) nằm trong repository
|
||||
|
||||
Bản sửa cho website có hiệu lực ngay khi được deploy. Các ứng dụng không tự cập nhật: bản sửa được phát hành trong một bản release mới, bạn tải về từ GitHub Releases.
|
||||
|
||||
Từ phiên bản 4.6.1, dự án ở **chế độ bảo trì**: không có tính năng mới, nhưng việc vá bảo mật và cập nhật runtime, thư viện phụ thuộc vẫn tiếp tục như mô tả ở đây.
|
||||
|
||||
## 4. Những gì bạn có thể mong đợi
|
||||
|
||||
- **Xác nhận đã nhận báo cáo**: mục tiêu trong vòng **7 ngày**. Đây là dự án sở thích do một người làm, nên đó là mục tiêu chứ không phải cam kết, và thường sẽ sớm hơn nhiều.
|
||||
@@ -78,7 +80,7 @@ Những gì repository thực sự làm:
|
||||
- **Dependabot** ([`.github/dependabot.yml`](../../../.github/dependabot.yml)) được cấu hình để giữ các dependency npm, pip, GitHub Actions và cargo luôn được cập nhật.
|
||||
- Mọi **GitHub Action của bên thứ ba đều được ghim theo commit SHA đầy đủ**, và mỗi workflow khai báo `permissions` ở mức tối thiểu cần thiết.
|
||||
- Các thao tác ghi vào repository từ trang quản trị của website đều đi qua một **GitHub App** (commit được xác minh), và trang quản trị nằm sau Cloudflare Access (đăng nhập GitHub hoặc mã PIN dùng một lần qua email) và chỉ dành cho Người duy trì.
|
||||
- Form Suggest được bảo vệ bằng Cloudflare Turnstile và giới hạn tốc độ.
|
||||
- Website giới hạn số request mà một địa chỉ có thể gửi trong thời gian ngắn (một quy tắc WAF của Cloudflare, rồi các giới hạn theo từng loại đường dẫn trong Worker, trả về HTTP 429), và form Suggest còn có thêm Cloudflare Turnstile cùng một giới hạn chặt hơn của riêng nó.
|
||||
- File APK Android được ký bằng khóa của dự án. Chỉ cài APK, cũng như các ứng dụng desktop, từ trang [GitHub Releases](https://github.com/poli0981/free-games-itchio-list/releases) của dự án.
|
||||
|
||||
Nếu một lỗ hổng đã biết trong dependency thực sự ảnh hưởng tới một thành phần đang chạy (website, Worker, pipeline hoặc các ứng dụng), hãy báo cáo riêng tư như ở [§1](#1-báo-cáo-lỗ-hổng). Nếu đó chỉ là một dependency lỗi thời, không có tác động thực tế, thì mở issue hoặc pull request thông thường là được.
|
||||
|
||||
+5
-5
@@ -1,10 +1,10 @@
|
||||
# Điều khoản sử dụng (Terms of Use)
|
||||
|
||||
Cập nhật lần cuối: 2026-10-03
|
||||
Cập nhật lần cuối: 2026-10-16
|
||||
|
||||
Áp dụng từ: ngày 2026-10-03 đối với Website, và từ phiên bản 4.2.0 đối với các Ứng dụng.
|
||||
Áp dụng từ: ngày 2026-10-13 đối với Website, và từ phiên bản 4.4.0 đối với các Ứng dụng.
|
||||
|
||||
Bản dịch từ bản tiếng Anh cập nhật ngày 2026-10-03 (English source revision 2026-10-03). Nếu có khác biệt, bản tiếng Anh được ưu tiên.
|
||||
Bản dịch từ bản tiếng Anh cập nhật ngày 2026-10-16 (English source revision 2026-10-16). Nếu có khác biệt, bản tiếng Anh được ưu tiên.
|
||||
|
||||
Bản tiếng Anh: [`docs/ToS.md`](../../ToS.md).
|
||||
|
||||
@@ -51,7 +51,7 @@ Các Điều khoản sử dụng này ("Điều khoản") điều chỉnh việc
|
||||
|
||||
- **Trang Suggest** (https://freeitchgames.win/suggest): bạn có thể gửi một liên kết game itch.io và một ghi chú tùy chọn dài tối đa 500 ký tự. Trang này dùng Cloudflare Turnstile để chống spam và có giới hạn tần suất (rate limit).
|
||||
- Ghi chú chỉ Người duy trì xem được và sẽ bị xóa sau 180 ngày. **Đừng đưa dữ liệu cá nhân vào ghi chú.** Xem [Chính sách quyền riêng tư](PrivacyPolicy.md).
|
||||
- Mọi đề xuất đều vào một **hàng đợi duyệt**. Không có gì được đưa vào Danh mục cho tới khi Người duy trì phê duyệt, và Người duy trì không có nghĩa vụ phải chấp nhận hay phản hồi một đề xuất. Sau khi được duyệt, liên kết sẽ được pipeline scrape, và game nào hóa ra là game trả phí sẽ bị loại.
|
||||
- Mọi đề xuất đều vào một **hàng đợi duyệt**. Người duy trì duyệt hoặc từ chối đề xuất tại đó, từng cái một hoặc qua các quy tắc tự động do Người duy trì đặt ra: một đề xuất không có cờ cảnh báo và không bị ai từ chối trong thời gian chờ mà Người duy trì chọn (hiện khoảng một ngày) có thể được duyệt tự động. Người duy trì không có nghĩa vụ phải chấp nhận hay phản hồi một đề xuất. Sau khi được duyệt, liên kết sẽ được pipeline scrape, và game nào hóa ra là game trả phí sẽ bị loại.
|
||||
- Chỉ những game **thực sự miễn phí** trên itch.io mới đủ điều kiện. Bản demo của game trả phí, game "name your own price" có mức giá tối thiểu lớn hơn 0, và game chỉ miễn phí trong thời gian khuyến mãi thì không.
|
||||
- Khi gửi bất cứ thứ gì cho Dự án (đề xuất, issue, pull request hay comment), bạn xác nhận rằng:
|
||||
- đó là sản phẩm của chính bạn, hoặc bạn có quyền chia sẻ nó;
|
||||
@@ -66,7 +66,7 @@ Bạn đồng ý **không**:
|
||||
|
||||
1. **Scrape hàng loạt** Website hoặc API của nó, kể cả các file trong `/data`. Hãy lấy dữ liệu từ Repository; cách đó tốn ít tài nguyên hơn cho tất cả mọi người.
|
||||
2. **Lạm dụng image proxy** (`/img`): proxy này chỉ để hiển thị ảnh bìa trên Website. Đừng hotlink các URL `/img` từ website hay ứng dụng khác, và đừng dùng nó để tải ảnh hàng loạt.
|
||||
3. **Truy cập trái phép các khu vực bị hạn chế**: `/admin`, API quản trị (`/api/admin/…`) và API ingest (`/api/ingest`) chỉ dành cho Người duy trì. Nghiên cứu bảo mật thiện chí luôn được hoan nghênh, theo các quy tắc trong [Security Policy](SECURITY.md).
|
||||
3. **Truy cập trái phép các khu vực bị hạn chế**: `/admin` và API quản trị (`/api/admin/…`) chỉ dành cho Người duy trì. Nghiên cứu bảo mật thiện chí luôn được hoan nghênh, theo các quy tắc trong [Security Policy](SECURITY.md).
|
||||
4. **Spam form Suggest**, hoặc tìm cách vượt qua bước xác minh của Website, Turnstile hay giới hạn tần suất (ví dụ bằng script, dùng chung cookie xác minh hoặc xoay vòng địa chỉ IP).
|
||||
5. **Gửi liên kết tới malware**, lừa đảo, phishing hoặc nội dung bất hợp pháp, ở bất kỳ đâu trong Dự án.
|
||||
6. **Mạo nhận liên kết**: đừng tự nhận là Người duy trì hay là Dự án, đừng giới thiệu một bản fork hay bản sao như thể đó là Dự án chính thức, đừng nói rằng Dự án do itch.io vận hành hoặc bảo trợ, và đừng dùng tên "poli0981" hay "SkullMute" để quảng bá sản phẩm của bạn khi chưa có sự cho phép trước bằng văn bản.
|
||||
|
||||
+26
-6
@@ -1,6 +1,6 @@
|
||||
# Môi trường phát triển
|
||||
|
||||
> Bản dịch từ bản tiếng Anh cập nhật ngày 2026-09-24 (English source revision 2026-09-24). Nếu có khác biệt, bản tiếng Anh được ưu tiên.
|
||||
> Bản dịch từ bản tiếng Anh cập nhật ngày 2026-11-11 (English source revision 2026-11-11). Nếu có khác biệt, bản tiếng Anh được ưu tiên.
|
||||
> Bản gốc: [`dev_env.md`](../../dev_env.md).
|
||||
|
||||
Bộ công cụ Maintainer dùng để viết và kiểm thử code trong repo này, và cách chạy từng phần trên máy.
|
||||
@@ -17,12 +17,17 @@ JetBrains 2026.x (dòng trả phí):
|
||||
|
||||
VS Code, Sublime, vim, v.v. đều dùng tốt; repo không chứa gì đặc thù của JetBrains.
|
||||
|
||||
TypeScript 7 (bản `tsc` mà `npm run build` chạy) là binary native, không có `tsserver`. Trong VS Code,
|
||||
cài extension TypeScript Native Preview (`TypeScriptTeam.native-preview`) để dùng language server của
|
||||
TS 7. Trong WebStorm, dùng chế độ hỗ trợ TypeScript 7 hoặc trỏ *Languages & Frameworks → TypeScript*
|
||||
tới `webapp/node_modules/@typescript/old` (TypeScript 6.0, báo cùng các lỗi).
|
||||
|
||||
## Toolchain ngôn ngữ
|
||||
|
||||
| Stack | Yêu cầu | Dùng cho |
|
||||
|-------|---------|----------|
|
||||
| Python | 3.14 (`.python-version`) | Pipeline dữ liệu (`scripts/`) và test của nó |
|
||||
| Node.js | 22.22+ (CI dùng `webapp/.node-version`) | Web app, admin app, Worker, phần front end của Tauri |
|
||||
| Python | 3.15 (`.github/python-version`) | Pipeline dữ liệu (`scripts/`) và test của nó |
|
||||
| Node.js | 26+ (CI dùng `webapp/.node-version`) | Web app, admin app, Worker, phần front end của Tauri |
|
||||
| npm | đi kèm Node.js | Dependency (`npm ci` theo `package-lock.json`) |
|
||||
| Wrangler | dependency của dự án (`npx wrangler`) | Worker chạy local, D1 local, deploy |
|
||||
| Rust | stable (qua `rustup`) | Chỉ để build Tauri desktop / Android |
|
||||
@@ -41,8 +46,12 @@ python -m venv .venv
|
||||
pip install -r requirements-dev.txt
|
||||
```
|
||||
|
||||
Trên Windows, đặt `PYTHONUTF8=1` (PowerShell: `$env:PYTHONUTF8 = "1"`) để Python đọc và ghi các
|
||||
file catalog dưới dạng UTF-8.
|
||||
Python 3.15 mặc định đọc và ghi file dưới dạng UTF-8 (UTF-8 mode, PEP 686), nên trên Windows không
|
||||
cần đặt `PYTHONUTF8=1` nữa.
|
||||
|
||||
Hai file requirements ghim mọi package kèm hash; pip kiểm tra hash khi cài. Muốn thêm hoặc đổi một
|
||||
dependency, sửa `requirements.in` hoặc `requirements-dev.in` rồi compile lại lock bằng pip-tools —
|
||||
lệnh nằm ở đầu mỗi file `.in` (chạy bằng Python 3.14, bản Dependabot đọc được; CLAUDE.md, gotcha 40).
|
||||
|
||||
### Kiểm tra (giống `python-ci.yml`)
|
||||
|
||||
@@ -54,6 +63,9 @@ vulture # code chết
|
||||
python scripts/validate.py # kiểm tra mọi file dữ liệu catalog
|
||||
```
|
||||
|
||||
`pytest --cov --cov-report=xml` đo thêm coverage và ghi `coverage.xml`, giống workflow SonarQube Cloud
|
||||
(`sonarcloud.yml`).
|
||||
|
||||
### Thử scrape thật
|
||||
|
||||
Các lệnh này gửi request thật tới itch.io:
|
||||
@@ -162,15 +174,23 @@ các việc bảo trì queue. Hãy dùng hạn chế.
|
||||
|
||||
```sh
|
||||
cd webapp
|
||||
npm run check:tauri # crate Tauri và package npm tương ứng cùng major.minor
|
||||
npm run cf:types -- --check # worker-configuration.d.ts khớp với wrangler.jsonc
|
||||
npm run lint # ESLint
|
||||
npm run knip # file / export / dependency không dùng
|
||||
npm test # Vitest: app + Worker; test D1 khởi động một workerd local
|
||||
npx tsc -b # chỉ kiểm tra kiểu (npm run build cũng chạy bước này)
|
||||
npm run build
|
||||
npx wrangler deploy --dry-run --env="" # kiểm tra cấu hình Worker, không deploy gì
|
||||
npm run cf:check # wrangler deploy --dry-run: kiểm tra cấu hình Worker, không deploy gì
|
||||
```
|
||||
|
||||
`npm run test:coverage` chạy test kèm coverage v8 và ghi `coverage/lcov.info`, giống workflow
|
||||
SonarQube Cloud (`sonarcloud.yml`).
|
||||
|
||||
Qodana (JetBrains) cũng phân tích code trong CI (`qodana.yml`: TypeScript / JavaScript, Python và
|
||||
Rust, mỗi phần có `qodana.yaml` riêng). Nó cần token của project nên không có lệnh chạy cục bộ ở đây;
|
||||
các inspection tương tự có sẵn trong WebStorm, PyCharm và RustRover.
|
||||
|
||||
Sau khi sửa `wrangler.jsonc`, chạy `npm run cf:types` và commit file `worker-configuration.d.ts` vừa
|
||||
được tạo lại.
|
||||
|
||||
|
||||
+114
-21
@@ -8,13 +8,14 @@ secret: secrets are only ever typed into Cloudflare (`wrangler secret put`) or a
|
||||
|
||||
| Piece | Where | What it does |
|
||||
|---|---|---|
|
||||
| Worker `free-games-itchio-list` | Cloudflare Workers, custom domain `freeitchgames.win` | Serves the built app + the catalog packs `/data/pack/*` (static assets), the readable `/data/*.json` to apps 4.0–4.1.1 only ([`legacy-data.ts`](../webapp/worker/legacy-data.ts)), `/img` (resized covers), the verification gate (`/api/verify`), `/api/suggest`, `/api/ingest`, `/api/admin/*`, `/admin`, and runs the RSS cron. Config: [`webapp/wrangler.jsonc`](../webapp/wrangler.jsonc). |
|
||||
| Worker `free-games-itchio-list` | Cloudflare Workers, custom domain `freeitchgames.win` | Serves the built app + the catalog packs `/data/pack/*` (static assets), the readable `/data/*.json` to apps 4.0–4.1.1 only ([`legacy-data.ts`](../webapp/worker/legacy-data.ts)), `/img` (resized covers), the verification gate (`/api/verify`), `/api/suggest`, `/api/admin/*`, `/admin`, and runs the RSS cron. Config: [`webapp/wrangler.jsonc`](../webapp/wrangler.jsonc). |
|
||||
| Workers Builds | Cloudflare dashboard → the Worker → Settings → Build | Builds and deploys `main` on every push (data commits included). |
|
||||
| R2 `freeitchgames-thumbs` | Cloudflare R2 | Resized WebP covers (`w160/…`, `w640/…`). |
|
||||
| D1 `freeitchgames` | Cloudflare D1 | Review queue, feed state, audit log, idempotency keys ([`webapp/worker/migrations/`](../webapp/worker/migrations)). |
|
||||
| Access apps "Admin" / "Ingest" | Cloudflare Zero Trust | Login for `/admin` + `/api/admin/*`; service token for `/api/ingest` (browser extension). |
|
||||
| D1 `freeitchgames` | Cloudflare D1 | Review queue, feed state, audit log, automation settings, followed collections ([`webapp/worker/migrations/`](../webapp/worker/migrations); the `idempotency` table of the retired ingest API stays, empty). |
|
||||
| Access app "Admin" | Cloudflare Zero Trust | Login for `/admin` + `/api/admin/*`. |
|
||||
| Turnstile widget | Cloudflare Turnstile | The verification gate in front of the web app (action `gate`) and anti-spam on `/suggest` (action `suggest`). |
|
||||
| Transform Rule "Verified bots skip the gate" | Cloudflare → Rules → Transform Rules | Adds `x-fig-known-bot: <GATE_BOT_TOKEN>` to requests from Cloudflare-verified bots, so search engines and link previews skip the gate (section 1, step 14). |
|
||||
| Rate limits | WAF rule (Security → WAF → Rate limiting rules) + the Worker's `ratelimits` bindings | Two layers of per-IP limits: the WAF rule stops floods before they run (and bill) the Worker; the Worker answers what still gets through with 429 per kind of traffic (section 1, step 15). |
|
||||
| GitHub App | GitHub → Settings → Developer settings | The Worker's identity for commits (queue approvals, edits, removals). |
|
||||
| GitHub Actions | [`.github/workflows/`](../.github/workflows) | Data pipeline (`refresh.yml`, `update.yml`, `force_update.yml`), CI, releases, build monitor. |
|
||||
| Staging Worker `free-games-itchio-list-staging` | `staging.freeitchgames.win` (whole host behind Access) | Optional pre-release checks, deployed by hand from any branch with `npx wrangler deploy --env staging` (`wrangler.jsonc` → `env.staging`). |
|
||||
@@ -24,7 +25,7 @@ secret: secrets are only ever typed into Cloudflare (`wrangler secret put`) or a
|
||||
Do these once (and again with the `-staging` names for the staging Worker).
|
||||
|
||||
1. **Build settings** (Worker → Settings → Build): root directory `webapp`; build command
|
||||
`npm run build`; deploy command `npx wrangler deploy`; build variable `NODE_VERSION=24` (no
|
||||
`npm run build`; deploy command `npx wrangler deploy`; build variable `NODE_VERSION=26` (no
|
||||
`VITE_CF_BEACON_TOKEN`: the zone injects Web Analytics, step 10). The staging Worker, if you use
|
||||
it, is deployed by hand (`npx wrangler deploy --env staging`); turn its builds for non-production
|
||||
branches **off** (otherwise every push to `main` also gets a preview build there).
|
||||
@@ -37,7 +38,8 @@ Do these once (and again with the `-staging` names for the staging Worker).
|
||||
(and `freeitchgames-thumbs-staging`). A deploy fails while its bucket is missing.
|
||||
4. **Images → Transformations**: enable for the zone; allowed source origins: `img.itch.zone` only.
|
||||
5. **D1**: production `freeitchgames` exists (created 2026-09-18 in APAC with
|
||||
`npx wrangler d1 create freeitchgames`; its id is in `wrangler.jsonc`; `0001_init.sql` applied).
|
||||
`npx wrangler d1 create freeitchgames`; its id is in `wrangler.jsonc`; `0001_init.sql` applied,
|
||||
`0002_automation.sql` (4.4: ingest outcomes, settings, followed collections) applied before the 4.4.0 merge).
|
||||
Staging: `cd webapp && npx wrangler d1 create freeitchgames-staging`, put the printed id in
|
||||
`env.staging.d1_databases`, then `npx wrangler d1 migrations apply freeitchgames-staging --remote --env staging`.
|
||||
Apply every new migration by hand (`npx wrangler d1 migrations apply freeitchgames --remote`)
|
||||
@@ -48,17 +50,15 @@ Do these once (and again with the `-staging` names for the staging Worker).
|
||||
- Access → Applications → Self-hosted **"Admin"**: `freeitchgames.win/admin`,
|
||||
`freeitchgames.win/admin/*`, `freeitchgames.win/api/admin/*`; policy *Allow* → your email(s);
|
||||
session 24 h. Copy its **AUD** tag.
|
||||
- Self-hosted **"Ingest"**: `freeitchgames.win/api/ingest`; policy *Service Auth* → a service token
|
||||
(Access → Service credentials) named e.g. `itch-f2p-extension`, with an expiry; copy the AUD tag.
|
||||
The extension sends `CF-Access-Client-Id` / `CF-Access-Client-Secret`.
|
||||
- 4.4.1 removed the browser extension's ingest API: delete the old self-hosted **"Ingest"** app
|
||||
(`freeitchgames.win/api/ingest`) and its service token (Access → Service credentials) if they still exist.
|
||||
- Staging: one self-hosted app covering all of `staging.freeitchgames.win`.
|
||||
7. **Turnstile**: add a widget (Managed) for `freeitchgames.win` and `staging.freeitchgames.win`. The
|
||||
same widget serves the verification gate (action `gate`) and the Suggest form (action `suggest`);
|
||||
the Worker checks the token, the hostname and the action, so a token from one can't be used for
|
||||
the other.
|
||||
8. **Fill in `wrangler.jsonc` vars** (not secret) and commit: `ACCESS_TEAM_DOMAIN`
|
||||
(`https://<team>.cloudflareaccess.com`, no trailing slash), `ACCESS_AUD_ADMIN`, `ACCESS_AUD_INGEST`,
|
||||
`GH_APP_ID`, `GH_APP_INSTALLATION_ID`, `TURNSTILE_SITEKEY` — in both the top level and
|
||||
(`https://<team>.cloudflareaccess.com`, no trailing slash), `ACCESS_AUD_ADMIN`, `GH_APP_ID`, `GH_APP_INSTALLATION_ID`, `TURNSTILE_SITEKEY` — in both the top level and
|
||||
`env.staging`. Then `npm run cf:types`. The production values are filled in (2026-09-18). Change
|
||||
them in the file, not only in the dashboard: every deploy — so every data commit — replaces the
|
||||
Worker's plain-text variables with the file's values. Secrets are not affected.
|
||||
@@ -82,8 +82,8 @@ Do these once (and again with the `-staging` names for the staging Worker).
|
||||
DMARC for poli0981.dev live in that zone's Cloudflare DNS). freeitchgames.win needs no mail setup.
|
||||
12. **Zone settings**: SSL/TLS Full (strict), Always Use HTTPS, minimum TLS 1.2, TLS 1.3 on; Smart
|
||||
Tiered Cache; Browser Cache TTL "Respect existing headers"; Rocket Loader and Email Obfuscation
|
||||
**off** (they rewrite HTML and break the CSP); WAF managed rules on; one rate-limiting rule for
|
||||
`/api/*`; Bot Fight Mode **off** (it can't be skipped for the extension or the apps; the
|
||||
**off** (they rewrite HTML and break the CSP); WAF managed rules on; the rate-limiting rule of
|
||||
step 15; Bot Fight Mode **off** (it can't be skipped for the apps; the
|
||||
verification gate covers the web app instead). Keep HSTS
|
||||
`preload` only if every subdomain (including `staging`) will always be HTTPS.
|
||||
- Measured 2026-10-03: TLS 1.0/1.1 are refused, TLS 1.3 and HTTP/3 answer, `http://` redirects
|
||||
@@ -137,6 +137,60 @@ Do these once (and again with the `-staging` names for the staging Worker).
|
||||
`SITE_ORIGIN=http://localhost:8787` and a 32+ character `GATE_SECRET` in `webapp/.dev.vars`, then
|
||||
`npm run build && npx wrangler dev` (on localhost the cookie is `fig_gate`, without `Secure`, and
|
||||
no bot token is needed).
|
||||
15. **Rate limits** — two layers, both per client IP (an IPv6 client by its /64 in the Worker).
|
||||
- **Layer 1, the zone's WAF rule** (Security → WAF → **Rate limiting rules**). It runs before the
|
||||
Worker, so a request it blocks costs no Worker request, it is the only limit on static files, and
|
||||
it counts across the whole data centre — the only limit a flood of new connections can't spread
|
||||
out of (see layer 2).
|
||||
On the Free plan there is **one** rule, counted by IP over **10 seconds**, with a 10-second block;
|
||||
if a rule already exists (the old one for `/api/*`), edit it rather than adding one. Settings:
|
||||
- Rule name `Flood guard`. *If incoming requests match* → *Edit expression*:
|
||||
```
|
||||
(not cf.client.bot and not starts_with(http.request.uri.path, "/assets/") and not starts_with(http.request.uri.path, "/data/pack/"))
|
||||
```
|
||||
(In the builder: *Verified Bot* equals off, *URI Path* does not start with `/assets/`, *URI
|
||||
Path* does not start with `/data/pack/`, joined with And. If the editor refuses
|
||||
`starts_with`, use `not http.request.uri.path wildcard r"/assets/*"` and the same for
|
||||
`/data/pack/*`.) Bundles and packs stay out: they are free static assets with a long cache, and
|
||||
a first visit loads a few dozen of them at once. Verified bots stay out like at the gate.
|
||||
- *With the same characteristics*: IP. *When rate exceeds*: **300 requests** per **10 seconds**
|
||||
(30 a second; a person scrolling the Games list fast loads about 100 covers in that time).
|
||||
*Then take action*: **Block**, default response (429, Cloudflare's "error 1015" page), for
|
||||
10 seconds. Deploy.
|
||||
- Lower it once Security → Events shows what real traffic looks like; don't go below ~150 per
|
||||
10 s (a Games page asks for up to 100 covers).
|
||||
- **Layer 2, the Worker** ([`webapp/worker/ratelimit.ts`](../webapp/worker/ratelimit.ts),
|
||||
`ratelimits` in `wrangler.jsonc`, deployed with every build — nothing to set up). Every request
|
||||
that runs the Worker counts, per 60 s and per Cloudflare location: `RL_SITE` 120 (app pages, the
|
||||
public `/api`, the readable `/data` JSON, misses), `RL_IMG` 600 (`/img` covers), `RL_ADMIN` 300
|
||||
(`/admin` + `/api/admin`); on top, `RL_SUGGEST` 5 (Suggest POSTs) and `RL_GATE` 20 (verification
|
||||
POSTs). Over a limit: 429 + `Retry-After: 60` — JSON `{"error":"rate_limited"}` for the API,
|
||||
covers and files (with CORS on `/data`), a small "Too many requests" page (EN/VI, no script) for
|
||||
app pages. Verified bots (the gate's header) are never counted. **These counts are loose**:
|
||||
each machine of a data centre counts on its own and syncs late, so they hold for a client that
|
||||
keeps one connection (browsers use one HTTP/2 connection, scripts with keep-alive) but hardly
|
||||
for one that opens a new connection per request — measured after the 4.5.0 deploy, 1,000 such
|
||||
requests in a minute got no 429. That is the WAF rule's job. Change a limit in
|
||||
`wrangler.jsonc` (then `npm run cf:types`); keep `period` 60 and a new `namespace_id` per binding in
|
||||
88xx (staging 89xx) — the ids are account-wide, and the account's other Workers use the low numbers.
|
||||
The counts are approximate and fail open (a missing binding or a limiter error lets requests
|
||||
through).
|
||||
- **Test** after a change (it blocks your own IP for up to a minute). The Worker's limits, over
|
||||
**one** connection (a single `curl` with many URLs reuses it):
|
||||
```sh
|
||||
curl -s -o /dev/null -w "%{http_code}\n" $(printf 'https://freeitchgames.win/api/health %.0s' $(seq 200)) | sort | uniq -c
|
||||
curl -s https://freeitchgames.win/api/health # {"error":"rate_limited"} → the Worker; "error code: 1015" → the WAF rule
|
||||
```
|
||||
About 120 answer 200 and the rest 429 (fewer pass if you sent requests in the last minute). The
|
||||
WAF rule needs more than 300 requests within 10 s — faster than `xargs curl` gets from a home
|
||||
connection (~20 a second). Node's `fetch` keeps a pool of connections and does it:
|
||||
```sh
|
||||
node -e "let n=0,t={};const go=async()=>{while(n++<800){const r=await fetch('https://freeitchgames.win/api/health');const b=await r.text();const k=r.status==200?'200':b.includes('1015')?'WAF 1015':b.includes('rate_limited')?'Worker 429':r.status;t[k]=(t[k]||0)+1}};Promise.all(Array.from({length:100},go)).then(()=>console.log(t))"
|
||||
```
|
||||
Measured on 2026-10-27 with the rule above: 800 requests in 4.9 s → 111 × 200, 201 × Worker 429,
|
||||
488 × WAF 1015 (from 1.4 s on), and the site answered normally again 10 s later. Security →
|
||||
Events lists the WAF blocks; Worker 429s show up in Workers Logs (sampled,
|
||||
`head_sampling_rate` 0.1).
|
||||
|
||||
## 2. GitHub
|
||||
|
||||
@@ -149,9 +203,19 @@ Do these once (and again with the `-staging` names for the staging Worker).
|
||||
policies don't claim them). Rulesets: target the default branch (block deletion and force
|
||||
pushes); protect tags `v*`. Merge PRs with squash or a merge commit — never fast-forward.
|
||||
3. **Secrets**: keep `DISCORD_CI_WEBHOOK`, the release webhooks and the Android keystore secrets.
|
||||
`GH_TOKEN`, `TELEGRAM_BOT_TOKEN` and the three `DISCUSSION_*` secrets are still set but no workflow
|
||||
uses them any more (checked 2026-09-24): delete them.
|
||||
`GH_TOKEN`, `TELEGRAM_BOT_TOKEN` and the three `DISCUSSION_*` secrets, which no workflow used any
|
||||
more, were deleted on 2026-10-16.
|
||||
4. **Signing key**: the old key `03F965C2E2DB5C6B` was exposed; sign with the replacement key.
|
||||
5. **Qodana** (JetBrains, <https://qodana.cloud>): one Qodana Cloud project per linter, because a
|
||||
project takes one linter — `itch-typescript` (`qodana-js`), `itch-python` (`qodana-python`) and
|
||||
`itch-rust` (`qodana-rust`, Early Access). Each project token is a repository secret:
|
||||
`QODANA_TOKEN_TS_JS`, `QODANA_TOKEN_PYTHON`, `QODANA_TOKEN_RUST` (Settings → Secrets and variables →
|
||||
Actions). `qodana.yml` runs the three jobs; the settings are `webapp/qodana.yaml`, `qodana.yaml`
|
||||
and `webapp/src-tauri/qodana.yaml` (each with a quality gate of 0 problems: a finding fails its
|
||||
job — fix it, or switch the inspection off there with the reason). The three linters need an **Ultimate** licence: when the
|
||||
trial or the subscription ends, the scans fail with a licence error — renew it, or delete
|
||||
`qodana.yml` and the three files (nothing else depends on them). A new token: Qodana Cloud →
|
||||
the project → Settings, then update the secret.
|
||||
|
||||
## 3. Releasing a version
|
||||
|
||||
@@ -160,25 +224,50 @@ Do these once (and again with the `-staging` names for the staging Worker).
|
||||
`webapp/src-tauri/tauri.conf.json`, `webapp/src-tauri/Cargo.toml` + `Cargo.lock`, and the version
|
||||
badges of `README.md` / `README.vi.md`. Write the notes in
|
||||
`changelog/<major>.x/ver<major>.<minor>.x.md` and add the row to [`CHANGELOG.md`](../CHANGELOG.md).
|
||||
2. Open a PR; when CI is green, merge it with squash or a merge commit — never fast-forward. A push
|
||||
2. Run the accessibility smoke test ([`ACCESSIBILITY.md`](../ACCESSIBILITY.md) §4) on the preview or the
|
||||
merged site: the main tasks with the keyboard only, a screen reader spot check (Narrator, NVDA or
|
||||
VoiceOver), 200 % zoom and a narrow window, reduced motion, and a Windows contrast theme. If a
|
||||
change made a known limitation go away (or added one), update §6 of the statement and its
|
||||
Vietnamese mirror.
|
||||
3. Open a PR; when CI is green, merge it with squash or a merge commit — never fast-forward. A push
|
||||
that touches the changelog posts to Discussions → General unless the head commit says
|
||||
`[skip-discuss]` (the release announcement usually covers it).
|
||||
3. Apply any new D1 migration and set any new secret **before** the merge deploys code that needs them.
|
||||
4. Tag from `main`: `git fetch origin && git tag -s vX.Y.Z origin/main -m "…"`, then
|
||||
4. Apply any new D1 migration and set any new secret **before** the merge deploys code that needs them.
|
||||
5. Tag from `main`: `git fetch origin && git tag -s vX.Y.Z origin/main -m "…"`, then
|
||||
`git push origin vX.Y.Z`. `release_desktop.yml` opens one draft release and the desktop and Android
|
||||
jobs upload into it (12 assets for 4.x). Never create the release by hand first.
|
||||
5. When every asset is there, edit the title and notes (from the changelog), then
|
||||
6. When every asset is there, edit the title and notes (from the changelog), then
|
||||
`gh release edit vX.Y.Z --draft=false` — that fires the Discord and Discussions announcements.
|
||||
|
||||
## 4. Routine
|
||||
|
||||
- **Maintenance mode** (since 4.6.1): the project is stable. The work left is the weekly dependency
|
||||
sweep, security fixes, runtime updates and the items below; feature requests and code pull
|
||||
requests are closed with a pointer to README → Project status. Issues stay open for the data
|
||||
only (add, fix, remove a game), accessibility barriers and things that broke.
|
||||
- **Mass-change alert** (Discord, "mass_change=true"): itch.io probably changed its page markup. Look at
|
||||
a few flagged games on itch.io. If the parser is wrong, fix `scripts/scraper.py`; if the removals
|
||||
are real, dispatch **Refresh catalog** with `allow_mass_removal`.
|
||||
- **Removal / takedown request**: `/admin` → Catalog → the game → Remove (the reason is public). A
|
||||
wrongly removed game: Catalog → Removed → Restore.
|
||||
- **Removal / takedown request**: `/admin` → Catalog → the game → Remove… (the reason is public; the
|
||||
presets get a translated label on the Removed page). Several games: tick up to 100 search results, or
|
||||
paste their URLs under **Remove by list** — one commit either way. A wrongly removed game: Catalog →
|
||||
Removed → Restore.
|
||||
- **Review queue**: `/admin` → Review queue. "Approve with override" is needed for games that were
|
||||
removed before.
|
||||
removed before. Selections of any size go out in batches of 200 (one commit each).
|
||||
- **Adding a list of games**: `/admin` → Add games. Paste any text (or load a file, or read an itch.io
|
||||
collection), press **Check** to see what Add would do, then **Add**. **Recent batches** follows each
|
||||
game through the ingest (added / waiting / dropped with the reason); the ingest runs right after each
|
||||
commit and handles about 650 games per 45-minute run, the rest waits in the queue.
|
||||
- **Automatic rules**: `/admin` → Settings. Auto-approve (on by default for RSS and Suggest, after 24 h)
|
||||
queues pending items without a flag that nobody rejected; it only considers items found after the
|
||||
moment it was switched on ("Include older pending items" lifts that), at most 100 per cron run.
|
||||
**Followed collections** are read in turn (≤ 30 pages per run, one a second); their new free games
|
||||
are queued directly, removed or flagged ones go to the review queue. Settings also shows what the
|
||||
last cron run did (Workers logs are sampled), and a collection whose page could not be read (status
|
||||
422: itch.io changed its markup) adds nothing until `worker/collections.ts` is fixed.
|
||||
- **Reviewing new games**: `/admin` → New games (added in the last 7 / 30 days): set 18+ and the virus
|
||||
check for up to 100 games at once. **Activity** lists every admin action and automatic run with its
|
||||
commit.
|
||||
- **Build failed** (Discord from `deploy-status.yml`): open the build log linked in the message; the
|
||||
site keeps serving the previous deployment meanwhile.
|
||||
- **New D1 migration**: add `webapp/worker/migrations/000N_*.sql` (never edit applied ones), apply it
|
||||
@@ -195,6 +284,10 @@ Do these once (and again with the `-staging` names for the staging Worker).
|
||||
```
|
||||
`npx wrangler tail` shows the `legacy-data: 410` lines with the requesting `Origin`: an installed
|
||||
app that sends an unexpected one would show up there.
|
||||
- **Visitors report "Too many requests" / error 1015**: "error 1015" is the WAF rule (section 1,
|
||||
step 15) — raise its threshold in the dashboard, effective within a minute. The site's own "Too many
|
||||
requests" page or `{"error":"rate_limited"}` is the Worker: raise the limit in `wrangler.jsonc` and
|
||||
deploy. Both reset by themselves (10 s / 60 s).
|
||||
- **Verification gate misbehaving** (visitors stuck on the check, crawl errors in Search Console):
|
||||
`npx wrangler secret delete GATE_SECRET` turns it off at once; then look at `npx wrangler tail` and
|
||||
`curl -s https://freeitchgames.win/api/verify`.
|
||||
+9
-1
@@ -7,7 +7,7 @@
|
||||
|
||||
[tool.ruff]
|
||||
line-length = 100
|
||||
target-version = "py314"
|
||||
target-version = "py315"
|
||||
|
||||
[tool.ruff.lint]
|
||||
select = ["E", "F", "I", "W", "UP", "B", "BLE", "S113"]
|
||||
@@ -22,3 +22,11 @@ ignore_names = ["no_network"]
|
||||
testpaths = ["tests"]
|
||||
# tests/conftest.py blocks all network access; parser tests use saved fixtures.
|
||||
addopts = "-q"
|
||||
|
||||
# `pytest --cov --cov-report=xml` writes coverage.xml for SonarQube Cloud
|
||||
# (.github/workflows/sonarcloud.yml); plain `pytest` measures nothing.
|
||||
# Relative paths, so the scan job resolves them in its own checkout.
|
||||
[tool.coverage.run]
|
||||
source = ["scripts"]
|
||||
relative_files = true
|
||||
branch = true
|
||||
+36
@@ -0,0 +1,36 @@
|
||||
# Qodana for Python: the data pipeline (scripts/), its tests and the Python
|
||||
# maintainer tool in webapp/scripts/. Run by .github/workflows/qodana.yml
|
||||
# (job `python`), reported to https://qodana.cloud/projects/GgGnX.
|
||||
# The web app and the Tauri shell have their own projects: webapp/qodana.yaml
|
||||
# and webapp/src-tauri/qodana.yaml.
|
||||
version: "1.0"
|
||||
linter: qodana-python
|
||||
withinDocker: false
|
||||
profile:
|
||||
name: qodana.recommended
|
||||
# The quality gate: any problem fails the job (and turns the README badge red).
|
||||
failureConditions:
|
||||
severityThresholds:
|
||||
any: 0
|
||||
exclude:
|
||||
- name: All
|
||||
paths:
|
||||
# Analysed by the other two Qodana projects.
|
||||
- webapp/src
|
||||
- webapp/admin
|
||||
- webapp/worker
|
||||
- webapp/vite-plugins
|
||||
- webapp/public
|
||||
- webapp/src-tauri
|
||||
# The catalog and the pipeline's state: data, not code.
|
||||
- data_game
|
||||
- scripts/state
|
||||
# itch.io pages saved as served, golden files and vectors for the tests.
|
||||
- tests/fixtures
|
||||
# `${{ secrets.NAME }}` in a workflow is a reference to a secret, not a secret.
|
||||
- name: HardcodedPasswords
|
||||
paths:
|
||||
- .github
|
||||
# It reads requirements.txt only; Pillow, for webapp/scripts/gen_assets.py,
|
||||
# is a development dependency (requirements-dev.txt).
|
||||
- name: PyPackageRequirementsInspection
|
||||
@@ -0,0 +1,13 @@
|
||||
# Lint and test tools on top of the runtime pins (`-c`). requirements-dev.txt is
|
||||
# the hash-locked compile of this file; regenerate it after an edit (CLAUDE.md, gotcha 40):
|
||||
# pip-compile --generate-hashes --allow-unsafe --strip-extras requirements-dev.in
|
||||
-c requirements.txt
|
||||
-r requirements.in
|
||||
ruff>=0.17.1
|
||||
pytest>=9.1.1
|
||||
# `pytest --cov`: coverage.xml for SonarQube Cloud (.github/workflows/sonarcloud.yml).
|
||||
pytest-cov>=7.1.0
|
||||
vulture>=2.16
|
||||
pillow>=13.0.0
|
||||
# pytest needs it on Windows only; listed so a lock compiled on Linux (Dependabot) still installs there.
|
||||
colorama
|
||||
+489
-5
@@ -1,5 +1,489 @@
|
||||
-r requirements.txt
|
||||
ruff>=0.16.10
|
||||
pytest>=9.1.1
|
||||
vulture>=2.16
|
||||
pillow>=12.3.0
|
||||
#
|
||||
# This file is autogenerated by pip-compile with Python 3.14
|
||||
# by the following command:
|
||||
#
|
||||
# pip-compile --allow-unsafe --generate-hashes --strip-extras requirements-dev.in
|
||||
#
|
||||
beautifulsoup4==4.15.0 \
|
||||
--hash=sha256:288e3ca7d54b06f2ac191970bc275c1939cb46d450b255bf6718b04aa37ab4f7 \
|
||||
--hash=sha256:d6f88de62e1d4e38ecb1077eb9724cd0eff29d2a08ca16a401e9b9e93f117cf9
|
||||
# via
|
||||
# -c requirements.txt
|
||||
# -r requirements.in
|
||||
certifi==2026.10.23 \
|
||||
--hash=sha256:a9895e6e2758b371e0545e321a3a8fd1fcfd9829ada8824a936dfb16aaaf36cd \
|
||||
--hash=sha256:e9b54de76e530bb6cf0ccd036787103acb58fd42ba930ea8bf948ddbaa2f61d1
|
||||
# via
|
||||
# -c requirements.txt
|
||||
# requests
|
||||
charset-normalizer==3.5.2 \
|
||||
--hash=sha256:01077390b03f7988f11d700a2194e69b119741a86b1a638b1db88891e3eced8e \
|
||||
--hash=sha256:01b0c0d2262a9e28e8484a278c7e1b5d650e3ac8cf2683d2967e25899f208bdf \
|
||||
--hash=sha256:04851f73ae72b8413dddadb16a49dfee95263553741fd42d546f7d66907e6be5 \
|
||||
--hash=sha256:0521c5665880b33d603717defa76c094048900010897909952397feb3039da56 \
|
||||
--hash=sha256:0774bf9bf620249fee3e0b8b9fd3065de213be30f3aa94ce2494b3b638949e26 \
|
||||
--hash=sha256:0891b9d3903c5571c03771ca669a4b0ec5618ca722a5c957d3d29cd4e5062848 \
|
||||
--hash=sha256:0c951d5e6dd9c2ff60609476752bee49da4206adde960ebc247766937f72e718 \
|
||||
--hash=sha256:0fed1d06615f022ee3b13caf5e8b180cfea32bb2c5aded8a9d44277afc040f93 \
|
||||
--hash=sha256:114e4d0c92d618409ed82a99e22b5c5e768fe995f2973f78265f4524f49d4640 \
|
||||
--hash=sha256:11912e4bb14baae7c5d8791aa55ba0a3a03ec6729073307b0f57270abaa713d3 \
|
||||
--hash=sha256:11a4d68a6ecda3292cb1e50239e111543ba5d709bb62a6b4ea1afcfa729d8875 \
|
||||
--hash=sha256:124fbf1a8ff966d87ae05bb8bd45a71f966055ed8bba320d0c7cf450bc5f4d0e \
|
||||
--hash=sha256:1461ac396c4fdb983a675f20aa555624f0ee18ac83d832b9244ffff3d8055275 \
|
||||
--hash=sha256:1503bccbeb36d5527790c3930327704c39af22de3112f1b1666a9f3ce15ee204 \
|
||||
--hash=sha256:15bb4005af6320d259dc7593ca84a38d7fe06a421dbcf7b910ae23979101e787 \
|
||||
--hash=sha256:15c44f7edfd477b06f517a5cc317fc1707edb9de2c865f43d4b6513907473234 \
|
||||
--hash=sha256:16fa0eccf81304b79c5cd87f9271c3b85dd9dd99245e4422ae9c0dd45e0f99d3 \
|
||||
--hash=sha256:183b88127acdb4fabe59d951ab424faf1af7b63cdbb5f776186c1ea2ffcaed98 \
|
||||
--hash=sha256:195c26fb65950f8fce54e26349852b7bdd7c5f120aeefbcc440b8a20faaed4a3 \
|
||||
--hash=sha256:1afb975bd5d68d5ce9f6b6d44fdf2f7e34b895a35e95708a7a91b20a3b51d187 \
|
||||
--hash=sha256:1b4cbc7c3491ccb4aa17fcd8165649d01cf39f76de1696da8631b5f71b85401d \
|
||||
--hash=sha256:1bc0baf5ef96b6ede57d47f4b8fe4d9d84019c3bfcbeb20a41edc6a6ee341f1f \
|
||||
--hash=sha256:1c50fe28bbc2ced33386f298650d91218076c05420e6cbd790b913adc41659e7 \
|
||||
--hash=sha256:1db38f4c5496827c1a501846d64d14c3b80c7e6714e406cd7dc36a9899fa1011 \
|
||||
--hash=sha256:211d5a3eb6af8f513b8d4ca19a8c1b7accab1b5f0d3175f9826b03c1a920dc1f \
|
||||
--hash=sha256:23851fb4e1b85ed3f6c2a27b777cdfe2e19fb5b38429a8faf38c7542b7665869 \
|
||||
--hash=sha256:254eb48b9fa5ee9898a3c445825a1f340fe53712a098904b39b0bddba8ea3cb1 \
|
||||
--hash=sha256:2625388c6c754520c37abaf3b41eb34d1cc4a373f457898f08606c8e362b891d \
|
||||
--hash=sha256:281cb91036248400f4cc957495cccd44c275c2e0c5854f7e45ac5cf7dc193847 \
|
||||
--hash=sha256:28a15fdad492a99b6eccfaaed66ef3f74050680545ea61ec8b2f4c538f1f1320 \
|
||||
--hash=sha256:28b4f0d66fb834ff90f28209ac7bce77868c45d8c93e26f906709d9b7c2e1af9 \
|
||||
--hash=sha256:2a925889534b3748302dae5dead07cc13480de1dac3aea80a941b729b471ef93 \
|
||||
--hash=sha256:2b7b3bbfb4fe8ef40600792d762fbaa9057559f9d3fad209525b7a22b99e91fd \
|
||||
--hash=sha256:2c9ad19a6cfcd5ea5c0d41161d22f9df1dcc277e9bef2751391334546a314c00 \
|
||||
--hash=sha256:2cc961b171b3f3440f410489ab3573e86aea8736134ebbb40ea1338b7f0831bc \
|
||||
--hash=sha256:2ce45c6627b22c47e390bc91a41c3d13032192e699fa0bea96e9671b373d69b0 \
|
||||
--hash=sha256:2e06a3a98f916dd41d27f3105e02e7a40181c98c94b9158733d03a6f80506c09 \
|
||||
--hash=sha256:304d5463e65a35d7bb0850550e0780395395f6fcf452f04db7d5ca7cecc425ac \
|
||||
--hash=sha256:304d8e4d493af723536393eee0c689eb7813f4a474c8b479dee63f1fdd98f621 \
|
||||
--hash=sha256:30fcd120b732aa79317f08dee04d7de0847822e4cf7ee0e9f445bb958832252c \
|
||||
--hash=sha256:31f3930700408d211f13378ccbe1c40845d8da54bd0681fac3a9b5aae81c7aa8 \
|
||||
--hash=sha256:34276fd796040bf0993ab33a369aa572e6979c7aab225a88893667ad8eac8f7a \
|
||||
--hash=sha256:355ad8011081dec5412240c087a9a0c9d4d5039f3ed11a3f13e18c2b29b56c51 \
|
||||
--hash=sha256:38a873987f3be698494da8b2e3085e29da02da7b633dce73e79c699a113d7bf0 \
|
||||
--hash=sha256:39de2a259fc954455c57274dc94c79d5842774e1247a016aff30bc0efed0f4ef \
|
||||
--hash=sha256:3d14b50de6bf4d0edf857a9386836846f982b8f524e188e2e68b96d702bcf4aa \
|
||||
--hash=sha256:3d21b8b13c7592db2ac5e544a6d83187b995257472b0c9e8351b6d507ae37ed6 \
|
||||
--hash=sha256:3d31298449090ab8d47b7b1b2a555ff73cac7ed438a08b7ac160980c7ebed649 \
|
||||
--hash=sha256:3ddacd27458c45bdacd6bd6db644bfb730efbf9e830310186e3045c9c5be8fb2 \
|
||||
--hash=sha256:3df041de8887954562c9b261cba85ca0e9ded74048daf125f45edcfaa4832229 \
|
||||
--hash=sha256:40ab6bffa02ae10a0581e6c198be7d2d8ca5c2a0c64e4ed3465d766df457573e \
|
||||
--hash=sha256:4275811936e2f06feff5e598fb42a1b7ae852da8e39605211892b56b81a34efd \
|
||||
--hash=sha256:443eae2bf318abeaf6f15d785138f71fd6de770e99a92158b8b814265e079115 \
|
||||
--hash=sha256:447441e76ec720b15e64418d32e092297340387053047c7c694f579efb0ee1d9 \
|
||||
--hash=sha256:4495c5002a7b28557e7e222e77e0b661183e432b7d6d2e788101e3f240e05b8c \
|
||||
--hash=sha256:44bd4fbb29dfbeba60e7d2bd000c59e4b21ddb3cc53912b14048d37092706d7c \
|
||||
--hash=sha256:4685902cf26edf013ed7a3da0f426ebba7a00ebb9541386d835afbf002c11cab \
|
||||
--hash=sha256:498dc3188ca05a68231ac3fdbfc7f57eb67e1343c30e0fea17f8218c1599b253 \
|
||||
--hash=sha256:4c2b5031f63e331e3839b40aed2dd6f191e9c07edbde303e7876846ea1946995 \
|
||||
--hash=sha256:4d48f2d08b9de5864e2c8744d4461b862fb149a18274abc8b698c45975573438 \
|
||||
--hash=sha256:4f87960d57feabfb618e4e0af6e7371645fa26a277860739d6e5d6e0012c92f0 \
|
||||
--hash=sha256:50e3adfb96fc189eb27b1cf62d3b598b89b4bb0420d93a3d3e42e137409011be \
|
||||
--hash=sha256:51cf45226a9b588d0d2b4880c62d686934b63ab0bd79ca23ab0e9762eb27441b \
|
||||
--hash=sha256:52aa6992700996af31f375de0c6bacd402b0097fe40b53c426b9f51a90ebabc7 \
|
||||
--hash=sha256:55ea99acb17b9325618de155a0cd6a2e8f5d10be008113e1d433bbb58db543b2 \
|
||||
--hash=sha256:56bc200a365efb37383b7852e4cc5898d3b2da5987289b543956cf8cad71018a \
|
||||
--hash=sha256:588461c2e8384d309bd63e5826019b6977bc66d629b99ac8737bb795d7b2cb5a \
|
||||
--hash=sha256:58ca3755ee7ff7f59b57789ec9833c9de9ea275405cdd240eda1f193112e398a \
|
||||
--hash=sha256:58f361dcbab699cf8f42db3f47c8e7fd1036f138c23a5d08de9fde5f425a730c \
|
||||
--hash=sha256:598a11a2c7ebaa5334bf698bf29568c9c390abac6a154d8170fedecd1cea38c5 \
|
||||
--hash=sha256:59f63901b0031c3136cf64704dcb21de0bbae62ce2c9529bc39d27665463de37 \
|
||||
--hash=sha256:5cde776b7cc66e4f6c99612cea4aa7269aa65863f7a15841b2c264f103822f4e \
|
||||
--hash=sha256:5e2b6b57e9733d39f0c9fd3185efa6b8e29652c4cd8fe94180272cf6ed9a78c4 \
|
||||
--hash=sha256:5fb29fb8cd1a46c27a1bf9613ad5ec2599310d46b4025d9556404a6b6a292800 \
|
||||
--hash=sha256:6045373d5a89a5ec71afde535db987ca28e76dfa276c2d4c818265b375d4b055 \
|
||||
--hash=sha256:619799369eeef6366ed3e8755a5670f4f2f0fb6b30a0fd7264dc0fdc2357058e \
|
||||
--hash=sha256:62588a277bfb59def052abd940703fa35107152bf479781a878617d60faf8fb5 \
|
||||
--hash=sha256:62603db9a7caa0802eaa28c1c46fecd7b3a263a774069c24c3c28c302448721c \
|
||||
--hash=sha256:65cd72beeeca9d3aaea1201e5923859f308f952f9c71de93f06063c79f0f7a3b \
|
||||
--hash=sha256:68eb192d85ab8e5f6ec69c2bc6ac0179fbf04a5ac1569d12fbef74883fe102d0 \
|
||||
--hash=sha256:6bd128f206a7752ae1f2ab6c61bf8a24ba28913a10df8b14c2637b973ff97a80 \
|
||||
--hash=sha256:6be488a102b8cf28d0391d8c4ba7748938ae28b78ad901f8585520fca33ead1a \
|
||||
--hash=sha256:7218e8f32b0956cfcd048fd42d9d5779809745ca1d86113ca56f66e7ae1549c4 \
|
||||
--hash=sha256:7441d755b7ab94f8d4eb3e43ec05482d760842fd263d003a99102d742cd835e2 \
|
||||
--hash=sha256:749e97e1b32313717a565abbe321bc2190bc8b35f1a67e4cdbc7c56c8d8ffe58 \
|
||||
--hash=sha256:75a3ceed0724d625d64b86ca20aba182e4df462e04c2414fc941c0f523f06aac \
|
||||
--hash=sha256:780fbe7cab297b81dad9fb8dc5eb003c0468ffb0d9e5f65068c53a34661a96bc \
|
||||
--hash=sha256:78456a747de8dc58360ffa581f30a002baf5aa28cb262536545e91f113ed7639 \
|
||||
--hash=sha256:7967d08cf06dee78443b874f98c98036f624f3a4e73e11f9f64f5be4d25393cf \
|
||||
--hash=sha256:7a881931aa470808df94a8c380eed2bbbc76cd9dc622310f99665658c821eb6d \
|
||||
--hash=sha256:7dcd882da75ef9adf94903b1e3b9419e8aa8fb4c7396822b834b9ef7fb96954f \
|
||||
--hash=sha256:7e841fb9010836c992c9f12fcbd43a831de93a5f726fc1ccd8ca1d0268c5014c \
|
||||
--hash=sha256:7fdde2c9fd9e3eca40631e024664cf2584272cc8f96308cbe5fdfc930f51d8bc \
|
||||
--hash=sha256:8024d00c3faf3fc0c16e07a69f4405e8eac7cc0ab15f65fe6cf43827c4cf72b4 \
|
||||
--hash=sha256:80d02b6f04e92601a081dd97b23d3128033098bff5d35d392ddcc0476ea11253 \
|
||||
--hash=sha256:838dcc90063569a0448120554591a1d6c4a4ffe11babf048908793154ab86ade \
|
||||
--hash=sha256:849df64e889b2e17230d58410a03dba311a65b163508fd33679b2b737d4b7858 \
|
||||
--hash=sha256:87475fabc8d9996fd9c27debb395e642e8c838d78a00b6e932227a0e06b81e26 \
|
||||
--hash=sha256:87e50a3e7cb90af586b6c5faf23e302a970415ac73bd7bd90a515a04b427ef96 \
|
||||
--hash=sha256:89b53f3cda69831909888e0494f4fa0bcd3537e3e138dabeb620bd6ad946bae8 \
|
||||
--hash=sha256:8a893cc101149f80a653f82062ebc95b34525a2614382e1da5458fe7c6997249 \
|
||||
--hash=sha256:8b2bfab86aa71ae13aa41a6a26aab338e0db2b8bc75434b05aea89e011ff35a4 \
|
||||
--hash=sha256:8d86d6fc60743dc916eb79e2eb1ec4818e21e427731543af40a3021851174a13 \
|
||||
--hash=sha256:915563965d418f986e7e145accc592eae9e1a1be3566ff98a05d7a9ec42a76e1 \
|
||||
--hash=sha256:92888bb3187c5ba50500b00b3b310c9f2c651709d28036077680cb5255450a03 \
|
||||
--hash=sha256:93223adc95033dd47133a46ccfc316a0139176fd79085762e27202ec56018f03 \
|
||||
--hash=sha256:9373ad13ef0d2c0fb761e04e55bfdee5a08b52cef2c882c8fbe9935b1517152e \
|
||||
--hash=sha256:9409a8bf35cf78353942504b24a57de3d75b708997a1e4bd8db71ac8633ce364 \
|
||||
--hash=sha256:9b7f416ff0978e2f2249330527f0ad6fa02f4932e6199692d3b52da2048c19e4 \
|
||||
--hash=sha256:9bde855991b7e362c146535e3136a50bfaffc0487d38b33ca7e5edefc6e23849 \
|
||||
--hash=sha256:9cae88599c7219005d879f98e5ed53341e9a122af585e1091200358a3003d2a0 \
|
||||
--hash=sha256:9cf9b1a857e25c4baceeb3624e92a56df3668f398c4acba74e174d81fb4d1d3a \
|
||||
--hash=sha256:9f56f72050826f63dcee7a7f55b0a77168cb3bfc553fd405e7f8f9ece75a4036 \
|
||||
--hash=sha256:a090bb2c68df85450502e3e20d665e3a5af9c65a84d6508ed477badd49166fd3 \
|
||||
--hash=sha256:a192e2c40070d92c3ccf777e3a5c4ff515573cd2bb7ed0c537fdadbbec5bbf21 \
|
||||
--hash=sha256:a19a731138fc27d5682277d3b9df22855cea1239bce7fcec5f78f42ef2d1f3c3 \
|
||||
--hash=sha256:a66c3bc5ab1f0ff2164fc9965ddd611ff0802173f4b9d24554c563f6ab7e1d6e \
|
||||
--hash=sha256:a815775b6c38d4e0ff7bcffbeba67feded90202bb6a226b8dd35f1c855217413 \
|
||||
--hash=sha256:a89012d6d5476ee112d20d998570ed58df2260a852afb1758809cd6900411d21 \
|
||||
--hash=sha256:ae4f5fea5b8b8ccff88238cc8569303e5ee95efae67fa62922a311397a71f346 \
|
||||
--hash=sha256:b6856554c4f44d79fc2307d5768854310a8f0096e501c75637542c82292b0429 \
|
||||
--hash=sha256:b6b751274acb69d77b3323d6b7dbaa3c7fdfc1eb829b7eb61d262f32e1af9685 \
|
||||
--hash=sha256:b736353c0a625bbd5fcec108576e2385db3496f4f771f785ff32e108d3c3bc45 \
|
||||
--hash=sha256:b7fd005a73d9e657273b7a10dc71a9e03c8fb9ee6999798d6918ce095b81ac7f \
|
||||
--hash=sha256:b91363207bd9dc966a691e959bb47f64b30f7ac4b072be9968b366982f7db77c \
|
||||
--hash=sha256:ba0b1d2620edf869789c3879223f52bf2afc5d31b3cb47cc57b3a12c05e2aa9d \
|
||||
--hash=sha256:bbbfc8e28816f19d7c0f1816664980c0a9875d01b27cdf8eedddb639d9e108ad \
|
||||
--hash=sha256:bd16aabe4a02a297c23417aa17ac6299dbd8c49f673bcd645b4929b11f5a4400 \
|
||||
--hash=sha256:c0afc6800ba57ccc350374c5bd6150419915d95ce93cdbab2d783d75eaf30ecb \
|
||||
--hash=sha256:c6708715abcf3c73b99508253e961a9967f02fe536532834149574eda6de0d1c \
|
||||
--hash=sha256:c7c9ab723cde841fefb34efbad91e87f00a674b1fe1cd0784fde742bf2c154dc \
|
||||
--hash=sha256:c8f3d67aeaf55f017982b73683f0e7342ba2f6635a78f69ce89ebb26aa411e5c \
|
||||
--hash=sha256:c9790464842f85f437dbbb54417eda1e0e6bfc52dd8d22d6fd1c994b73b2dc74 \
|
||||
--hash=sha256:ca403d7e4798f525fdfc78e258820419cbbd0f0ecbab9de7840e3c017cf6b8cf \
|
||||
--hash=sha256:d008d90a7f2471519aef0c90dfbe73b3e6e4d5e66ac48e19154c17e89e98b604 \
|
||||
--hash=sha256:d19fbd981a488e22cd04883659ca6b08f50b5974f9fd7c95655ef6a043e5893f \
|
||||
--hash=sha256:d1befeed746d247c81127bb14de9dc3d30edb6e5976d34f83f86ed262b1d9105 \
|
||||
--hash=sha256:d2374b62878abb00cd8309b32af6c0b715cd02dec0ca74ef12e5069bdc64144a \
|
||||
--hash=sha256:d376bbd28b3a8999db1a103b3b388aee6f1ddeb3e51bc2172993efdcd86e064d \
|
||||
--hash=sha256:d4a7319f304a774bed22115bc891618e45f85065ab44ea6acd07d274e750519a \
|
||||
--hash=sha256:d6734d2ef8a50fbf8445c139477da401f50d62a0606bf00e20ec6d87773fefb1 \
|
||||
--hash=sha256:d760fe2a4d7c3b226cb9026d6a842868d52a7901bd98420e1baf14e80da85cf5 \
|
||||
--hash=sha256:d913de495d90407cd859d263bee2e5d1a4ed3eb6573c04e70d9ec619a7cbed7f \
|
||||
--hash=sha256:db19d07e2e0129e974a0e65d0064fc222a446cd5122c2fd4184d2af9fc734a9e \
|
||||
--hash=sha256:dca9ab98072a5a54ebacebdc45f53e645336b320c667410b061be1ca588ae709 \
|
||||
--hash=sha256:ddc7dacc8ece3a182e7f15cb862d1fd616b46d076cb1ae9dd232b2c38b655874 \
|
||||
--hash=sha256:ddf19c062bea7a0cc80f519243d2c01dd091be0cf952a0750d4ad576709559f5 \
|
||||
--hash=sha256:def79fa35ef0cef8d2accec024f4fdc7ead3012ff02f5215c783f39f03ef8cfc \
|
||||
--hash=sha256:df29a0a7107f7011e77f4eebdddec4c7331e24d787a0b21a46d63bdf7445da95 \
|
||||
--hash=sha256:e09a3942ecbdee5cce73ea9d42da82b81b72ac1bf031ce069b93b5adf4eac8cd \
|
||||
--hash=sha256:e242bb1c5e76e97dfa9e7f209a71e93a01d7f19ffdd5cfbb2e2d55b4f08f8ab0 \
|
||||
--hash=sha256:e243bd13217235fc7290c621941c3f5cc8b66e4872495be821d7436ba2fb838d \
|
||||
--hash=sha256:e2af3aad578aa6bd1384bcf4750fc285e5a9de53f40b7d41e5a0bf748edeb2b3 \
|
||||
--hash=sha256:e4e81e09c1578b8df602e3db08b0b3ea0a6947ad612f52bf8dc5ea8d47691f0c \
|
||||
--hash=sha256:e54da4baf05720032d527874d40b65fa4d7e5c6c6a43d0c3adbeffcaf275a2b3 \
|
||||
--hash=sha256:e80e6c2f55656b4824d72065abb4ddd6a525c74bd78a0aab5d9fc2cf4fb5af50 \
|
||||
--hash=sha256:ed2a239c0ea213acc1908150a3037257083c7c083128f1a4cec2ec4b97dca491 \
|
||||
--hash=sha256:ed905975ab14056a2e5eb1c376cb2e1ebc5396baf84163939c518556fccde9f5 \
|
||||
--hash=sha256:ee21e28f0430bd6dc9086c6e525d5e818a44a5ad19720c8a0ef766792f3eb5e5 \
|
||||
--hash=sha256:ee43c17b173d46a3212baa6ead3ae258eeabdae48c263a01ccf0218c366dd655 \
|
||||
--hash=sha256:ef4fcbf3327382cd4c9f540babd61248208af7b93eec4de397b4d5f58a09e288 \
|
||||
--hash=sha256:eff0ac9dbe711a4aee69bf04a83896aa9b85f19641264053a9f6d48573abb7dd \
|
||||
--hash=sha256:f0aa869112ef88429ae17820d99c3dd9504c9e9c671d3c246f3d7442cb051084 \
|
||||
--hash=sha256:f3c96f633825733f735c5a9cf21d21a257d8e1edf0b1cee0a064b9c424ca0f7d \
|
||||
--hash=sha256:f5833ad231be5eb6553de524a70f48d71b2c8563101750531e0b80184e175cd4 \
|
||||
--hash=sha256:f5ec61164adcec446f8969a3358ec3f9b26bbda3b9213e5586d219afa8df2915 \
|
||||
--hash=sha256:f7d486c83842422badd511868fd8a9a20e9407ace71564b6af47ce7e60a336c1 \
|
||||
--hash=sha256:fb9e68df06293761f9fe66ade60a9bc6d0f5e42b8acf2939a9158af86ab0e5bd \
|
||||
--hash=sha256:fc14a032f813bf5fe624d991960ea83e9715adc27e4c1830a2361eb1d02ac341 \
|
||||
--hash=sha256:fcff63213e8e6e47770541a4607175404f47cbb3ebea7b6058cc82d524a0e424 \
|
||||
--hash=sha256:fd1fbe0f116b6e55da77aca2c6ddcddcfac2186cbf78bdebf40fc156efca389d \
|
||||
--hash=sha256:fe9753dfee015c570d73df76f899f18444d41388bffcde097deba51c4fadbb9f
|
||||
# via
|
||||
# -c requirements.txt
|
||||
# requests
|
||||
colorama==0.4.6 \
|
||||
--hash=sha256:08695f5cb7ed6e0531a20572697297273c47b8cae5a63ffc6d6ed5c201be6e44 \
|
||||
--hash=sha256:4f1d9991f5acc0ca119f9d443620b77f9d6b33703e51011c16baf57afb285fc6
|
||||
# via
|
||||
# -r requirements-dev.in
|
||||
# pytest
|
||||
coverage==7.17.3 \
|
||||
--hash=sha256:0241e03dd65a1edf2e841eb19d8d72dca21ada5c869dcef6c9fde1b166d519a9 \
|
||||
--hash=sha256:0837b71a40749d9c4016cf8c51ba8c6153f7dd40cf4dfa287a2f28376fa50917 \
|
||||
--hash=sha256:0860a5f27ceccd53ee4070acc182588ed4f15b7401cdcca09d8c0cece9c2ad7d \
|
||||
--hash=sha256:095ad10d17a28c845f2e5f99e398db2f0c680401731ff63a3a1789f2e61ef1e0 \
|
||||
--hash=sha256:0bad8245a15bc7b15d26d25ece243bbf5d1b1229144f3db189014174429b63bb \
|
||||
--hash=sha256:11116ab42247d55980b51ab49b5c066de9b6baa56fe371fd555e54feae338619 \
|
||||
--hash=sha256:16ed46c0d461a3972e8474268c22bf5d88cdd1088435313edc7e220050c5ac97 \
|
||||
--hash=sha256:17a4bd9edd312744035e1298a6ac30dd7332a7f1ecdc63c9eb0685589b161eb1 \
|
||||
--hash=sha256:1b358585003cf99a13d1327e11582af19154d2cf3dea366fe0d10ce479a5c9f9 \
|
||||
--hash=sha256:1ba5c445d4c7718422753a393bcb0feb6d9834321cdb43dcb585725a392b3edd \
|
||||
--hash=sha256:1bbbc3e4de867a5e75684d98fc77c20e0687ca3abec69b4421b6f3fb96cd860f \
|
||||
--hash=sha256:1d26daefd513c4775a6d06846389da9a9e3498b6ddba24982359b75b703dd341 \
|
||||
--hash=sha256:1e7a015f952798d7d5120e8122c160fce7322b0b9d144b9be6af71552a3e68da \
|
||||
--hash=sha256:203aa5e42c88e9accfa18a0cc91950499efaa5b179a1da14bcbf5b995afdbcb6 \
|
||||
--hash=sha256:21745c08f2835b847a16887b748d3084dddeb0571ae2a0d62e33644413568b99 \
|
||||
--hash=sha256:222bc51858b0f64cb15d51380541712f8d5dc9bb5ce4fd9828bf466503d6debb \
|
||||
--hash=sha256:228f4bcecadcbb1ec3ed088b0595c5c08f3fca01406b72e8a02209a3af16aff9 \
|
||||
--hash=sha256:22a80bbdee3c22fb3319befaa112a2ed2d6e1417aa75c310f048235170ceca44 \
|
||||
--hash=sha256:24389d7d50f1fe98ac8d8ec1c946656a75b97d953b51a714484e174ed9f48eb1 \
|
||||
--hash=sha256:2765261bdcb5f6c01af41d97ec4fcfe18acd1114d8d2690536a36f86b67c179f \
|
||||
--hash=sha256:28b05f6b2622551805324196c32f3f20f4fa639bade8ac299ca83073253f6663 \
|
||||
--hash=sha256:28d082105e1ead78de56eb46edde029b5af88e22f8bde74fd092ca164bf15492 \
|
||||
--hash=sha256:2b9a39e25bf0e6fe072c6f3bceaa02f5303b9f975e83f590d118c4e92aacf6d8 \
|
||||
--hash=sha256:320a27997b421ea16eeff42cfd26d40584abd436fb7802ca766d6e8610bc9718 \
|
||||
--hash=sha256:349ab42e0b6b72892f187a60a0890b3a76710e93b7c31579e81648d46230a8ed \
|
||||
--hash=sha256:35137f71927b7da9292d391409104391b73c5e80d26b6a0d216d871964092351 \
|
||||
--hash=sha256:397e5342fd4f19ae930a5234643a63a8eaccc18a2f034a2f1765a5313123489d \
|
||||
--hash=sha256:39c063c038b710e0bca3afd4997ccee680674bece468fac13cb8aee9af530d31 \
|
||||
--hash=sha256:3a5691ef42b16e22976ec0352a76a0f7c3b4196fe3d39805dcc765e31ce54f22 \
|
||||
--hash=sha256:3f6d942e066ca009bd1f7ebf5450287a5e9bfc5a6e20a8d8c408a61b433c7f94 \
|
||||
--hash=sha256:42a1f511a334745a66b8f580c4d561e728243e35f3ada0ada35444c4b2fb9fa9 \
|
||||
--hash=sha256:4300ad360b21af19584c4cc82022979544d776ba2fb2df5418b2f3cae1eee6d2 \
|
||||
--hash=sha256:45268757a45946ab3fc9d2c30019aff2d3804ae660121d5b31f523366f604e67 \
|
||||
--hash=sha256:47cd7674a39bad6480e565e2a5b77f8089ebfbcd3aacc572abc6cebabe1f4cc9 \
|
||||
--hash=sha256:47e49fced11190fdc678182b0e7f8947db4fc1c1216094923a1d2bbedba3c84a \
|
||||
--hash=sha256:499acdc43bf1addf7fecc59a3123847bb96873c07001cfbeb709a71b181fa03d \
|
||||
--hash=sha256:49a4f12eff115fc2447d3438b2c08d7e5adb3abc811c050ee508f8189718cc5d \
|
||||
--hash=sha256:49fff24117050f1784447ae8181e75a78b01cfef4b6a8ccba676d466d1d68d9b \
|
||||
--hash=sha256:4b1300f07904db81508b87a72471e80d37fb6d48debf1168e12edccc81cd0225 \
|
||||
--hash=sha256:4d64248cb7c995aa66dac34c66286c80fb78b13c19bee1503720cc6e55e5de17 \
|
||||
--hash=sha256:4dc3c84002968363c37688e0b325d51a51816c53f3c0cbb925254317c675a789 \
|
||||
--hash=sha256:5559549a14f997b261c936ca463ed67e030511f914ffd1692ad08b3b16ed6034 \
|
||||
--hash=sha256:56b469b63d8270aa67bc919ab8457f4d83115459556a76d09238052a3ab094db \
|
||||
--hash=sha256:582c5d80b6de5b1909a4222ec1f5676bb2e03815c6be9ff43db2d8a71de5079c \
|
||||
--hash=sha256:59b4bd56882387b5a957048a77531669d53d641ce8148c23149d2550e9fd4e25 \
|
||||
--hash=sha256:59c15dcae783ed291da3af6be2e70762322637ac886b19671d12123521cf6ac3 \
|
||||
--hash=sha256:61138b3a51d91ee443b04962ec9990fa140208a7a082b1754135ebd1378a420f \
|
||||
--hash=sha256:620fb331a7d94e3749348cb4a5febcb2ef23ef17192349088e80f4da0cf42647 \
|
||||
--hash=sha256:6695d1bb2a9a2fbd7806d69d78cf30f35eb0f65045da0ec5b5045242fadd6a78 \
|
||||
--hash=sha256:683a204e9773f3127ef836640712270bc4893f10bd7e1ce8a21735dca4c14429 \
|
||||
--hash=sha256:6a8db4bf69a1982cf0fcf16fb11ff17bb2ed3ade5b0e803bb67ad2963a7b1bf3 \
|
||||
--hash=sha256:6d116e2d3b3f3506f634cc48f58dd01497f34a50263e65acfaf6ad7a162f3384 \
|
||||
--hash=sha256:6f8f925262bc0d6fea12d5dde6998aa57f162e05d5a7d50b95d400ab05bb4537 \
|
||||
--hash=sha256:733368982d2799ff04d768916fb755e54d4ce11af3573488ece451745c90d4a7 \
|
||||
--hash=sha256:76a3ddca94ef96b477b7edceac08b1abe0ff26e1ebe1d7000e35bdd17dcde5c4 \
|
||||
--hash=sha256:7c420ffa993c25cc74c263e9c1c869fbaea7d16dcb6448eef4fa6f1905560f5a \
|
||||
--hash=sha256:7f02996b09190bcdee3b2af38bf2279e4a1a65306afd3e6c229029dbe41e42ea \
|
||||
--hash=sha256:8009572d242674765b84ecceba126c2392b1824b32f41db1f3323d23d4cb598f \
|
||||
--hash=sha256:80e219a51ef7ccf78fcd584257e523ece0d390cb3d9d3896660eac05a19ac691 \
|
||||
--hash=sha256:83510c65a385563646297e8dd572e5def63dc300ca08ae15307d99a0225cdfb8 \
|
||||
--hash=sha256:84b5a474040b33f3d805c0b19fadf5a2e78fdd46e0bcb8b813631e5cac64195e \
|
||||
--hash=sha256:86563b5323fc13239d943b22a1bb9ec60f9ca17bd9a0be09c40a89836697aea2 \
|
||||
--hash=sha256:89f49fa6890f28247135934c4d92abb16828124b2cddb681e2496997c37364fd \
|
||||
--hash=sha256:8a054b755bc6665b339a923fed14a54446c43c942bf4edf08a59b1225b284c93 \
|
||||
--hash=sha256:8a0aef07b2eaeee9d82ca62241d5c6586aed5dd729300507d2d3f612588c2634 \
|
||||
--hash=sha256:8b713613ed67d5ed88968799e814888b62c6add21f5becad2cae1ec44260e9d0 \
|
||||
--hash=sha256:8b8188229ab3b3769a1c4aaa22357447555416deb440326c665a3bd25fd45ce0 \
|
||||
--hash=sha256:957ba72e11d26b6e6e1abdaa72e41020871f4108c8ff64ff571fc50c81fb57a3 \
|
||||
--hash=sha256:95da285cf77352d4a527e1fd16c1c5c3762e42d1d71cfa9ef2c72a5c796cce36 \
|
||||
--hash=sha256:9e331bc028b44496ad85d4a2656dbad0feb35baf4a66500042c4aaa878ea132c \
|
||||
--hash=sha256:9e888603ea67c63ba264f39f3459f4cf68adc78dcd9f8bfa65dde601265a40f1 \
|
||||
--hash=sha256:a13a946d8de807d8992e56a09502952d81bfbb4b80204ef77a6a2a38b4ce22be \
|
||||
--hash=sha256:a1dc44fba727d1cbd8daa88ced7dd867aebef5631b116210f2a2d4da08622d03 \
|
||||
--hash=sha256:a5fa43619c0a53a0424783cc08dbb26a2115e3a890ab566fef811b77d04d5501 \
|
||||
--hash=sha256:b355277f181890fdfc7f49af89f398f8735f031b2f9a5801082e678e9ae85972 \
|
||||
--hash=sha256:b65db089de3f219c850f21a2ca915f43f6fa1da5bfb55871c089d3be82c10369 \
|
||||
--hash=sha256:b6876123ce43459a4b39d5778108010b06164225c3a25c6a43cb85a97f80c549 \
|
||||
--hash=sha256:b6db3399e76a366353dd0c9a009fe74c3d1c892de35863331c4d06fbe0dd83b8 \
|
||||
--hash=sha256:b7028eabf24ad18646dbfc6b352cece01779914e69254ddcacdfb9f805d89f61 \
|
||||
--hash=sha256:b73148d024d086239fc04c03daaeb1934a6d295312dd0d6a04a937326c1207d4 \
|
||||
--hash=sha256:bb2b2f47ad4cc671491c725250ae2a5cadf43a3b0f9136e78f7ecf9506a9fd61 \
|
||||
--hash=sha256:bdf8fefb9f1acb3e92842fb42e29968d053e9545e4e9d9edb5c32a30fab8f899 \
|
||||
--hash=sha256:bf7a43782b20951fe9ddc6f6c28da51c65d3c0d5d5fc3c5a0e566986aa3ec0aa \
|
||||
--hash=sha256:c38a85dde92c4129641544aca998382f7448a87a17d202765a6adb8a87a33fc7 \
|
||||
--hash=sha256:c45c4e99a09c70e7d6fe101f59fe4556b89d99bfc80cd4e7f5e13ebb6c1e4854 \
|
||||
--hash=sha256:c4ae9befec714c867f42bbea99e1ec25eecdbe51c8faf1cc82164bd65bf4db0c \
|
||||
--hash=sha256:c53abadc7c4cf7870865fbaf7204e86efbacf93354e010e9188007fe2882a073 \
|
||||
--hash=sha256:c769e6a28bb645c915449ed8ddf6059765a72d8ef79590bfd6202022a4441cd3 \
|
||||
--hash=sha256:cc12f44ac4d5d6be301285c0a4f9c4ae52e673672e284b2a2744e20d24025573 \
|
||||
--hash=sha256:cfb1d2c52bb66e847669000658a5394d50aba835df8e31c2146034f978c8a4cf \
|
||||
--hash=sha256:d0e0fc055d4436f4b6de83f50cbd9da38af18fb36341b162b408ad7842068a33 \
|
||||
--hash=sha256:d3353cb2ad4254fa433cc53d1ee1fe80eebde529085b238393f3f6d5af821f70 \
|
||||
--hash=sha256:d5a3cd933fdffb958b4046d6f19d3138c7c8a28c439aac800badf61fab6d655e \
|
||||
--hash=sha256:dc116b251f7a4ae0266dba0ef31a742c6c517d3a99b4d50016548a17d407ac5f \
|
||||
--hash=sha256:dc6f3c1406fe7e8e2d59eed1f476c5429dcdd11cd3fbe1341acf8ddc4bb9b383 \
|
||||
--hash=sha256:dcd518608b7f869838436ff8d922977e186d1082b9ddad37305ad5282186fd41 \
|
||||
--hash=sha256:dcd6ea389b3da63f467b05c0f47db037a672592ab2035d4bfbb1f662eef4f4a3 \
|
||||
--hash=sha256:df0faa493ab92bbf33ff8bdab442c5b75089baa5ba752844871b5ce9d009a026 \
|
||||
--hash=sha256:e033255f24c1df6e046b6c4e9f91baacae08426beb5296bea8d46176b3a137d8 \
|
||||
--hash=sha256:e04385647f444d55b483a0e4dc519f46134846eddd80910a0d0953ea19e58358 \
|
||||
--hash=sha256:e142166a52ec7edc650b6d3a0b9b1f79dac0ab8843c249e8821ec97a71d1fd2a \
|
||||
--hash=sha256:e266c693c8bd6541f31cd71eda9b5aa3732adecbd04522880ea3d23d99b202eb \
|
||||
--hash=sha256:e3948b2e5c3af0133af3e117ee033e6cc656c43d7549d3296e4b3807908dec9f \
|
||||
--hash=sha256:e4d18e90c87621590a0b1cf2e4caa96f0aa511073f8a1caa3244e09e569564cc \
|
||||
--hash=sha256:e592f790fee57e2bedaa27cdc76988a082090d1aac560ca4bbea80a7a58436ec \
|
||||
--hash=sha256:e9396d4d90fb47a1e124a985ac6a3172dbd58334d1de5189f06b75ae96ff69ee \
|
||||
--hash=sha256:eb25b51a30d07db8493901e3040284f2e756ec2b6549ee392798b9ef4c0607b3 \
|
||||
--hash=sha256:f3347c72d0f4cb3803f4ccdd4331a49a90ef2daa683ce89e2480278400bd2eee \
|
||||
--hash=sha256:f7ff8b21efcbdf9c7a6c051dc158c9bb9e938b7af33e55ed264d2e529b836d17 \
|
||||
--hash=sha256:f8356475aba020621f8277f1a81c2dbdbda8286c7c6130f242c9816e044062a9 \
|
||||
--hash=sha256:f848ec842cb95fddae4b88830b249e8bade41697f16909688d2af80e8b51e7b6 \
|
||||
--hash=sha256:f8f6252bb4c457d686c18e42965087b30155ff72b0dbda6e79a43ee3682c0870 \
|
||||
--hash=sha256:fa8903475085973b5c916e8a958afd22101b9559880ffbeab5aeac4196768338 \
|
||||
--hash=sha256:fab6f713a1f2f0ab7fb7d55f3aea15d1f3fbd31ace61b585ecd87c8e34f898fb \
|
||||
--hash=sha256:faee34ea548318f6f9010928edab2f91b36a19b58376e69ab0e76d4f3a0bf9df \
|
||||
--hash=sha256:fb5945d7360fb258dee758258d93ea624a712fae494e7a0037a92505b3eb8b32 \
|
||||
--hash=sha256:ff0ca078fe63faffff1cff24c804afd4010e35d9c75bb593877b3d4321826c91 \
|
||||
--hash=sha256:ff273110e4e1505ef7a642523ba43f58eb6770ae9e8f869d72efea816cb4bc2c \
|
||||
--hash=sha256:ff5069e99039739c2fade5dd12cf8df7dc1b1217a0b915110605e0bbdddf1187
|
||||
# via pytest-cov
|
||||
idna==3.20 \
|
||||
--hash=sha256:a7db850025b95ded1eae8a46181a1a6c56c92c96f0e2b005d9ff8dc0210cab44 \
|
||||
--hash=sha256:ab7ae7122974553370f0bdb919e1a960b2cd1bc1ef0276416d896db81c14582c
|
||||
# via
|
||||
# -c requirements.txt
|
||||
# requests
|
||||
iniconfig==2.3.1 \
|
||||
--hash=sha256:67f4b9c50da0dedf52af349e7749a80a9057a5031199791b906c3bb3ae878960 \
|
||||
--hash=sha256:9121e2c1fdb355232495be3194c8dfe87ccc2d5dee45947b78e68f499790d7a7
|
||||
# via pytest
|
||||
packaging==26.3 \
|
||||
--hash=sha256:94edc256424af38762eb31306eed28beb9f0efc50a8837492c9d6fd6004aed79 \
|
||||
--hash=sha256:d7193f7c8e4e93f444fde0262bf90af30e16fa0ad0ad44cb553c87339b23cd1c
|
||||
# via pytest
|
||||
pillow==13.0.0 \
|
||||
--hash=sha256:02464da86f561f410e13b061ec37c3068a9cb557a095494157742d07b3c24a27 \
|
||||
--hash=sha256:04a63720f79e22fd54d897c233a68314c50ca0603360f54ce2bd5db8f0f43782 \
|
||||
--hash=sha256:05cd2cd39055d0b9650060e4513ef4a9a0aea870083950bd046a0d6490f93a22 \
|
||||
--hash=sha256:06903aac074d00c988e77a1fc435286dc498506d4ca8d6f69df9babddf4ecc15 \
|
||||
--hash=sha256:08b826a9bf1265c76de04a42061d61ea6b109418b7826f28ff1ecdfaa26c5502 \
|
||||
--hash=sha256:0d1a9cf7bc6917538b20f8d06b9ab2147e542f68849e96fc58eb66bdf6acc692 \
|
||||
--hash=sha256:10b5019883c98f1dd819ca48ffc6f33a91cee04948fe637c605f4345c7cafd6f \
|
||||
--hash=sha256:12b0fa15879fe5a9d9eebe66e4e2d74128a773b1a4448010c9c714f45e04b9d8 \
|
||||
--hash=sha256:12fbb851cf323cc19aac3eea1df5ad17b57e91e9fe3cfd06100dba7bb8208c13 \
|
||||
--hash=sha256:149a1c323ba366f90b48e6f1a6db6582eb50512df374588de56fc909abc0f0f3 \
|
||||
--hash=sha256:19b66ca0a4d25cc0200b381ce824c7ea090db61427315e73cfb05dbf1b35c369 \
|
||||
--hash=sha256:1c774b9c0ba0d0b356f71530677b39028878a2cae5a93e0a13779cfd17120f88 \
|
||||
--hash=sha256:20722cd5375533ad754053363a80b8fb30c79d37930a6f7228030e237ce3bd5d \
|
||||
--hash=sha256:20822140c9a2ba9c5e42df342b0a892ab2e102fc0e3db967a133bb9ce3f898bb \
|
||||
--hash=sha256:21c32061a5512dc13f87cc7303e120e4d77c2f70df89a35af0e3ce246e5ac57f \
|
||||
--hash=sha256:2310e2adfc13c6d457d7d0f2ffdd5c56a74a317650cf765887df8d515a647ac0 \
|
||||
--hash=sha256:23edf4ec4b6f4f240e8df6e4985e9ee2ced86474632433e55fb1e2548744bf40 \
|
||||
--hash=sha256:2d50500a4a3bc6469adcdb319cf05d688b08ca3bf0f22a05339f3b25b433a599 \
|
||||
--hash=sha256:2e31c4e68cffd7b1f116127626813b82fcba19edf6b940a7b0c266d6484d0055 \
|
||||
--hash=sha256:34fb3db1149c879343861831728c243c432d4a5afc8f1878ca7612ef8de2a033 \
|
||||
--hash=sha256:37290fbef0c73e2d51d594eb78fded7dc7170d1c3ad0a890269e6fd8c8c4e061 \
|
||||
--hash=sha256:405be6058e206a86fedce2f715ecc2343f94072d7925251632dffa2c05f70dca \
|
||||
--hash=sha256:40a266371ece581e5de13b6635ef78d7487824af80561b6ca27694a88c19bc0f \
|
||||
--hash=sha256:42d63be3af4f9b951b199b0a9d23365d37ab14687e6d77b74940432c8515c4ca \
|
||||
--hash=sha256:44629d4498c9cb6b2051806155f22141df0d8a929c56134b166655232dfb2f8c \
|
||||
--hash=sha256:49c12af515073e9bf511e4ef736743bf70d531a643668722279314b937742ba4 \
|
||||
--hash=sha256:4a25756244bdcce3b50580baadf320fa48297f0eeb8e114ba64139a40d4d0fc8 \
|
||||
--hash=sha256:4bd024d567eca931b668978d672dba914d4b8e2628e2c3073a2ad178de8a2620 \
|
||||
--hash=sha256:4f8db54177035a2b5f717f94475b74907e12a96dc74f6d487f3966b0a4694071 \
|
||||
--hash=sha256:51ebb529fc5e8abdd55302f6c3f8943037348ec2384329a3e55677f69ae2fdfc \
|
||||
--hash=sha256:567f20f1c75897d7663830da6ea8af719e03d712b1d9ee7f813319f9ece42e5a \
|
||||
--hash=sha256:5933fcea5a5ba64c686f55c886a115cbfd92f2900460784a1e79909fdbafd7b6 \
|
||||
--hash=sha256:5bdb38ba220b61b4ec31dd1046dea6b016d3c6850a23f43ed8b58332b2fc668e \
|
||||
--hash=sha256:5f56499c1a74d2b862beb0c33b8016f99d095858455df9d21583bbbc1c15b582 \
|
||||
--hash=sha256:67871a13cf47275201553b536c025da777f997fa562a19eb798af4ad4b97c18f \
|
||||
--hash=sha256:67c8d44ad89fa7eb88de5d6ef6199b1e03dd24974f85a67639fc8badb801fe79 \
|
||||
--hash=sha256:6a0920cb55df5a4d3f6862964908078c0bd59332bdd1bcd20d14e8c70ef27cc5 \
|
||||
--hash=sha256:6bce6a29c3898191f4c9998e4d4e8f69790caeabde46e54da4bc235ce5bde683 \
|
||||
--hash=sha256:6f38f3f885a09cafc93fd667b1173a92f379e43785d635e7983c893f0da319fb \
|
||||
--hash=sha256:73ee25cf8cf8b75d5a5aeed7cb6588f5e5dbfbb0fde51707b630bbb23897645c \
|
||||
--hash=sha256:7b999816b5850a35ada08443e6e03945f1f6488144a83afe2d37b240a552aafa \
|
||||
--hash=sha256:7c88c10dd432f3b39ccdafc9ed81d0c21b8fd634502574da76d1bfa4fe2c76d0 \
|
||||
--hash=sha256:7d5e097eabd5d4915c27ac9f6e9325bb1e01a7c94d7348b5c4451d3fc30e8521 \
|
||||
--hash=sha256:7e91e97a929232cdb828889ee6ad0e48d7f40f4ec38818f4e4a8968b2b1af22e \
|
||||
--hash=sha256:7f6299e494e46253d40c34653cac369412f44ca53b5f85d848d3f95b1ed0546c \
|
||||
--hash=sha256:816752a5ef76a80484c8c441c85593b7ea9304f6231fc5776ad1fbff7e773058 \
|
||||
--hash=sha256:83b37abd87b590acd8f47ca8a61f70893322b11834d36e07c2298dacad4d14d2 \
|
||||
--hash=sha256:8619685cad8efc4c38c66d3b36aad854523297c43d748b3b6f0cc03c90ba3463 \
|
||||
--hash=sha256:8bf295fe459343bc6093c8e5e0df60bfa189e0fcb775a22e2c2488fdeccc6c0d \
|
||||
--hash=sha256:8e459b613cf31f8980f584387b4fe47bf08e076e288d61aa8eba1f7fd4ddbb81 \
|
||||
--hash=sha256:8f36aa77f74b14a2103622b196402c71330e4e7cf4122ee45c854e9a01e0eecf \
|
||||
--hash=sha256:93ff9c9c3663ce23aaa5d0b6b6abac55359e2a0c06c7e30f3771829af816be63 \
|
||||
--hash=sha256:9a635068d9793c7f0d929f39f18b58f1bd86c236e8e7b64167b86af9232ebca0 \
|
||||
--hash=sha256:9dda0788a9932776a75d8bcc020076edc308ce2508b51f6739a45e3158b3fc42 \
|
||||
--hash=sha256:a192360d512305fe92d3053e4f7627bbad1f7708f1f4ad38cccd9336acabe9ad \
|
||||
--hash=sha256:a2a14cd73d5e6c927f644b0110ee81f59c4ef506259ec9183904747f2caacc81 \
|
||||
--hash=sha256:a625df9a2a5597fa5e5266e01aefc82604bb85d291e3547981e863560d75da6c \
|
||||
--hash=sha256:a6aaa7871aebca081eb5c45f83e845bbd9712ae99fa9286dbfdcee835e63f4b4 \
|
||||
--hash=sha256:aa694c49787040943570d61c9b8fc01271bd2a2cfdd55f0d896f8aecdce1a981 \
|
||||
--hash=sha256:adb3c2124c68e480f4632d06cb7caa3b48a51678475f483b4edb1c6dee29ea43 \
|
||||
--hash=sha256:b84be41387fc00db28c13c02e30d42b02d8d8f6a4a741a1aee6012ca7f1f6039 \
|
||||
--hash=sha256:bf97ba1b5542050e9b0c74e632323b6d8136cc99d64e193abebee22fe6013c76 \
|
||||
--hash=sha256:c3bc8ee0271387e0b1e3ad0ff893645990a656e79bf9c42f4f734a3642b11d51 \
|
||||
--hash=sha256:c50c80e3591e5cf9a8dfa6007d4f10732f02e32263850999286e56ccd650cfb2 \
|
||||
--hash=sha256:c6fd031333dedcad7ce3e03d244093f43504f209e86925ebdb2b868fa4037630 \
|
||||
--hash=sha256:c87a04e7f152ee4db5dbe15f0bfa3fe628a1aeedbe66b81c43b87f52c813f9ac \
|
||||
--hash=sha256:cdcd1ba258178f7356d74170c9a81ba4eab6a5d55748bc402a5a2a6fe6be3510 \
|
||||
--hash=sha256:d4737f50d23ddd11d6685faacbb9252887dde0bc7997127757247983d74399d6 \
|
||||
--hash=sha256:d7710eb676e9bb68965cb045be0d333b4c0d7f9dfbaa7fbf121385b1588683d3 \
|
||||
--hash=sha256:d9b0a2bee3f3e03e9f29057aedb807dbf1e1d96ee1b9d0f422d9db6c8583271d \
|
||||
--hash=sha256:e65dd6e75de67b2362a4fa3e16aa627595f65054dc4ec73d64680c84d592fa61 \
|
||||
--hash=sha256:e892354a424b1e82a78ba16785822bdd40de06f19446a3d4a28047df1a4f8932 \
|
||||
--hash=sha256:e8ca8f69b7c77fa96dad99f8638c1fc4f1c0bed4acaa1baf7a3c31bdb80a0ab1 \
|
||||
--hash=sha256:e91c2b1cbeae768c98752e67e717e283d68dae45717b41f2d91eaee648e37b7d \
|
||||
--hash=sha256:e98b4f91f99b24b1da72e10621ba181f7281922384a7403094debb4199de6c00 \
|
||||
--hash=sha256:ef5fe6b7db3f501c56000ba8fe7c7e1a35ca1d45824fbeb95a67daa85cff4dbe \
|
||||
--hash=sha256:f11a3c1358bb3c68012a7b1f41b223c3db9f7bfde90b481df028cfe1c3363313 \
|
||||
--hash=sha256:f391dc92a015c478745192fe4f2e120c2af2aba18d9fe0616341cbf537599806 \
|
||||
--hash=sha256:f7cbb7a64e7ec664775195e4f81923bc8a93d9451b963f844e59118f63147a7a \
|
||||
--hash=sha256:f9bd7d260d986f3553518c5d723544346fa48031f8aef3265d786aeb59845bc0 \
|
||||
--hash=sha256:fc481f742ccda20e9ed760b8f978dff50f2a4e9bc253ac167fb0a05b0783ef52 \
|
||||
--hash=sha256:ff3fe9eb621fbb9db4c4be33ab946f6bac5f98ab50ca8d3260503653656c961b \
|
||||
--hash=sha256:ffea6b2986a797c84b6d1d27d4f43e0b83c73fc16281a930891cd237cf0d08fe
|
||||
# via -r requirements-dev.in
|
||||
pluggy==1.7.0 \
|
||||
--hash=sha256:7dd7b0d8832ba3cb632c306926ded123429211b83641b35dc5c41ad2d34f9bec \
|
||||
--hash=sha256:d1eaa46ebb595891b860ab086b4d09c8588af65ebd4361b8e8f4bb8920b90ba8
|
||||
# via
|
||||
# pytest
|
||||
# pytest-cov
|
||||
pygments==2.21.0 \
|
||||
--hash=sha256:2363c69b61c4a97c838da3b130dcd6468f4848992b21a82f2a63ec34377137d9 \
|
||||
--hash=sha256:610ca751c9bc2492b38eb9a38a7fbc93edbbb2d7182edaf34e66ae493dee5c8c
|
||||
# via pytest
|
||||
pytest==9.2.0 \
|
||||
--hash=sha256:07acdcf88ec174f907dc01af70bf52d49b014bbab03faeeade31c96b18c2e588 \
|
||||
--hash=sha256:97c4f3b1f3c7414aa36465e09b8220f1d03627993bd51b1282e193753c80557b
|
||||
# via
|
||||
# -r requirements-dev.in
|
||||
# pytest-cov
|
||||
pytest-cov==7.1.0 \
|
||||
--hash=sha256:30674f2b5f6351aa09702a9c8c364f6a01c27aae0c1366ae8016160d1efc56b2 \
|
||||
--hash=sha256:a0461110b7865f9a271aa1b51e516c9a95de9d696734a2f71e3e78f46e1d4678
|
||||
# via -r requirements-dev.in
|
||||
requests==2.34.2 \
|
||||
--hash=sha256:2a0d60c172f83ac6ab31e4554906c0f3b3588d37b5cb939b1c061f4907e278e0 \
|
||||
--hash=sha256:f288924cae4e29463698d6d60bc6a4da69c89185ad1e0bcc4104f584e960b9ed
|
||||
# via
|
||||
# -c requirements.txt
|
||||
# -r requirements.in
|
||||
ruff==0.17.5 \
|
||||
--hash=sha256:0e5c125c5b31dc8efc948d41357496a4c4a312977565ccba740030efdff83580 \
|
||||
--hash=sha256:40ca8afaac309b41a5b2e09e4e7beb1f824826b93c25697c4d74f573324fba4e \
|
||||
--hash=sha256:50dfc3c6b3ebd0a932f11dfd579bd42234b0b7137e68940eb6abdbfdb9d69697 \
|
||||
--hash=sha256:54c0f67d1be11b55d12c184a819fc229f5eee3ef45c16c4fcad41258e83b4882 \
|
||||
--hash=sha256:625e57d80cd43352d12ea81690f3eac46cddc8c0f35026d137fb0f157f94592e \
|
||||
--hash=sha256:64a6fd668a336df959c522991de33e9e3c8be463afc0c9ac8f029f9d19ef756e \
|
||||
--hash=sha256:6f0db748508f04a04e3fbebcc636a5c8b3bd76274f8ed28f497c44d75c2ea2d7 \
|
||||
--hash=sha256:6f6a7b138edf9cc402ca736a59d9525e6d766e5395760b72e7e146e6251ac963 \
|
||||
--hash=sha256:86bd1f3b83c25f9b8055c6e796f0685b39d3127ce947322098c3108cf82fd586 \
|
||||
--hash=sha256:8e85601bd6d9b6c3e3b95c0e0dccdbac1d23c6bcef006d187fbcddaf8225a5df \
|
||||
--hash=sha256:aa415d57c244299279901d776607fee3df7831c2a7435433fbfacde8632c6550 \
|
||||
--hash=sha256:b72fbc232e328bdbb9cdddf4f1aedcd61bd1aa64d75fc012114b4add0bd7f26b \
|
||||
--hash=sha256:d511dd302982e46a285528942fa6557d57730edc4bdb9def95e86a2603d77396 \
|
||||
--hash=sha256:dd0dfe7c6fe5a447fce467c58e69893be1d9a7e4378f5b9906432da33d94a97f \
|
||||
--hash=sha256:e1546609b2ad73f1d6c5c076881b788672b7b3cc3283981182cbdbb6524ed88a \
|
||||
--hash=sha256:e52622ecf3a0df9d03e796fe3eed4aa085adda65520db7e0619cbd2192a97342 \
|
||||
--hash=sha256:ec4ecf40fb4d6e1265b009dbe551727920926fc0f769070c452d6d84b422a74d \
|
||||
--hash=sha256:f93d2b7d449ed9545304f6923699ca20d13c675b69f258481709a08ae61076db
|
||||
# via -r requirements-dev.in
|
||||
soupsieve==4.1 \
|
||||
--hash=sha256:ca9abf7126667010d8f6e9b39bfc1bc3b23c8aed9bcb0f54a754dde969bb8aab \
|
||||
--hash=sha256:e4d667b3974ce6e038e7390486b8093369854a1d345ffdd4c121dfc4a782e809
|
||||
# via
|
||||
# -c requirements.txt
|
||||
# beautifulsoup4
|
||||
typing-extensions==4.16.0 \
|
||||
--hash=sha256:481caa481374e813c1b176ada14e97f1f67a4539ce9cfeb3f350d78d6370c2e8 \
|
||||
--hash=sha256:dc983d19a509c94dba722ee6abd33940f7c05a89e243c47e907eb4db6f1a43e5
|
||||
# via
|
||||
# -c requirements.txt
|
||||
# beautifulsoup4
|
||||
urllib3==2.8.0 \
|
||||
--hash=sha256:0cf3cae568d36aa9576b28dfb35f11328f1cb974ca7647d9475ebb86c75ac6e3 \
|
||||
--hash=sha256:63bf2ead4c879426ebf22ef2a781eeb4aa3b4ae798a0435506f8687fd5bb9b63
|
||||
# via
|
||||
# -c requirements.txt
|
||||
# -r requirements.in
|
||||
# requests
|
||||
vulture==2.16 \
|
||||
--hash=sha256:6e0f1c312cef1c87856957e5c2ca9608834a7c794c2180477f30bf0e4cc58eee \
|
||||
--hash=sha256:f8d9f6e2af03011664a3c6c240c9765b3f392917d3135fddca6d6a68d359f717
|
||||
# via -r requirements-dev.in
|
||||
@@ -0,0 +1,6 @@
|
||||
# Runtime dependencies of the data pipeline (scripts/). requirements.txt is the
|
||||
# hash-locked compile of this file; regenerate it after an edit (CLAUDE.md, gotcha 40):
|
||||
# pip-compile --generate-hashes --allow-unsafe --strip-extras requirements.in
|
||||
requests>=2.34.2,<3
|
||||
beautifulsoup4>=4.15.0,<5
|
||||
urllib3>=2.8.0,<3
|
||||
+210
-2
@@ -1,2 +1,210 @@
|
||||
requests>=2.34.2,<3
|
||||
beautifulsoup4>=4.15.0,<5
|
||||
#
|
||||
# This file is autogenerated by pip-compile with Python 3.14
|
||||
# by the following command:
|
||||
#
|
||||
# pip-compile --allow-unsafe --generate-hashes --strip-extras requirements.in
|
||||
#
|
||||
beautifulsoup4==4.15.0 \
|
||||
--hash=sha256:288e3ca7d54b06f2ac191970bc275c1939cb46d450b255bf6718b04aa37ab4f7 \
|
||||
--hash=sha256:d6f88de62e1d4e38ecb1077eb9724cd0eff29d2a08ca16a401e9b9e93f117cf9
|
||||
# via -r requirements.in
|
||||
certifi==2026.10.23 \
|
||||
--hash=sha256:a9895e6e2758b371e0545e321a3a8fd1fcfd9829ada8824a936dfb16aaaf36cd \
|
||||
--hash=sha256:e9b54de76e530bb6cf0ccd036787103acb58fd42ba930ea8bf948ddbaa2f61d1
|
||||
# via requests
|
||||
charset-normalizer==3.5.2 \
|
||||
--hash=sha256:01077390b03f7988f11d700a2194e69b119741a86b1a638b1db88891e3eced8e \
|
||||
--hash=sha256:01b0c0d2262a9e28e8484a278c7e1b5d650e3ac8cf2683d2967e25899f208bdf \
|
||||
--hash=sha256:04851f73ae72b8413dddadb16a49dfee95263553741fd42d546f7d66907e6be5 \
|
||||
--hash=sha256:0521c5665880b33d603717defa76c094048900010897909952397feb3039da56 \
|
||||
--hash=sha256:0774bf9bf620249fee3e0b8b9fd3065de213be30f3aa94ce2494b3b638949e26 \
|
||||
--hash=sha256:0891b9d3903c5571c03771ca669a4b0ec5618ca722a5c957d3d29cd4e5062848 \
|
||||
--hash=sha256:0c951d5e6dd9c2ff60609476752bee49da4206adde960ebc247766937f72e718 \
|
||||
--hash=sha256:0fed1d06615f022ee3b13caf5e8b180cfea32bb2c5aded8a9d44277afc040f93 \
|
||||
--hash=sha256:114e4d0c92d618409ed82a99e22b5c5e768fe995f2973f78265f4524f49d4640 \
|
||||
--hash=sha256:11912e4bb14baae7c5d8791aa55ba0a3a03ec6729073307b0f57270abaa713d3 \
|
||||
--hash=sha256:11a4d68a6ecda3292cb1e50239e111543ba5d709bb62a6b4ea1afcfa729d8875 \
|
||||
--hash=sha256:124fbf1a8ff966d87ae05bb8bd45a71f966055ed8bba320d0c7cf450bc5f4d0e \
|
||||
--hash=sha256:1461ac396c4fdb983a675f20aa555624f0ee18ac83d832b9244ffff3d8055275 \
|
||||
--hash=sha256:1503bccbeb36d5527790c3930327704c39af22de3112f1b1666a9f3ce15ee204 \
|
||||
--hash=sha256:15bb4005af6320d259dc7593ca84a38d7fe06a421dbcf7b910ae23979101e787 \
|
||||
--hash=sha256:15c44f7edfd477b06f517a5cc317fc1707edb9de2c865f43d4b6513907473234 \
|
||||
--hash=sha256:16fa0eccf81304b79c5cd87f9271c3b85dd9dd99245e4422ae9c0dd45e0f99d3 \
|
||||
--hash=sha256:183b88127acdb4fabe59d951ab424faf1af7b63cdbb5f776186c1ea2ffcaed98 \
|
||||
--hash=sha256:195c26fb65950f8fce54e26349852b7bdd7c5f120aeefbcc440b8a20faaed4a3 \
|
||||
--hash=sha256:1afb975bd5d68d5ce9f6b6d44fdf2f7e34b895a35e95708a7a91b20a3b51d187 \
|
||||
--hash=sha256:1b4cbc7c3491ccb4aa17fcd8165649d01cf39f76de1696da8631b5f71b85401d \
|
||||
--hash=sha256:1bc0baf5ef96b6ede57d47f4b8fe4d9d84019c3bfcbeb20a41edc6a6ee341f1f \
|
||||
--hash=sha256:1c50fe28bbc2ced33386f298650d91218076c05420e6cbd790b913adc41659e7 \
|
||||
--hash=sha256:1db38f4c5496827c1a501846d64d14c3b80c7e6714e406cd7dc36a9899fa1011 \
|
||||
--hash=sha256:211d5a3eb6af8f513b8d4ca19a8c1b7accab1b5f0d3175f9826b03c1a920dc1f \
|
||||
--hash=sha256:23851fb4e1b85ed3f6c2a27b777cdfe2e19fb5b38429a8faf38c7542b7665869 \
|
||||
--hash=sha256:254eb48b9fa5ee9898a3c445825a1f340fe53712a098904b39b0bddba8ea3cb1 \
|
||||
--hash=sha256:2625388c6c754520c37abaf3b41eb34d1cc4a373f457898f08606c8e362b891d \
|
||||
--hash=sha256:281cb91036248400f4cc957495cccd44c275c2e0c5854f7e45ac5cf7dc193847 \
|
||||
--hash=sha256:28a15fdad492a99b6eccfaaed66ef3f74050680545ea61ec8b2f4c538f1f1320 \
|
||||
--hash=sha256:28b4f0d66fb834ff90f28209ac7bce77868c45d8c93e26f906709d9b7c2e1af9 \
|
||||
--hash=sha256:2a925889534b3748302dae5dead07cc13480de1dac3aea80a941b729b471ef93 \
|
||||
--hash=sha256:2b7b3bbfb4fe8ef40600792d762fbaa9057559f9d3fad209525b7a22b99e91fd \
|
||||
--hash=sha256:2c9ad19a6cfcd5ea5c0d41161d22f9df1dcc277e9bef2751391334546a314c00 \
|
||||
--hash=sha256:2cc961b171b3f3440f410489ab3573e86aea8736134ebbb40ea1338b7f0831bc \
|
||||
--hash=sha256:2ce45c6627b22c47e390bc91a41c3d13032192e699fa0bea96e9671b373d69b0 \
|
||||
--hash=sha256:2e06a3a98f916dd41d27f3105e02e7a40181c98c94b9158733d03a6f80506c09 \
|
||||
--hash=sha256:304d5463e65a35d7bb0850550e0780395395f6fcf452f04db7d5ca7cecc425ac \
|
||||
--hash=sha256:304d8e4d493af723536393eee0c689eb7813f4a474c8b479dee63f1fdd98f621 \
|
||||
--hash=sha256:30fcd120b732aa79317f08dee04d7de0847822e4cf7ee0e9f445bb958832252c \
|
||||
--hash=sha256:31f3930700408d211f13378ccbe1c40845d8da54bd0681fac3a9b5aae81c7aa8 \
|
||||
--hash=sha256:34276fd796040bf0993ab33a369aa572e6979c7aab225a88893667ad8eac8f7a \
|
||||
--hash=sha256:355ad8011081dec5412240c087a9a0c9d4d5039f3ed11a3f13e18c2b29b56c51 \
|
||||
--hash=sha256:38a873987f3be698494da8b2e3085e29da02da7b633dce73e79c699a113d7bf0 \
|
||||
--hash=sha256:39de2a259fc954455c57274dc94c79d5842774e1247a016aff30bc0efed0f4ef \
|
||||
--hash=sha256:3d14b50de6bf4d0edf857a9386836846f982b8f524e188e2e68b96d702bcf4aa \
|
||||
--hash=sha256:3d21b8b13c7592db2ac5e544a6d83187b995257472b0c9e8351b6d507ae37ed6 \
|
||||
--hash=sha256:3d31298449090ab8d47b7b1b2a555ff73cac7ed438a08b7ac160980c7ebed649 \
|
||||
--hash=sha256:3ddacd27458c45bdacd6bd6db644bfb730efbf9e830310186e3045c9c5be8fb2 \
|
||||
--hash=sha256:3df041de8887954562c9b261cba85ca0e9ded74048daf125f45edcfaa4832229 \
|
||||
--hash=sha256:40ab6bffa02ae10a0581e6c198be7d2d8ca5c2a0c64e4ed3465d766df457573e \
|
||||
--hash=sha256:4275811936e2f06feff5e598fb42a1b7ae852da8e39605211892b56b81a34efd \
|
||||
--hash=sha256:443eae2bf318abeaf6f15d785138f71fd6de770e99a92158b8b814265e079115 \
|
||||
--hash=sha256:447441e76ec720b15e64418d32e092297340387053047c7c694f579efb0ee1d9 \
|
||||
--hash=sha256:4495c5002a7b28557e7e222e77e0b661183e432b7d6d2e788101e3f240e05b8c \
|
||||
--hash=sha256:44bd4fbb29dfbeba60e7d2bd000c59e4b21ddb3cc53912b14048d37092706d7c \
|
||||
--hash=sha256:4685902cf26edf013ed7a3da0f426ebba7a00ebb9541386d835afbf002c11cab \
|
||||
--hash=sha256:498dc3188ca05a68231ac3fdbfc7f57eb67e1343c30e0fea17f8218c1599b253 \
|
||||
--hash=sha256:4c2b5031f63e331e3839b40aed2dd6f191e9c07edbde303e7876846ea1946995 \
|
||||
--hash=sha256:4d48f2d08b9de5864e2c8744d4461b862fb149a18274abc8b698c45975573438 \
|
||||
--hash=sha256:4f87960d57feabfb618e4e0af6e7371645fa26a277860739d6e5d6e0012c92f0 \
|
||||
--hash=sha256:50e3adfb96fc189eb27b1cf62d3b598b89b4bb0420d93a3d3e42e137409011be \
|
||||
--hash=sha256:51cf45226a9b588d0d2b4880c62d686934b63ab0bd79ca23ab0e9762eb27441b \
|
||||
--hash=sha256:52aa6992700996af31f375de0c6bacd402b0097fe40b53c426b9f51a90ebabc7 \
|
||||
--hash=sha256:55ea99acb17b9325618de155a0cd6a2e8f5d10be008113e1d433bbb58db543b2 \
|
||||
--hash=sha256:56bc200a365efb37383b7852e4cc5898d3b2da5987289b543956cf8cad71018a \
|
||||
--hash=sha256:588461c2e8384d309bd63e5826019b6977bc66d629b99ac8737bb795d7b2cb5a \
|
||||
--hash=sha256:58ca3755ee7ff7f59b57789ec9833c9de9ea275405cdd240eda1f193112e398a \
|
||||
--hash=sha256:58f361dcbab699cf8f42db3f47c8e7fd1036f138c23a5d08de9fde5f425a730c \
|
||||
--hash=sha256:598a11a2c7ebaa5334bf698bf29568c9c390abac6a154d8170fedecd1cea38c5 \
|
||||
--hash=sha256:59f63901b0031c3136cf64704dcb21de0bbae62ce2c9529bc39d27665463de37 \
|
||||
--hash=sha256:5cde776b7cc66e4f6c99612cea4aa7269aa65863f7a15841b2c264f103822f4e \
|
||||
--hash=sha256:5e2b6b57e9733d39f0c9fd3185efa6b8e29652c4cd8fe94180272cf6ed9a78c4 \
|
||||
--hash=sha256:5fb29fb8cd1a46c27a1bf9613ad5ec2599310d46b4025d9556404a6b6a292800 \
|
||||
--hash=sha256:6045373d5a89a5ec71afde535db987ca28e76dfa276c2d4c818265b375d4b055 \
|
||||
--hash=sha256:619799369eeef6366ed3e8755a5670f4f2f0fb6b30a0fd7264dc0fdc2357058e \
|
||||
--hash=sha256:62588a277bfb59def052abd940703fa35107152bf479781a878617d60faf8fb5 \
|
||||
--hash=sha256:62603db9a7caa0802eaa28c1c46fecd7b3a263a774069c24c3c28c302448721c \
|
||||
--hash=sha256:65cd72beeeca9d3aaea1201e5923859f308f952f9c71de93f06063c79f0f7a3b \
|
||||
--hash=sha256:68eb192d85ab8e5f6ec69c2bc6ac0179fbf04a5ac1569d12fbef74883fe102d0 \
|
||||
--hash=sha256:6bd128f206a7752ae1f2ab6c61bf8a24ba28913a10df8b14c2637b973ff97a80 \
|
||||
--hash=sha256:6be488a102b8cf28d0391d8c4ba7748938ae28b78ad901f8585520fca33ead1a \
|
||||
--hash=sha256:7218e8f32b0956cfcd048fd42d9d5779809745ca1d86113ca56f66e7ae1549c4 \
|
||||
--hash=sha256:7441d755b7ab94f8d4eb3e43ec05482d760842fd263d003a99102d742cd835e2 \
|
||||
--hash=sha256:749e97e1b32313717a565abbe321bc2190bc8b35f1a67e4cdbc7c56c8d8ffe58 \
|
||||
--hash=sha256:75a3ceed0724d625d64b86ca20aba182e4df462e04c2414fc941c0f523f06aac \
|
||||
--hash=sha256:780fbe7cab297b81dad9fb8dc5eb003c0468ffb0d9e5f65068c53a34661a96bc \
|
||||
--hash=sha256:78456a747de8dc58360ffa581f30a002baf5aa28cb262536545e91f113ed7639 \
|
||||
--hash=sha256:7967d08cf06dee78443b874f98c98036f624f3a4e73e11f9f64f5be4d25393cf \
|
||||
--hash=sha256:7a881931aa470808df94a8c380eed2bbbc76cd9dc622310f99665658c821eb6d \
|
||||
--hash=sha256:7dcd882da75ef9adf94903b1e3b9419e8aa8fb4c7396822b834b9ef7fb96954f \
|
||||
--hash=sha256:7e841fb9010836c992c9f12fcbd43a831de93a5f726fc1ccd8ca1d0268c5014c \
|
||||
--hash=sha256:7fdde2c9fd9e3eca40631e024664cf2584272cc8f96308cbe5fdfc930f51d8bc \
|
||||
--hash=sha256:8024d00c3faf3fc0c16e07a69f4405e8eac7cc0ab15f65fe6cf43827c4cf72b4 \
|
||||
--hash=sha256:80d02b6f04e92601a081dd97b23d3128033098bff5d35d392ddcc0476ea11253 \
|
||||
--hash=sha256:838dcc90063569a0448120554591a1d6c4a4ffe11babf048908793154ab86ade \
|
||||
--hash=sha256:849df64e889b2e17230d58410a03dba311a65b163508fd33679b2b737d4b7858 \
|
||||
--hash=sha256:87475fabc8d9996fd9c27debb395e642e8c838d78a00b6e932227a0e06b81e26 \
|
||||
--hash=sha256:87e50a3e7cb90af586b6c5faf23e302a970415ac73bd7bd90a515a04b427ef96 \
|
||||
--hash=sha256:89b53f3cda69831909888e0494f4fa0bcd3537e3e138dabeb620bd6ad946bae8 \
|
||||
--hash=sha256:8a893cc101149f80a653f82062ebc95b34525a2614382e1da5458fe7c6997249 \
|
||||
--hash=sha256:8b2bfab86aa71ae13aa41a6a26aab338e0db2b8bc75434b05aea89e011ff35a4 \
|
||||
--hash=sha256:8d86d6fc60743dc916eb79e2eb1ec4818e21e427731543af40a3021851174a13 \
|
||||
--hash=sha256:915563965d418f986e7e145accc592eae9e1a1be3566ff98a05d7a9ec42a76e1 \
|
||||
--hash=sha256:92888bb3187c5ba50500b00b3b310c9f2c651709d28036077680cb5255450a03 \
|
||||
--hash=sha256:93223adc95033dd47133a46ccfc316a0139176fd79085762e27202ec56018f03 \
|
||||
--hash=sha256:9373ad13ef0d2c0fb761e04e55bfdee5a08b52cef2c882c8fbe9935b1517152e \
|
||||
--hash=sha256:9409a8bf35cf78353942504b24a57de3d75b708997a1e4bd8db71ac8633ce364 \
|
||||
--hash=sha256:9b7f416ff0978e2f2249330527f0ad6fa02f4932e6199692d3b52da2048c19e4 \
|
||||
--hash=sha256:9bde855991b7e362c146535e3136a50bfaffc0487d38b33ca7e5edefc6e23849 \
|
||||
--hash=sha256:9cae88599c7219005d879f98e5ed53341e9a122af585e1091200358a3003d2a0 \
|
||||
--hash=sha256:9cf9b1a857e25c4baceeb3624e92a56df3668f398c4acba74e174d81fb4d1d3a \
|
||||
--hash=sha256:9f56f72050826f63dcee7a7f55b0a77168cb3bfc553fd405e7f8f9ece75a4036 \
|
||||
--hash=sha256:a090bb2c68df85450502e3e20d665e3a5af9c65a84d6508ed477badd49166fd3 \
|
||||
--hash=sha256:a192e2c40070d92c3ccf777e3a5c4ff515573cd2bb7ed0c537fdadbbec5bbf21 \
|
||||
--hash=sha256:a19a731138fc27d5682277d3b9df22855cea1239bce7fcec5f78f42ef2d1f3c3 \
|
||||
--hash=sha256:a66c3bc5ab1f0ff2164fc9965ddd611ff0802173f4b9d24554c563f6ab7e1d6e \
|
||||
--hash=sha256:a815775b6c38d4e0ff7bcffbeba67feded90202bb6a226b8dd35f1c855217413 \
|
||||
--hash=sha256:a89012d6d5476ee112d20d998570ed58df2260a852afb1758809cd6900411d21 \
|
||||
--hash=sha256:ae4f5fea5b8b8ccff88238cc8569303e5ee95efae67fa62922a311397a71f346 \
|
||||
--hash=sha256:b6856554c4f44d79fc2307d5768854310a8f0096e501c75637542c82292b0429 \
|
||||
--hash=sha256:b6b751274acb69d77b3323d6b7dbaa3c7fdfc1eb829b7eb61d262f32e1af9685 \
|
||||
--hash=sha256:b736353c0a625bbd5fcec108576e2385db3496f4f771f785ff32e108d3c3bc45 \
|
||||
--hash=sha256:b7fd005a73d9e657273b7a10dc71a9e03c8fb9ee6999798d6918ce095b81ac7f \
|
||||
--hash=sha256:b91363207bd9dc966a691e959bb47f64b30f7ac4b072be9968b366982f7db77c \
|
||||
--hash=sha256:ba0b1d2620edf869789c3879223f52bf2afc5d31b3cb47cc57b3a12c05e2aa9d \
|
||||
--hash=sha256:bbbfc8e28816f19d7c0f1816664980c0a9875d01b27cdf8eedddb639d9e108ad \
|
||||
--hash=sha256:bd16aabe4a02a297c23417aa17ac6299dbd8c49f673bcd645b4929b11f5a4400 \
|
||||
--hash=sha256:c0afc6800ba57ccc350374c5bd6150419915d95ce93cdbab2d783d75eaf30ecb \
|
||||
--hash=sha256:c6708715abcf3c73b99508253e961a9967f02fe536532834149574eda6de0d1c \
|
||||
--hash=sha256:c7c9ab723cde841fefb34efbad91e87f00a674b1fe1cd0784fde742bf2c154dc \
|
||||
--hash=sha256:c8f3d67aeaf55f017982b73683f0e7342ba2f6635a78f69ce89ebb26aa411e5c \
|
||||
--hash=sha256:c9790464842f85f437dbbb54417eda1e0e6bfc52dd8d22d6fd1c994b73b2dc74 \
|
||||
--hash=sha256:ca403d7e4798f525fdfc78e258820419cbbd0f0ecbab9de7840e3c017cf6b8cf \
|
||||
--hash=sha256:d008d90a7f2471519aef0c90dfbe73b3e6e4d5e66ac48e19154c17e89e98b604 \
|
||||
--hash=sha256:d19fbd981a488e22cd04883659ca6b08f50b5974f9fd7c95655ef6a043e5893f \
|
||||
--hash=sha256:d1befeed746d247c81127bb14de9dc3d30edb6e5976d34f83f86ed262b1d9105 \
|
||||
--hash=sha256:d2374b62878abb00cd8309b32af6c0b715cd02dec0ca74ef12e5069bdc64144a \
|
||||
--hash=sha256:d376bbd28b3a8999db1a103b3b388aee6f1ddeb3e51bc2172993efdcd86e064d \
|
||||
--hash=sha256:d4a7319f304a774bed22115bc891618e45f85065ab44ea6acd07d274e750519a \
|
||||
--hash=sha256:d6734d2ef8a50fbf8445c139477da401f50d62a0606bf00e20ec6d87773fefb1 \
|
||||
--hash=sha256:d760fe2a4d7c3b226cb9026d6a842868d52a7901bd98420e1baf14e80da85cf5 \
|
||||
--hash=sha256:d913de495d90407cd859d263bee2e5d1a4ed3eb6573c04e70d9ec619a7cbed7f \
|
||||
--hash=sha256:db19d07e2e0129e974a0e65d0064fc222a446cd5122c2fd4184d2af9fc734a9e \
|
||||
--hash=sha256:dca9ab98072a5a54ebacebdc45f53e645336b320c667410b061be1ca588ae709 \
|
||||
--hash=sha256:ddc7dacc8ece3a182e7f15cb862d1fd616b46d076cb1ae9dd232b2c38b655874 \
|
||||
--hash=sha256:ddf19c062bea7a0cc80f519243d2c01dd091be0cf952a0750d4ad576709559f5 \
|
||||
--hash=sha256:def79fa35ef0cef8d2accec024f4fdc7ead3012ff02f5215c783f39f03ef8cfc \
|
||||
--hash=sha256:df29a0a7107f7011e77f4eebdddec4c7331e24d787a0b21a46d63bdf7445da95 \
|
||||
--hash=sha256:e09a3942ecbdee5cce73ea9d42da82b81b72ac1bf031ce069b93b5adf4eac8cd \
|
||||
--hash=sha256:e242bb1c5e76e97dfa9e7f209a71e93a01d7f19ffdd5cfbb2e2d55b4f08f8ab0 \
|
||||
--hash=sha256:e243bd13217235fc7290c621941c3f5cc8b66e4872495be821d7436ba2fb838d \
|
||||
--hash=sha256:e2af3aad578aa6bd1384bcf4750fc285e5a9de53f40b7d41e5a0bf748edeb2b3 \
|
||||
--hash=sha256:e4e81e09c1578b8df602e3db08b0b3ea0a6947ad612f52bf8dc5ea8d47691f0c \
|
||||
--hash=sha256:e54da4baf05720032d527874d40b65fa4d7e5c6c6a43d0c3adbeffcaf275a2b3 \
|
||||
--hash=sha256:e80e6c2f55656b4824d72065abb4ddd6a525c74bd78a0aab5d9fc2cf4fb5af50 \
|
||||
--hash=sha256:ed2a239c0ea213acc1908150a3037257083c7c083128f1a4cec2ec4b97dca491 \
|
||||
--hash=sha256:ed905975ab14056a2e5eb1c376cb2e1ebc5396baf84163939c518556fccde9f5 \
|
||||
--hash=sha256:ee21e28f0430bd6dc9086c6e525d5e818a44a5ad19720c8a0ef766792f3eb5e5 \
|
||||
--hash=sha256:ee43c17b173d46a3212baa6ead3ae258eeabdae48c263a01ccf0218c366dd655 \
|
||||
--hash=sha256:ef4fcbf3327382cd4c9f540babd61248208af7b93eec4de397b4d5f58a09e288 \
|
||||
--hash=sha256:eff0ac9dbe711a4aee69bf04a83896aa9b85f19641264053a9f6d48573abb7dd \
|
||||
--hash=sha256:f0aa869112ef88429ae17820d99c3dd9504c9e9c671d3c246f3d7442cb051084 \
|
||||
--hash=sha256:f3c96f633825733f735c5a9cf21d21a257d8e1edf0b1cee0a064b9c424ca0f7d \
|
||||
--hash=sha256:f5833ad231be5eb6553de524a70f48d71b2c8563101750531e0b80184e175cd4 \
|
||||
--hash=sha256:f5ec61164adcec446f8969a3358ec3f9b26bbda3b9213e5586d219afa8df2915 \
|
||||
--hash=sha256:f7d486c83842422badd511868fd8a9a20e9407ace71564b6af47ce7e60a336c1 \
|
||||
--hash=sha256:fb9e68df06293761f9fe66ade60a9bc6d0f5e42b8acf2939a9158af86ab0e5bd \
|
||||
--hash=sha256:fc14a032f813bf5fe624d991960ea83e9715adc27e4c1830a2361eb1d02ac341 \
|
||||
--hash=sha256:fcff63213e8e6e47770541a4607175404f47cbb3ebea7b6058cc82d524a0e424 \
|
||||
--hash=sha256:fd1fbe0f116b6e55da77aca2c6ddcddcfac2186cbf78bdebf40fc156efca389d \
|
||||
--hash=sha256:fe9753dfee015c570d73df76f899f18444d41388bffcde097deba51c4fadbb9f
|
||||
# via requests
|
||||
idna==3.20 \
|
||||
--hash=sha256:a7db850025b95ded1eae8a46181a1a6c56c92c96f0e2b005d9ff8dc0210cab44 \
|
||||
--hash=sha256:ab7ae7122974553370f0bdb919e1a960b2cd1bc1ef0276416d896db81c14582c
|
||||
# via requests
|
||||
requests==2.34.2 \
|
||||
--hash=sha256:2a0d60c172f83ac6ab31e4554906c0f3b3588d37b5cb939b1c061f4907e278e0 \
|
||||
--hash=sha256:f288924cae4e29463698d6d60bc6a4da69c89185ad1e0bcc4104f584e960b9ed
|
||||
# via -r requirements.in
|
||||
soupsieve==4.1 \
|
||||
--hash=sha256:ca9abf7126667010d8f6e9b39bfc1bc3b23c8aed9bcb0f54a754dde969bb8aab \
|
||||
--hash=sha256:e4d667b3974ce6e038e7390486b8093369854a1d345ffdd4c121dfc4a782e809
|
||||
# via beautifulsoup4
|
||||
typing-extensions==4.16.0 \
|
||||
--hash=sha256:481caa481374e813c1b176ada14e97f1f67a4539ce9cfeb3f350d78d6370c2e8 \
|
||||
--hash=sha256:dc983d19a509c94dba722ee6abd33940f7c05a89e243c47e907eb4db6f1a43e5
|
||||
# via beautifulsoup4
|
||||
urllib3==2.8.0 \
|
||||
--hash=sha256:0cf3cae568d36aa9576b28dfb35f11328f1cb974ca7647d9475ebb86c75ac6e3 \
|
||||
--hash=sha256:63bf2ead4c879426ebf22ef2a781eeb4aa3b4ae798a0435506f8687fd5bb9b63
|
||||
# via
|
||||
# -r requirements.in
|
||||
# requests
|
||||
@@ -12,6 +12,9 @@ always works on the latest data. Idempotent: applying the same patch twice
|
||||
- *_state: merged into scripts/state/*.json (null drops an entry); for
|
||||
refresh_state the newer `checked` wins and the newest `full`
|
||||
stamp from either side is kept
|
||||
- ingest_outcomes: merged into scripts/state/ingest_outcomes.json (the newer
|
||||
`at` wins; entries more than 90 days older than the newest one,
|
||||
and all but the newest 5,000, are dropped)
|
||||
- unlog / unblock_remove: an unblocked (restored) game that was re-added
|
||||
leaves the deleted log and scripts/state/unblocked.json; one whose
|
||||
ingest ended otherwise leaves only the allow-list
|
||||
@@ -32,6 +35,7 @@ Usage: python scripts/apply_patch.py PATCH.json
|
||||
import math
|
||||
import os
|
||||
import sys
|
||||
from datetime import datetime, timedelta
|
||||
|
||||
sys.path.insert(0, os.path.dirname(__file__))
|
||||
from canonical import canonicalize
|
||||
@@ -46,9 +50,12 @@ DELETED_LOG = "scripts/deleted_games.json"
|
||||
TEMP_LINK = "scripts/temp_link.json"
|
||||
REFRESH_STATE = "scripts/state/refresh_state.json"
|
||||
INGEST_STATE = "scripts/state/ingest_state.json"
|
||||
INGEST_OUTCOMES = "scripts/state/ingest_outcomes.json"
|
||||
UNBLOCKED = "scripts/state/unblocked.json"
|
||||
MASS_REMOVAL_FLOOR = 25
|
||||
MASS_REMOVAL_SHARE = 0.05
|
||||
OUTCOMES_DAYS = 90
|
||||
OUTCOMES_KEEP = 5000
|
||||
|
||||
|
||||
def mass_removal_limit(patch: dict, total: int) -> int:
|
||||
@@ -59,6 +66,31 @@ def mass_removal_limit(patch: dict, total: int) -> int:
|
||||
return limit
|
||||
|
||||
|
||||
def merge_outcomes(current: dict, delta: dict) -> dict:
|
||||
"""ingest_outcomes.json after a patch: per URL the newer `at` wins.
|
||||
|
||||
Pruned relative to the newest entry, not the clock, so applying the same
|
||||
patch twice gives the same file.
|
||||
"""
|
||||
merged = {
|
||||
url: e for url, e in current.items() if isinstance(e, dict) and isinstance(e.get("at"), str)
|
||||
}
|
||||
for url, entry in delta.items():
|
||||
if not isinstance(entry, dict) or not isinstance(entry.get("at"), str):
|
||||
continue
|
||||
old = merged.get(url)
|
||||
if old is None or entry["at"] >= old["at"]:
|
||||
merged[url] = entry
|
||||
if not merged:
|
||||
return {}
|
||||
newest = datetime.fromisoformat(max(e["at"] for e in merged.values()).replace("Z", "+00:00"))
|
||||
cutoff = (newest - timedelta(days=OUTCOMES_DAYS)).strftime("%Y-%m-%dT%H:%M:%SZ")
|
||||
recent = sorted(
|
||||
((e["at"], url) for url, e in merged.items() if e["at"] >= cutoff), reverse=True
|
||||
)[:OUTCOMES_KEEP]
|
||||
return {url: merged[url] for _, url in recent}
|
||||
|
||||
|
||||
def _queue_key(url: str) -> str:
|
||||
return canonicalize(url) or url
|
||||
|
||||
@@ -161,6 +193,11 @@ def apply(patch: dict) -> dict:
|
||||
state = {u: e for u, e in state.items() if u in live_urls}
|
||||
save_state_map(path, state)
|
||||
|
||||
outcomes = patch.get("ingest_outcomes", {})
|
||||
if outcomes:
|
||||
current = load_json(INGEST_OUTCOMES, default={})
|
||||
save_state_map(INGEST_OUTCOMES, merge_outcomes(current, outcomes))
|
||||
|
||||
unlog = {u for u in patch.get("unlog", []) if isinstance(u, str)}
|
||||
finished = unlog | {u for u in patch.get("unblock_remove", []) if isinstance(u, str)}
|
||||
if unlog:
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
"""
|
||||
canonical.py — One canonical form for itch.io game URLs.
|
||||
|
||||
Every ingest channel (extension, admin, Suggest form, RSS, workflow input) and
|
||||
Every ingest channel (admin, Suggest form, RSS, collections, workflow input) and
|
||||
the pipeline itself compare URLs through canonicalize(), so the same game can
|
||||
never be queued twice under two spellings. The Worker ports this function; both
|
||||
implementations are tested against tests/fixtures/url_vectors.json.
|
||||
|
||||
@@ -664,5 +664,467 @@
|
||||
"name": "SWALLOWED",
|
||||
"reason": "Game page no longer exists (HTTP 404)",
|
||||
"deleted_at": "2026-10-09T03:01:17Z"
|
||||
},
|
||||
{
|
||||
"url": "https://v0id2.itch.io/burrow",
|
||||
"name": "Burrow",
|
||||
"reason": "Game page no longer exists (HTTP 404)",
|
||||
"deleted_at": "2026-10-11T03:02:17Z"
|
||||
},
|
||||
{
|
||||
"url": "https://wolf-hal.itch.io/sprunki",
|
||||
"name": "Sprunki",
|
||||
"reason": "Game page no longer exists (HTTP 404)",
|
||||
"deleted_at": "2026-10-11T03:02:19Z"
|
||||
},
|
||||
{
|
||||
"url": "https://sekarsarasu1981.itch.io/my-raising-diary",
|
||||
"name": "My Raising Diary",
|
||||
"reason": "Game page no longer exists (HTTP 404)",
|
||||
"deleted_at": "2026-10-11T03:02:23Z"
|
||||
},
|
||||
{
|
||||
"url": "https://sreejithnm78.itch.io/unquiet-grey",
|
||||
"name": "Unquiet Grey",
|
||||
"reason": "Game page no longer exists (HTTP 404)",
|
||||
"deleted_at": "2026-10-11T03:02:27Z"
|
||||
},
|
||||
{
|
||||
"url": "https://elinzeiart-z.itch.io/salvation-of-the-righteous",
|
||||
"name": "Salvation of the Righteous",
|
||||
"reason": "Game page no longer exists (HTTP 404)",
|
||||
"deleted_at": "2026-10-11T03:02:31Z"
|
||||
},
|
||||
{
|
||||
"url": "https://esgeetha5.itch.io/enter-furry-world",
|
||||
"name": "Enter Furry World",
|
||||
"reason": "Game page no longer exists (HTTP 404)",
|
||||
"deleted_at": "2026-10-11T03:02:34Z"
|
||||
},
|
||||
{
|
||||
"url": "https://kanagarajv021.itch.io/endless-labyrinth-of-night-roads",
|
||||
"name": "Endless Labyrinth of Night Roads",
|
||||
"reason": "Game page no longer exists (HTTP 404)",
|
||||
"deleted_at": "2026-10-11T03:02:38Z"
|
||||
},
|
||||
{
|
||||
"url": "https://coren-baili.itch.io/six-rules-the-visual-novel",
|
||||
"name": "Six Rules: The Visual Novel",
|
||||
"reason": "Game page no longer exists (HTTP 404)",
|
||||
"deleted_at": "2026-10-11T03:02:40Z"
|
||||
},
|
||||
{
|
||||
"url": "https://everium.itch.io/underthethorns",
|
||||
"name": "Under the Thorns",
|
||||
"reason": "Game page is password-protected",
|
||||
"deleted_at": "2026-10-12T03:08:14Z"
|
||||
},
|
||||
{
|
||||
"url": "https://ronhelleredfn-boop.itch.io/bb-blackwood",
|
||||
"name": "B&B Blackwood",
|
||||
"reason": "Game page no longer exists (HTTP 404)",
|
||||
"deleted_at": "2026-10-12T03:08:17Z"
|
||||
},
|
||||
{
|
||||
"url": "https://toro-comicss.itch.io/emergency-monster-team-chapter-0",
|
||||
"name": "EMERGENCY! Monster Team Chapter 0",
|
||||
"reason": "Game page no longer exists (HTTP 404)",
|
||||
"deleted_at": "2026-10-12T03:08:20Z"
|
||||
},
|
||||
{
|
||||
"url": "https://life-crises.itch.io/your-redacted-boyfriend",
|
||||
"name": "your [REDACTED] boyfriend",
|
||||
"reason": "Game page no longer exists (HTTP 404)",
|
||||
"deleted_at": "2026-10-12T03:08:22Z"
|
||||
},
|
||||
{
|
||||
"url": "https://antoine-aubin.itch.io/a-wave-that-i-a-furry-visual-novel",
|
||||
"name": "A wave that I . . . ( A furry visual novel)",
|
||||
"reason": "Game page no longer exists (HTTP 404)",
|
||||
"deleted_at": "2026-10-12T03:08:25Z"
|
||||
},
|
||||
{
|
||||
"url": "https://imrank-seo.itch.io/stranded-with-you",
|
||||
"name": "Stranded with You",
|
||||
"reason": "Game page no longer exists (HTTP 404)",
|
||||
"deleted_at": "2026-10-12T03:08:28Z"
|
||||
},
|
||||
{
|
||||
"url": "https://akaerocore.itch.io/raising-a-happy-neet",
|
||||
"name": "Raising a Happy NEET",
|
||||
"reason": "Game page no longer exists (HTTP 404)",
|
||||
"deleted_at": "2026-10-12T03:08:31Z"
|
||||
},
|
||||
{
|
||||
"url": "https://chandhira2604.itch.io/sun-stars",
|
||||
"name": "Sun & Stars",
|
||||
"reason": "Game page no longer exists (HTTP 404)",
|
||||
"deleted_at": "2026-10-18T02:53:39Z"
|
||||
},
|
||||
{
|
||||
"url": "https://ronnafemto.itch.io/recipe-frenzy",
|
||||
"name": "Recipe Frenzy",
|
||||
"reason": "Game became paid",
|
||||
"deleted_at": "2026-10-18T02:53:43Z"
|
||||
},
|
||||
{
|
||||
"url": "https://bluedragondreaming.itch.io/elemental-harmony",
|
||||
"name": "Elemental Harmony",
|
||||
"reason": "Game became paid",
|
||||
"deleted_at": "2026-10-19T02:57:14Z"
|
||||
},
|
||||
{
|
||||
"url": "https://writer31.itch.io/say-youll-forgive-me",
|
||||
"name": "Say You'll Forgive Me",
|
||||
"reason": "Game page no longer exists (HTTP 404)",
|
||||
"deleted_at": "2026-10-19T02:57:18Z"
|
||||
},
|
||||
{
|
||||
"url": "https://lguidolin.itch.io/one-more-saturday",
|
||||
"name": "One More Saturday",
|
||||
"reason": "Game became paid",
|
||||
"deleted_at": "2026-10-19T02:57:22Z"
|
||||
},
|
||||
{
|
||||
"url": "https://meta-and-flash.itch.io/flash-taggers",
|
||||
"name": "🪵Twig Tagg🪵",
|
||||
"reason": "Game page no longer exists (HTTP 404)",
|
||||
"deleted_at": "2026-10-20T02:55:15Z"
|
||||
},
|
||||
{
|
||||
"url": "https://baldigaming99.itch.io/geometry-dash-220922091-apkandpc",
|
||||
"name": "Geometry Dash 2.209/2.2091 (APK and PC).",
|
||||
"reason": "Game page no longer exists (HTTP 404)",
|
||||
"deleted_at": "2026-10-21T02:55:57Z"
|
||||
},
|
||||
{
|
||||
"url": "https://teo-tormo.itch.io/sf2cengcd",
|
||||
"name": "Street Fighter II Champion Edition for Neo Geo CD",
|
||||
"reason": "Game page no longer exists (HTTP 404)",
|
||||
"deleted_at": "2026-10-22T02:56:06Z"
|
||||
},
|
||||
{
|
||||
"url": "https://twindark.itch.io/godseater",
|
||||
"name": "GodsEater",
|
||||
"reason": "Game became paid",
|
||||
"deleted_at": "2026-10-22T02:56:10Z"
|
||||
},
|
||||
{
|
||||
"url": "https://m0dgames.itch.io/granny-remake-free-pc-android",
|
||||
"name": "Granny Remake Free",
|
||||
"reason": "Game page no longer exists (HTTP 404)",
|
||||
"deleted_at": "2026-10-24T02:54:26Z"
|
||||
},
|
||||
{
|
||||
"url": "https://ethane1.itch.io/home-watcher",
|
||||
"name": "Home Watcher",
|
||||
"reason": "Game became paid",
|
||||
"deleted_at": "2026-10-24T02:54:30Z"
|
||||
},
|
||||
{
|
||||
"url": "https://ethane1.itch.io/warehouse",
|
||||
"name": "Warehouse Shift",
|
||||
"reason": "Game became paid",
|
||||
"deleted_at": "2026-10-24T02:54:33Z"
|
||||
},
|
||||
{
|
||||
"url": "https://zackabrah.itch.io/seedfolk",
|
||||
"name": "Seedfolk",
|
||||
"reason": "Game page no longer exists (HTTP 404)",
|
||||
"deleted_at": "2026-10-24T02:54:37Z"
|
||||
},
|
||||
{
|
||||
"url": "https://2tonmucho.itch.io/suburb2065",
|
||||
"name": "Suburb2065-PC/Japanese-",
|
||||
"reason": "Game page no longer exists (HTTP 404)",
|
||||
"deleted_at": "2026-10-24T02:54:40Z"
|
||||
},
|
||||
{
|
||||
"url": "https://tattershallstudios.itch.io/gravewell",
|
||||
"name": "Gravewell",
|
||||
"reason": "Game became paid",
|
||||
"deleted_at": "2026-10-24T02:54:43Z"
|
||||
},
|
||||
{
|
||||
"url": "https://oppai-games.itch.io/quickie-fantasy-adventure",
|
||||
"name": "Quickie: Fantasy Adventure",
|
||||
"reason": "Game page no longer exists (HTTP 404)",
|
||||
"deleted_at": "2026-10-24T02:54:47Z"
|
||||
},
|
||||
{
|
||||
"url": "https://oworlon.itch.io/femboy-apocalypse",
|
||||
"name": "Femboy Apocalypse",
|
||||
"reason": "Game page no longer exists (HTTP 404)",
|
||||
"deleted_at": "2026-10-24T02:54:51Z"
|
||||
},
|
||||
{
|
||||
"url": "https://augustine-ina.itch.io/comfort-and-warmth",
|
||||
"name": "Comfort and Warmth",
|
||||
"reason": "Game page no longer exists (HTTP 404)",
|
||||
"deleted_at": "2026-10-24T02:54:55Z"
|
||||
},
|
||||
{
|
||||
"url": "https://emika-games.itch.io/absolutely-nothing-good",
|
||||
"name": "ABSOLUTELY NOTHING GOOD",
|
||||
"reason": "Game became paid",
|
||||
"deleted_at": "2026-10-25T02:55:35Z"
|
||||
},
|
||||
{
|
||||
"url": "https://geistworld.itch.io/lupa-rossi-redux",
|
||||
"name": "Lupa Rossi Redux",
|
||||
"reason": "Game page is password-protected",
|
||||
"deleted_at": "2026-10-25T02:55:39Z"
|
||||
},
|
||||
{
|
||||
"url": "https://stelladevt.itch.io/mascot-testimonial-css-for-itchio",
|
||||
"name": "Mascot Testimonial CSS for itch.io",
|
||||
"reason": "Not a game",
|
||||
"deleted_at": "2026-10-28T02:41:27Z"
|
||||
},
|
||||
{
|
||||
"url": "https://gabrielnjlc.itch.io/dont-close-your-eyes",
|
||||
"name": "Don’t Close Your Eyes (DEMO)",
|
||||
"reason": "Game page no longer exists (HTTP 404)",
|
||||
"deleted_at": "2026-11-01T02:49:55Z"
|
||||
},
|
||||
{
|
||||
"url": "https://digitalwaste.itch.io/moroz",
|
||||
"name": "MOROZ",
|
||||
"reason": "Game page no longer exists (HTTP 404)",
|
||||
"deleted_at": "2026-11-01T02:49:57Z"
|
||||
},
|
||||
{
|
||||
"url": "https://little-ones.itch.io/cozy-game-company",
|
||||
"name": "Cozy Game Company",
|
||||
"reason": "Game became paid",
|
||||
"deleted_at": "2026-11-01T02:50:01Z"
|
||||
},
|
||||
{
|
||||
"url": "https://arubberducky.itch.io/futanari-destroying-sex-robot",
|
||||
"name": "Futanari Destroying Sex Robot",
|
||||
"reason": "Game page no longer exists (HTTP 404)",
|
||||
"deleted_at": "2026-11-01T02:50:04Z"
|
||||
},
|
||||
{
|
||||
"url": "https://quiirisk.itch.io/stepmom-who-fell-on-a-hike",
|
||||
"name": "Stepmom Who Fell on a Hike",
|
||||
"reason": "Game page no longer exists (HTTP 404)",
|
||||
"deleted_at": "2026-11-01T02:50:07Z"
|
||||
},
|
||||
{
|
||||
"url": "https://bokendev-studio.itch.io/turbovektor",
|
||||
"name": "TurboVektor",
|
||||
"reason": "Game page no longer exists (HTTP 404)",
|
||||
"deleted_at": "2026-11-01T02:50:10Z"
|
||||
},
|
||||
{
|
||||
"url": "https://msky-dev.itch.io/sandtrix",
|
||||
"name": "Sandtrix",
|
||||
"reason": "Game became paid",
|
||||
"deleted_at": "2026-11-02T02:49:51Z"
|
||||
},
|
||||
{
|
||||
"url": "https://kikinndev.itch.io/lost-in-the-store",
|
||||
"name": "Lost In The Store",
|
||||
"reason": "Game page no longer exists (HTTP 404)",
|
||||
"deleted_at": "2026-11-03T02:50:25Z"
|
||||
},
|
||||
{
|
||||
"url": "https://lucius39.itch.io/happy-chicken-master",
|
||||
"name": "Happy chicken master",
|
||||
"reason": "Game became paid",
|
||||
"deleted_at": "2026-11-03T02:50:29Z"
|
||||
},
|
||||
{
|
||||
"url": "https://thomas-tung.itch.io/day-five-v1",
|
||||
"name": "Day Five - v1",
|
||||
"reason": "Game page no longer exists (HTTP 404)",
|
||||
"deleted_at": "2026-11-03T02:50:32Z"
|
||||
},
|
||||
{
|
||||
"url": "https://countlessbathory.itch.io/autumns-end",
|
||||
"name": "Autumn's end (FREE UNTIL HALLOWEEN)",
|
||||
"reason": "Game became paid",
|
||||
"deleted_at": "2026-11-04T02:50:09Z"
|
||||
},
|
||||
{
|
||||
"url": "https://mimu2026.itch.io/empty-box",
|
||||
"name": "Empty Box-DEMO",
|
||||
"reason": "Game became paid",
|
||||
"deleted_at": "2026-11-04T02:50:12Z"
|
||||
},
|
||||
{
|
||||
"url": "https://sasbyxan.itch.io/farm-factory-demo",
|
||||
"name": "Farm Factory | Demo",
|
||||
"reason": "Game page no longer exists (HTTP 404)",
|
||||
"deleted_at": "2026-11-04T02:50:16Z"
|
||||
},
|
||||
{
|
||||
"url": "https://raxeris.itch.io/99",
|
||||
"name": "99%",
|
||||
"reason": "Game became paid",
|
||||
"deleted_at": "2026-11-04T02:50:18Z"
|
||||
},
|
||||
{
|
||||
"url": "https://andrealphus.itch.io/that-time-i-got-reincarnated-as-a-barbarian",
|
||||
"name": "That Time I Got Reincarnated As A Barbarian",
|
||||
"reason": "Game became paid",
|
||||
"deleted_at": "2026-11-04T02:50:21Z"
|
||||
},
|
||||
{
|
||||
"url": "https://nytraam.itch.io/spooky-escape",
|
||||
"name": "A Spooky Escape (CJ)",
|
||||
"reason": "Game page no longer exists (HTTP 404)",
|
||||
"deleted_at": "2026-11-04T02:50:24Z"
|
||||
},
|
||||
{
|
||||
"url": "https://xeif.itch.io/kizuna-zx-spectrum",
|
||||
"name": "KIZUNA - ZX Spectrum",
|
||||
"reason": "Game became paid",
|
||||
"deleted_at": "2026-11-04T02:50:27Z"
|
||||
},
|
||||
{
|
||||
"url": "https://nanaroba.itch.io/the-intruder",
|
||||
"name": "The Intruder (DEMO)",
|
||||
"reason": "Game page no longer exists (HTTP 404)",
|
||||
"deleted_at": "2026-11-05T02:50:12Z"
|
||||
},
|
||||
{
|
||||
"url": "https://glodory-studio.itch.io/late-night",
|
||||
"name": "Late Order",
|
||||
"reason": "Game became paid",
|
||||
"deleted_at": "2026-11-05T02:50:15Z"
|
||||
},
|
||||
{
|
||||
"url": "https://lemos.itch.io/lure-of-the-vulpine-voice",
|
||||
"name": "Lure of the Vulpine Voice",
|
||||
"reason": "Game became paid",
|
||||
"deleted_at": "2026-11-06T02:49:50Z"
|
||||
},
|
||||
{
|
||||
"url": "https://star2dfd.itch.io/starlock",
|
||||
"name": "StarLock v2.2.12",
|
||||
"reason": "Game page no longer exists (HTTP 404)",
|
||||
"deleted_at": "2026-11-07T02:49:35Z"
|
||||
},
|
||||
{
|
||||
"url": "https://hotpink.itch.io/cryptid-park",
|
||||
"name": "Cryptid Park",
|
||||
"reason": "Game became paid",
|
||||
"deleted_at": "2026-11-07T02:49:40Z"
|
||||
},
|
||||
{
|
||||
"url": "https://deeddomanion.itch.io/deed-dominion",
|
||||
"name": "Deed & Dominion",
|
||||
"reason": "Game page is password-protected",
|
||||
"deleted_at": "2026-11-08T02:50:59Z"
|
||||
},
|
||||
{
|
||||
"url": "https://choic-e.itch.io/whyher",
|
||||
"name": "I Can't Fix Her",
|
||||
"reason": "Game page no longer exists (HTTP 404)",
|
||||
"deleted_at": "2026-11-08T02:51:07Z"
|
||||
},
|
||||
{
|
||||
"url": "https://zackanuar.itch.io/heir-of-the-dog",
|
||||
"name": "Heir of the Dog",
|
||||
"reason": "Game page no longer exists (HTTP 404)",
|
||||
"deleted_at": "2026-11-08T02:51:11Z"
|
||||
},
|
||||
{
|
||||
"url": "https://datasparrow.itch.io/shardana-hydro-trail-gp",
|
||||
"name": "Shardana: Hydro Trail GP",
|
||||
"reason": "Game became paid",
|
||||
"deleted_at": "2026-11-09T02:49:47Z"
|
||||
},
|
||||
{
|
||||
"url": "https://bksil.itch.io/hyperfall",
|
||||
"name": "Hyperfall",
|
||||
"reason": "Game page no longer exists (HTTP 404)",
|
||||
"deleted_at": "2026-11-11T02:50:09Z"
|
||||
},
|
||||
{
|
||||
"url": "https://kenmaryuji.itch.io/mineminemine",
|
||||
"name": "MINE! MINE! MINE! (v1.2)",
|
||||
"reason": "Game became paid",
|
||||
"deleted_at": "2026-11-11T02:50:11Z"
|
||||
},
|
||||
{
|
||||
"url": "https://wistarck.itch.io/joyandme",
|
||||
"name": "Joy and me Chapter 1",
|
||||
"reason": "Game page no longer exists (HTTP 404)",
|
||||
"deleted_at": "2026-11-12T02:49:43Z"
|
||||
},
|
||||
{
|
||||
"url": "https://star2dfd.itch.io/starbetablock",
|
||||
"name": "StarCensor v0.1",
|
||||
"reason": "Game page no longer exists (HTTP 404)",
|
||||
"deleted_at": "2026-11-12T02:49:47Z"
|
||||
},
|
||||
{
|
||||
"url": "https://pollikk-studios.itch.io/marketfield",
|
||||
"name": "Marketfield",
|
||||
"reason": "Game became paid",
|
||||
"deleted_at": "2026-11-13T02:49:46Z"
|
||||
},
|
||||
{
|
||||
"url": "https://red-anarhy173.itch.io/sprunki-hypershifted-peppers-take",
|
||||
"name": "Sprunki Hypershifted Pepper's Take",
|
||||
"reason": "Game page no longer exists (HTTP 404)",
|
||||
"deleted_at": "2026-11-13T02:49:50Z"
|
||||
},
|
||||
{
|
||||
"url": "https://funday-games.itch.io/booster-pack-heroes",
|
||||
"name": "Booster Pack Heroes",
|
||||
"reason": "Game became paid",
|
||||
"deleted_at": "2026-11-13T02:49:54Z"
|
||||
},
|
||||
{
|
||||
"url": "https://leonncamayo.itch.io/failrooms",
|
||||
"name": "FailRooms - Demo",
|
||||
"reason": "Game page no longer exists (HTTP 404)",
|
||||
"deleted_at": "2026-11-13T02:49:56Z"
|
||||
},
|
||||
{
|
||||
"url": "https://joerenwick.itch.io/girl-scarecrow",
|
||||
"name": "Girl & Scarecrow DEMO",
|
||||
"reason": "Game became paid",
|
||||
"deleted_at": "2026-11-13T02:50:00Z"
|
||||
},
|
||||
{
|
||||
"url": "https://vempyy.itch.io/jungle-tag",
|
||||
"name": "Jungle tag V99",
|
||||
"reason": "Game page no longer exists (HTTP 404)",
|
||||
"deleted_at": "2026-11-13T02:50:03Z"
|
||||
},
|
||||
{
|
||||
"url": "https://alfri00.itch.io/ballrollterror",
|
||||
"name": "BallRollTerror",
|
||||
"reason": "Game page no longer exists (HTTP 404)",
|
||||
"deleted_at": "2026-11-13T02:50:07Z"
|
||||
},
|
||||
{
|
||||
"url": "https://zapakitul.itch.io/night-cart-the-immortal-plague",
|
||||
"name": "Night Cart: The Immortal Plague",
|
||||
"reason": "Game became paid",
|
||||
"deleted_at": "2026-11-14T02:49:35Z"
|
||||
},
|
||||
{
|
||||
"url": "https://turtlevaniagames.itch.io/penguin-planet",
|
||||
"name": "Penguin Planet",
|
||||
"reason": "Game page no longer exists (HTTP 404)",
|
||||
"deleted_at": "2026-11-14T02:49:39Z"
|
||||
},
|
||||
{
|
||||
"url": "https://shibaki-dev.itch.io/ninefold",
|
||||
"name": "Ninefold",
|
||||
"reason": "Game page no longer exists (HTTP 404)",
|
||||
"deleted_at": "2026-11-14T02:49:42Z"
|
||||
},
|
||||
{
|
||||
"url": "https://nhungtt2804.itch.io/abyssal-drift",
|
||||
"name": "Abyssal drift",
|
||||
"reason": "Game page no longer exists (HTTP 404)",
|
||||
"deleted_at": "2026-11-14T02:49:44Z"
|
||||
}
|
||||
]
|
||||
+6
-2
@@ -3,8 +3,8 @@ patch.py — The hand-off format between pipeline scans and the commit step.
|
||||
|
||||
Scanners (refresh.py, update_info.py) never write the catalog directly. They
|
||||
emit a patch; apply_patch.py applies it idempotently to whatever `main` looks
|
||||
like at push time, so concurrent writers (other workflows, the admin Worker,
|
||||
the browser extension) never overwrite each other.
|
||||
like at push time, so concurrent writers (other workflows, the admin Worker
|
||||
and its cron) never overwrite each other.
|
||||
|
||||
Patch v1:
|
||||
{
|
||||
@@ -16,6 +16,8 @@ Patch v1:
|
||||
"removals": [{"url", "name", "reason", "deleted_at"}],
|
||||
"refresh_state": {"<url>": {...} | null}, # null = drop entry
|
||||
"ingest_state": {"<url>": {...} | null},
|
||||
"ingest_outcomes": {"<url>": {"outcome", "at"}}, # how a queued link ended (added, paid,
|
||||
# dead, private, duplicate, deleted, gave_up)
|
||||
"queue_add": ["<url>", ...], # append to temp_link.json if absent
|
||||
"queue_remove": ["<url>", ...], # drop from temp_link.json
|
||||
"unlog": ["<url>", ...], # unblocked + re-added: drop from the
|
||||
@@ -42,6 +44,7 @@ def new_patch(kind: str) -> dict:
|
||||
"removals": [],
|
||||
"refresh_state": {},
|
||||
"ingest_state": {},
|
||||
"ingest_outcomes": {},
|
||||
"queue_add": [],
|
||||
"queue_remove": [],
|
||||
"unlog": [],
|
||||
@@ -71,6 +74,7 @@ def is_empty(patch: dict) -> bool:
|
||||
"removals",
|
||||
"refresh_state",
|
||||
"ingest_state",
|
||||
"ingest_outcomes",
|
||||
"queue_add",
|
||||
"queue_remove",
|
||||
"unlog",
|
||||
|
||||
+18
-4
@@ -10,6 +10,7 @@ then the least recently checked — about 1/7 of the catalog by default, so
|
||||
every game is re-checked weekly. From that single page it derives:
|
||||
- alive: 404/410 → "dead" strike
|
||||
- price: paid → "paid" strike
|
||||
- access: itch.io's password form instead of the game → "private" strike
|
||||
- rating, rating_count, status, ai_disclosure / ai_content / accessibility
|
||||
(+ backfills release_date / thumbnail / updated_at when missing)
|
||||
A game is removed only when the same strike is seen again at least
|
||||
@@ -58,6 +59,7 @@ from scraper import (
|
||||
find_title,
|
||||
has_info_panel,
|
||||
is_free_game,
|
||||
is_password_protected,
|
||||
now_iso,
|
||||
parse_game,
|
||||
parse_info_table,
|
||||
@@ -80,12 +82,18 @@ MASS_FLOOR = 10
|
||||
MASS_SHARE = 0.10
|
||||
|
||||
REASON_PAID = "Game became paid"
|
||||
REASON_PRIVATE = "Game page is password-protected"
|
||||
|
||||
|
||||
def reason_dead(code: int) -> str:
|
||||
return f"Game page no longer exists (HTTP {code})"
|
||||
|
||||
|
||||
def removal_kind(reason: str) -> str:
|
||||
"""The strike kind ("dead", "paid", "private") a removal reason was written for."""
|
||||
return {REASON_PAID: "paid", REASON_PRIVATE: "private"}.get(reason, "dead")
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Target selection
|
||||
# ---------------------------------------------------------------------------
|
||||
@@ -142,7 +150,7 @@ def select_targets(
|
||||
first_urls = {g["url"] for g in first}
|
||||
rest = sorted(
|
||||
(g for g in games if g["url"] not in first_urls),
|
||||
key=lambda g: state.get(g["url"], {}).get(stamp, ""),
|
||||
key=lambda game: state.get(game["url"], {}).get(stamp, ""),
|
||||
)
|
||||
return (first + rest)[:budget]
|
||||
|
||||
@@ -227,6 +235,8 @@ def check_game(
|
||||
return strike("dead", reason_dead(page.status))
|
||||
|
||||
soup = page.soup
|
||||
if soup is not None and is_password_protected(soup):
|
||||
return strike("private", REASON_PRIVATE)
|
||||
if soup is None or find_title(soup) == NA:
|
||||
entry["fails"] = entry.get("fails", 0) + 1
|
||||
return "parse_fail", {}, None, entry
|
||||
@@ -281,12 +291,15 @@ def _write_outputs(stats: dict) -> None:
|
||||
("Checked", stats["checked"]),
|
||||
("Fields changed (games)", stats["changed"]),
|
||||
("New strikes", stats["strikes"]),
|
||||
("Removed (dead / paid)", f"{stats['removed_dead']} / {stats['removed_paid']}"),
|
||||
(
|
||||
"Removed (dead / paid / private)",
|
||||
f"{stats['removed_dead']} / {stats['removed_paid']} / {stats['removed_private']}",
|
||||
),
|
||||
("Removals withheld (mass-change guard)", stats["withheld"]),
|
||||
("Errors / parse failures", f"{stats['errors']} / {stats['parse_fail']}"),
|
||||
("HTTP 429/503", stats["http_429"]),
|
||||
("Stopped", stats["stopped"] or "completed"),
|
||||
("Duration", f"{stats['duration_s'] / 60:.1f} min"),
|
||||
("Duration", f"{float(stats['duration_s']) / 60:.1f} min"),
|
||||
]
|
||||
with open(summary, "a", encoding="utf-8") as f:
|
||||
f.write("### Catalog refresh\n\n| | |\n|---|---|\n")
|
||||
@@ -309,7 +322,7 @@ def keep_struck(patch: dict, state: dict, removals: list[dict], stats: dict, mar
|
||||
entry["full"] = removal["deleted_at"]
|
||||
patch["refresh_state"][removal["url"]] = entry
|
||||
stats["removed"] -= 1
|
||||
stats["removed_" + ("paid" if removal["reason"] == REASON_PAID else "dead")] -= 1
|
||||
stats["removed_" + removal_kind(removal["reason"])] -= 1
|
||||
patch["removals"] = [r for r in patch["removals"] if r["url"] not in urls]
|
||||
|
||||
|
||||
@@ -425,6 +438,7 @@ def main(argv: list[str] | None = None) -> int:
|
||||
"removed",
|
||||
"removed_dead",
|
||||
"removed_paid",
|
||||
"removed_private",
|
||||
"errors",
|
||||
"parse_fail",
|
||||
"http_429",
|
||||
|
||||
+21
-6
@@ -77,8 +77,8 @@ def create_session() -> requests.Session:
|
||||
raise_on_status=False,
|
||||
)
|
||||
adapter = HTTPAdapter(max_retries=retry)
|
||||
# Every URL we fetch is canonical https (canonical.py); no adapter for plain http.
|
||||
session.mount("https://", adapter)
|
||||
session.mount("http://", adapter)
|
||||
return session
|
||||
|
||||
|
||||
@@ -233,7 +233,17 @@ def find_title(soup: BeautifulSoup) -> str:
|
||||
|
||||
def has_info_panel(soup: BeautifulSoup) -> bool:
|
||||
wrapper = soup.find("div", class_="info_panel_wrapper")
|
||||
return bool(wrapper and wrapper.find("table"))
|
||||
if not wrapper:
|
||||
return False
|
||||
return wrapper.find("table") is not None
|
||||
|
||||
|
||||
def is_password_protected(soup: BeautifulSoup) -> bool:
|
||||
"""itch.io's "A password is required to view this page" form instead of the game (HTTP 200)."""
|
||||
return bool(
|
||||
soup.find("div", class_="game_password_page")
|
||||
or soup.find("input", attrs={"name": "game_password"})
|
||||
)
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
@@ -362,7 +372,9 @@ def _cap(text: str) -> str:
|
||||
def extract_tagline(soup: BeautifulSoup) -> str:
|
||||
"""The creator's "short description or tagline" (itch.io puts it in og:description)."""
|
||||
meta = soup.find("meta", property="og:description")
|
||||
text = " ".join(str(meta.get("content", "")).split()) if meta else ""
|
||||
if not meta:
|
||||
return NA
|
||||
text = " ".join(str(meta.get("content", "")).split())
|
||||
return _cap(text) if text else NA
|
||||
|
||||
|
||||
@@ -391,8 +403,10 @@ def extract_description(soup: BeautifulSoup) -> str:
|
||||
# ---------------------------------------------------------------------------
|
||||
def extract_thumbnail(soup: BeautifulSoup) -> str:
|
||||
meta = soup.find("meta", property="og:image")
|
||||
if meta and str(meta.get("content", "")).startswith("http"):
|
||||
return meta["content"]
|
||||
if meta:
|
||||
content = str(meta.get("content", ""))
|
||||
if content.startswith("http"):
|
||||
return content
|
||||
|
||||
ss = soup.find("div", class_="screenshot_list")
|
||||
if ss:
|
||||
@@ -421,7 +435,8 @@ def detect_nsfw(soup: BeautifulSoup, tags, *texts: str) -> str:
|
||||
return "Yes"
|
||||
if any(text != NA and _NSFW_RE.search(text) for text in texts):
|
||||
return "Yes"
|
||||
if soup.find("div", class_=["view_game_warning", "mature_content_notice"]):
|
||||
# Either notice (a class list in find() would mean the same; ".a.b" would need both).
|
||||
if soup.select_one("div.view_game_warning, div.mature_content_notice"):
|
||||
return "Yes"
|
||||
return "No"
|
||||
|
||||
|
||||
File diff suppressed because it is too large.
Load diff
@@ -1 +1,3 @@
|
||||
{}
|
||||
{
|
||||
"https://ratking.itch.io/mops-and-mobs": {"attempts": 3, "gave_up": "2026-10-14T20:24:20Z", "last_attempt": "2026-10-14T20:24:20Z", "last_error": "error: HTTP 403"}
|
||||
}
|
||||
+6035
-3251
File diff suppressed because it is too large.
Load diff
+37
-12
@@ -4,9 +4,10 @@ update_info.py — Scrape queued game links into a pipeline patch.
|
||||
Flow:
|
||||
1. Read URLs from scripts/temp_link.json (+ INPUT_URL from workflow_dispatch)
|
||||
2. Canonicalize; drop invalid URLs, duplicates, games already in the catalog
|
||||
and games in scripts/deleted_games.json (the admin restores a deleted
|
||||
game by removing its log entry when approving it again)
|
||||
3. Fetch each page → keep only free games (with an `added_at` stamp)
|
||||
and games in scripts/deleted_games.json (unless the admin restored them:
|
||||
scripts/state/unblocked.json)
|
||||
3. Fetch each page → keep only free games (with an `added_at` stamp); a
|
||||
password-protected page ends the link like a dead one
|
||||
4. Emit a patch (see patch.py). URLs that finished (added / paid / dead /
|
||||
skipped) are dropped from the queue; transient failures stay queued and
|
||||
are retried; a link is given up after MAX_ATTEMPTS failures at least
|
||||
@@ -18,9 +19,12 @@ Flow:
|
||||
(`queue_add`), so it survives a retry, a deadline or a rate-limit stop.
|
||||
A second spelling of a queued game is left alone: the first copy's
|
||||
outcome removes every spelling (apply_patch compares canonical forms).
|
||||
5. How each link ended (added, paid, dead, private, duplicate, deleted,
|
||||
gave_up) goes to `ingest_outcomes` → scripts/state/ingest_outcomes.json,
|
||||
which the admin page reads to follow a batch it queued.
|
||||
|
||||
apply_patch.py then applies the patch to the latest `main`, so links queued
|
||||
while this ran (extension, admin) are never overwritten.
|
||||
while this ran (admin, cron) are never overwritten.
|
||||
|
||||
Usage: python scripts/update_info.py --out patch.json [--deadline-min 50]
|
||||
"""
|
||||
@@ -37,7 +41,7 @@ from data_store import get_all_urls, load_all_games
|
||||
from json_io import load_json
|
||||
from patch import new_patch, write_patch
|
||||
from refresh import fetch_with_backoff
|
||||
from scraper import NA, Pacer, create_session, now_iso, parse_game
|
||||
from scraper import NA, Pacer, create_session, is_password_protected, now_iso, parse_game
|
||||
|
||||
TEMP_LINK = "scripts/temp_link.json"
|
||||
DELETED_LOG = "scripts/deleted_games.json"
|
||||
@@ -69,7 +73,12 @@ def failed_attempt(previous: dict, outcome: str, now: str) -> dict:
|
||||
return {"attempts": previous["attempts"] + 1, "last_attempt": now, "last_error": outcome}
|
||||
|
||||
|
||||
def main(argv: list[str] | None = None) -> int:
|
||||
def record_outcome(patch: dict, url: str, outcome: str) -> None:
|
||||
"""How a queued link ended, for the admin page's tracking of the batches it queued."""
|
||||
patch["ingest_outcomes"][url] = {"outcome": outcome, "at": now_iso()}
|
||||
|
||||
|
||||
def main(argv: list[str] | None = None) -> None:
|
||||
ap = argparse.ArgumentParser(description="Scrape queued links into a patch.")
|
||||
ap.add_argument("--out", required=True, help="patch file to write")
|
||||
ap.add_argument("--deadline-min", type=float, default=50.0)
|
||||
@@ -87,7 +96,18 @@ def main(argv: list[str] | None = None) -> int:
|
||||
print(f"Added from workflow input: {input_url}")
|
||||
|
||||
stats = dict.fromkeys(
|
||||
("queued", "added", "paid", "dead", "duplicate", "deleted", "invalid", "retry", "gave_up"),
|
||||
(
|
||||
"queued",
|
||||
"added",
|
||||
"paid",
|
||||
"dead",
|
||||
"private",
|
||||
"duplicate",
|
||||
"deleted",
|
||||
"invalid",
|
||||
"retry",
|
||||
"gave_up",
|
||||
),
|
||||
0,
|
||||
)
|
||||
stats["queued"] = len(queue)
|
||||
@@ -95,7 +115,7 @@ def main(argv: list[str] | None = None) -> int:
|
||||
if not queue:
|
||||
print("No links to process (temp_link.json empty and no INPUT_URL).")
|
||||
write_patch(args.out, patch)
|
||||
return 0
|
||||
return
|
||||
|
||||
catalog_urls = get_all_urls(load_all_games())
|
||||
deleted_urls = {e.get("url") for e in load_json(DELETED_LOG)}
|
||||
@@ -118,11 +138,13 @@ def main(argv: list[str] | None = None) -> int:
|
||||
if url in catalog_urls:
|
||||
print(f"Skip duplicate: {url}")
|
||||
stats["duplicate"] += 1
|
||||
record_outcome(patch, url, "duplicate")
|
||||
if url in unblocked:
|
||||
patch["unlog"].append(url)
|
||||
elif url in deleted_urls and url not in unblocked:
|
||||
print(f"Skip previously deleted: {url} (restore it from the admin page)")
|
||||
stats["deleted"] += 1
|
||||
record_outcome(patch, url, "deleted")
|
||||
else:
|
||||
todo.append(url)
|
||||
continue
|
||||
@@ -145,8 +167,9 @@ def main(argv: list[str] | None = None) -> int:
|
||||
stats["retry"] += 1
|
||||
continue
|
||||
|
||||
outcome = ""
|
||||
if page.status == 200 and page.soup is not None:
|
||||
if page.status == 200 and page.soup is not None and is_password_protected(page.soup):
|
||||
outcome = "private" # final: nobody can open it, so retrying won't help
|
||||
elif page.status == 200 and page.soup is not None:
|
||||
record = parse_game(page.soup, url)
|
||||
if record["name"] == NA:
|
||||
outcome = "error: no title"
|
||||
@@ -168,6 +191,7 @@ def main(argv: list[str] | None = None) -> int:
|
||||
patch["queue_remove"].append(url)
|
||||
patch["ingest_state"][url] = {**entry, "gave_up": entry["last_attempt"]}
|
||||
stats["gave_up"] += 1
|
||||
record_outcome(patch, url, "gave_up")
|
||||
if url in unblocked:
|
||||
patch["unblock_remove"].append(url)
|
||||
else:
|
||||
@@ -178,6 +202,7 @@ def main(argv: list[str] | None = None) -> int:
|
||||
|
||||
print(f" → {outcome}")
|
||||
stats[outcome] += 1
|
||||
record_outcome(patch, url, outcome)
|
||||
patch["queue_remove"].append(url)
|
||||
patch["ingest_state"][url] = None
|
||||
if url in unblocked:
|
||||
@@ -186,11 +211,11 @@ def main(argv: list[str] | None = None) -> int:
|
||||
write_patch(args.out, patch)
|
||||
print(
|
||||
f"\nDone — {stats['added']} added, {stats['paid']} paid, {stats['dead']} dead, "
|
||||
f"{stats['private']} password-protected, "
|
||||
f"{stats['duplicate']} duplicates, {stats['deleted']} previously deleted, "
|
||||
f"{stats['invalid']} invalid, {stats['retry']} to retry, {stats['gave_up']} given up."
|
||||
)
|
||||
return 0
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
sys.exit(main())
|
||||
main()
|
||||
@@ -14,6 +14,7 @@ Checks:
|
||||
- index.json agrees with the chunk files
|
||||
- count_history.json: one {date, total} row per day, sorted
|
||||
- deleted_games.json entries are complete; temp_link.json is a list of strings
|
||||
- state/ingest_outcomes.json (when present): canonical URL → {outcome, at}
|
||||
|
||||
`--fix` applies safe normalizations (safe_virus / nsfw spelling) and saves.
|
||||
"""
|
||||
@@ -55,9 +56,27 @@ NSFW = {"Yes", "No"}
|
||||
_SAFE_VIRUS_ALIASES = {"y": "Yes", "yes": "Yes", "n": "No", "no": "No", "caution": "Caution"}
|
||||
_NSFW_ALIASES = {"y": "Yes", "yes": "Yes", "n": "No", "no": "No"}
|
||||
_DATE_RE = re.compile(r"^\d{4}-\d{2}-\d{2}$")
|
||||
_STAMP_RE = re.compile(r"^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}Z$")
|
||||
INGEST_OUTCOMES_VALUES = {"added", "duplicate", "paid", "dead", "private", "deleted", "gave_up"}
|
||||
|
||||
DELETED_LOG = "scripts/deleted_games.json"
|
||||
TEMP_LINK = "scripts/temp_link.json"
|
||||
INGEST_OUTCOMES = "scripts/state/ingest_outcomes.json"
|
||||
|
||||
|
||||
def check_outcomes(outcomes) -> list[str]:
|
||||
"""scripts/state/ingest_outcomes.json: canonical URL → {outcome, at}."""
|
||||
if not isinstance(outcomes, dict):
|
||||
return ["ingest_outcomes.json: top level must be an object"]
|
||||
errors = []
|
||||
for url, entry in outcomes.items():
|
||||
if not is_canonical(url):
|
||||
errors.append(f"ingest_outcomes.json: {url!r} is not a canonical game URL")
|
||||
elif not isinstance(entry, dict) or entry.get("outcome") not in INGEST_OUTCOMES_VALUES:
|
||||
errors.append(f"ingest_outcomes.json[{url}]: unknown outcome")
|
||||
elif not isinstance(entry.get("at"), str) or not _STAMP_RE.match(entry["at"]):
|
||||
errors.append(f"ingest_outcomes.json[{url}]: 'at' must be YYYY-MM-DDTHH:MM:SSZ")
|
||||
return errors
|
||||
|
||||
|
||||
def check_record(game, where: str) -> tuple[list[str], list[str]]:
|
||||
@@ -161,6 +180,9 @@ def validate() -> tuple[list[str], list[str]]:
|
||||
if not isinstance(queue, list) or not all(isinstance(u, str) for u in queue):
|
||||
errors.append("temp_link.json must be a JSON array of URL strings")
|
||||
|
||||
if os.path.exists(INGEST_OUTCOMES):
|
||||
errors += check_outcomes(load_json(INGEST_OUTCOMES))
|
||||
|
||||
return errors, warnings
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,45 @@
|
||||
# SonarQube Cloud, CI-based analysis: .github/workflows/sonarcloud.yml
|
||||
# (https://sonarcloud.io/project/overview?id=poli0981_free-games-itchio-list).
|
||||
# Automatic Analysis is switched off on sonarcloud.io: the two can't run together.
|
||||
# Mark a false positive on the issue itself (CLAUDE.md, gotcha 41).
|
||||
sonar.organization=poli0981
|
||||
sonar.projectKey=poli0981_free-games-itchio-list
|
||||
sonar.projectName=free-games-itchio-list
|
||||
sonar.sourceEncoding=UTF-8
|
||||
# The project runs on 3.15 (.github/python-version), but SonarQube Cloud's Python
|
||||
# analyzer stops at 3.14 ("No explicit support for version 3.15", then it falls
|
||||
# back to 3.14). Raise this once it supports 3.15.
|
||||
sonar.python.version=3.14
|
||||
|
||||
# The whole repository, as Automatic Analysis read it, with the tests as tests.
|
||||
sonar.sources=.
|
||||
# The tests (below); the binary images, which, indexed as text, only made the
|
||||
# scanner warn about their encoding; and the D1 migrations, SQLite that the
|
||||
# Oracle PL/SQL analyzer claims, only to warn that it has no data dictionary.
|
||||
sonar.exclusions=tests/**,webapp/**/*.test.*,webapp/worker/test/**,**/*.png,**/*.ico,**/*.icns,**/*.webp,**/*.sql
|
||||
sonar.tests=.
|
||||
sonar.test.inclusions=tests/**,webapp/**/*.test.*,webapp/worker/test/**
|
||||
# itch.io pages saved as served, for the scraper tests: their markup is
|
||||
# itch.io's (tables without <th>, tabindex on divs, …), and editing it would
|
||||
# make the tests check something itch.io never sends.
|
||||
sonar.test.exclusions=tests/fixtures/**
|
||||
|
||||
# Written by the workflow's coverage job, with paths from the repository root:
|
||||
# `pytest --cov --cov-report=xml` (Cobertura) and `npm run test:coverage` (lcov).
|
||||
sonar.python.coverage.reportPaths=coverage.xml
|
||||
sonar.javascript.lcov.reportPaths=webapp/coverage/lcov.info
|
||||
# No unit tests by design — the React UI (components, routes, hooks, stores),
|
||||
# the i18n message catalogs, configs, maintainer tools and the Tauri shell — so
|
||||
# they don't count towards coverage (the "Sonar way" quality gate wants 80 % on
|
||||
# new code). Keep this list in step with what the tests can reach.
|
||||
sonar.coverage.exclusions=\
|
||||
**/*.tsx,\
|
||||
webapp/src/components/**,\
|
||||
webapp/src/hooks/**,\
|
||||
webapp/src/lib/use-*.ts,\
|
||||
webapp/src/stores/**,\
|
||||
webapp/src/lib/i18n/**,\
|
||||
webapp/*.config.*,\
|
||||
webapp/scripts/gen_assets.py,\
|
||||
webapp/scripts/i18n-edit.mjs,\
|
||||
webapp/src-tauri/**
|
||||
Vendored
+22
@@ -0,0 +1,22 @@
|
||||
<!doctype html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>Secret Garden by Quiet Studio - itch.io</title>
|
||||
<meta content="Secret Garden by Quiet Studio" property="og:title"/>
|
||||
</head>
|
||||
<body class="locale_en layout_widget responsive" data-page_name="view_game">
|
||||
<div class="header_widget base_widget"><h1 class="title">itch.io</h1></div>
|
||||
<div class="main"><div class="inner_column">
|
||||
<div class="game_password_page page_widget base_widget" id="game_password_123456"><div class="padded"><section>
|
||||
<h2>A password is required to view this page</h2>
|
||||
<form action="https://quietstudio.itch.io/secret-garden/password" autocomplete="off" class="form" method="post">
|
||||
<input name="csrf_token" type="hidden" value="token"/>
|
||||
<div class="input_row"><label><input autocomplete="new-password" name="game_password" placeholder="Required" required="required" type="password"/></label></div>
|
||||
<input name="return_to" type="hidden" value="https://quietstudio.itch.io/secret-garden"/>
|
||||
<div class="buttons"><button class="button">Submit</button></div>
|
||||
</form>
|
||||
</section></div></div>
|
||||
</div></div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -220,3 +220,68 @@ def test_refresh_patch_removals_are_capped_by_games_checked(repo):
|
||||
patch["removals"] = patch["removals"][:12]
|
||||
write_patch("patch.json", patch)
|
||||
assert apply_patch.main(["patch.json"]) == 0
|
||||
|
||||
|
||||
def _outcome(outcome, at):
|
||||
return {"outcome": outcome, "at": at}
|
||||
|
||||
|
||||
def test_ingest_outcomes_merge_newest_wins_and_reapply_is_a_noop(repo):
|
||||
seed_catalog([make_game("a")])
|
||||
save_json(
|
||||
_state_file("ingest_outcomes"),
|
||||
{
|
||||
"https://dev.itch.io/a": _outcome("added", "2026-10-01T00:00:00Z"),
|
||||
"https://dev.itch.io/b": _outcome("paid", "2026-10-05T00:00:00Z"),
|
||||
},
|
||||
)
|
||||
patch = new_patch("ingest")
|
||||
patch["ingest_outcomes"] = {
|
||||
"https://dev.itch.io/b": _outcome("added", "2026-10-04T00:00:00Z"), # older: ignored
|
||||
"https://dev.itch.io/c": _outcome("dead", "2026-10-06T00:00:00Z"),
|
||||
}
|
||||
write_patch("patch.json", patch)
|
||||
assert apply_patch.main(["patch.json"]) == 0
|
||||
expected = {
|
||||
"https://dev.itch.io/a": _outcome("added", "2026-10-01T00:00:00Z"),
|
||||
"https://dev.itch.io/b": _outcome("paid", "2026-10-05T00:00:00Z"),
|
||||
"https://dev.itch.io/c": _outcome("dead", "2026-10-06T00:00:00Z"),
|
||||
}
|
||||
assert read_json(_state_file("ingest_outcomes")) == expected
|
||||
before = (repo / _state_file("ingest_outcomes")).read_bytes()
|
||||
assert apply_patch.main(["patch.json"]) == 0
|
||||
assert (repo / _state_file("ingest_outcomes")).read_bytes() == before
|
||||
|
||||
|
||||
def test_a_patch_with_only_outcomes_is_applied(repo):
|
||||
seed_catalog([make_game("a")])
|
||||
patch = new_patch("ingest")
|
||||
patch["ingest_outcomes"] = {
|
||||
"https://dev.itch.io/a": _outcome("duplicate", "2026-10-06T00:00:00Z")
|
||||
}
|
||||
write_patch("patch.json", patch)
|
||||
assert apply_patch.main(["patch.json"]) == 0
|
||||
assert (
|
||||
read_json(_state_file("ingest_outcomes"))["https://dev.itch.io/a"]["outcome"] == "duplicate"
|
||||
)
|
||||
|
||||
|
||||
def test_ingest_outcomes_are_pruned_by_age_and_count(monkeypatch):
|
||||
current = {
|
||||
"https://dev.itch.io/old": _outcome("paid", "2026-06-01T00:00:00Z"), # > 90 days before
|
||||
"https://dev.itch.io/kept": _outcome("added", "2026-07-10T00:00:00Z"),
|
||||
"not a dict": "x",
|
||||
}
|
||||
delta = {"https://dev.itch.io/new": _outcome("dead", "2026-10-01T00:00:00Z")}
|
||||
merged = apply_patch.merge_outcomes(current, delta)
|
||||
assert set(merged) == {"https://dev.itch.io/kept", "https://dev.itch.io/new"}
|
||||
|
||||
monkeypatch.setattr(apply_patch, "OUTCOMES_KEEP", 2)
|
||||
many = {
|
||||
f"https://dev.itch.io/g{i}": _outcome("added", f"2026-10-0{i}T00:00:00Z")
|
||||
for i in range(1, 5)
|
||||
}
|
||||
assert set(apply_patch.merge_outcomes(many, {})) == {
|
||||
"https://dev.itch.io/g4",
|
||||
"https://dev.itch.io/g3",
|
||||
}
|
||||
@@ -11,6 +11,7 @@ from scraper import (
|
||||
detect_nsfw,
|
||||
extract_description,
|
||||
extract_tagline,
|
||||
is_password_protected,
|
||||
parse_game,
|
||||
parse_retry_after,
|
||||
)
|
||||
@@ -115,11 +116,25 @@ def test_page_without_info_panel():
|
||||
assert record["genre"] == NA and record["tags"] == []
|
||||
|
||||
|
||||
def test_password_page_is_recognised():
|
||||
assert is_password_protected(load_fixture_soup("game_password.html"))
|
||||
assert not is_password_protected(load_fixture_soup("game_free_full.html"))
|
||||
assert not is_password_protected(load_fixture_soup("game_no_info.html"))
|
||||
|
||||
|
||||
def test_mature_notice_marks_nsfw():
|
||||
record = parse_game(load_fixture_soup("game_nsfw_warning.html"), "https://x.itch.io/y")
|
||||
assert record["nsfw"] == "Yes"
|
||||
|
||||
|
||||
@pytest.mark.parametrize("notice", ["view_game_warning", "mature_content_notice"])
|
||||
def test_either_mature_notice_alone_marks_nsfw(notice):
|
||||
from bs4 import BeautifulSoup
|
||||
|
||||
soup = BeautifulSoup(f'<div class="{notice}"></div>', "html.parser")
|
||||
assert detect_nsfw(soup, [], NA) == "Yes"
|
||||
|
||||
|
||||
@pytest.mark.parametrize(
|
||||
("tags", "description", "expected"),
|
||||
[
|
||||
|
||||
@@ -83,6 +83,23 @@ def test_paid_page_strike_then_removal():
|
||||
assert outcome == "removed_paid" and removal["reason"] == "Game became paid"
|
||||
|
||||
|
||||
def test_password_protected_page_strike_then_removal():
|
||||
game = make_game("a")
|
||||
outcome, updates, removal, entry = refresh.check_game(
|
||||
game, ok_page("game_password.html"), {"fails": 3}, NOW
|
||||
)
|
||||
assert outcome == "strike_private" and removal is None and not updates
|
||||
assert entry["strike"] == "private" and "fails" in entry
|
||||
outcome, _, removal, _ = refresh.check_game(
|
||||
game, ok_page("game_password.html"), entry, TOMORROW_NOW
|
||||
)
|
||||
assert outcome == "removed_private"
|
||||
assert removal["reason"] == "Game page is password-protected"
|
||||
assert refresh.removal_kind(removal["reason"]) == "private"
|
||||
assert refresh.removal_kind("Game became paid") == "paid"
|
||||
assert refresh.removal_kind("Game page no longer exists (HTTP 404)") == "dead"
|
||||
|
||||
|
||||
def test_different_strike_kind_restarts_the_count():
|
||||
game = make_game("a")
|
||||
entry = {"strike": "paid", "strike_at": "2026-09-10T03:00:00Z"}
|
||||
|
||||
@@ -12,7 +12,7 @@ def _run(monkeypatch, pages: dict[str, Page], queue: list, **env):
|
||||
monkeypatch.setattr(
|
||||
update_info, "fetch_with_backoff", lambda _s, url, _p, _c: pages.get(url, Page(status=500))
|
||||
)
|
||||
assert update_info.main(["--out", "patch.json"]) == 0
|
||||
update_info.main(["--out", "patch.json"])
|
||||
return read_json("patch.json")
|
||||
|
||||
|
||||
@@ -33,12 +33,16 @@ def test_ingest_outcomes(repo, monkeypatch):
|
||||
"https://dev.itch.io/free": Page(status=200, soup=load_fixture_soup("game_free_full.html")),
|
||||
"https://dev.itch.io/paid": Page(status=200, soup=load_fixture_soup("game_paid.html")),
|
||||
"https://dev.itch.io/dead": Page(status=404),
|
||||
"https://dev.itch.io/locked": Page(
|
||||
status=200, soup=load_fixture_soup("game_password.html")
|
||||
),
|
||||
}
|
||||
queue = [
|
||||
"https://DEV.itch.io/free/", # canonicalized
|
||||
"https://dev.itch.io/free", # duplicate within the queue
|
||||
"https://dev.itch.io/paid",
|
||||
"https://dev.itch.io/dead",
|
||||
"https://dev.itch.io/locked", # password-protected: final, not retried
|
||||
"https://dev.itch.io/known",
|
||||
"https://dev.itch.io/removed",
|
||||
"https://dev.itch.io/flaky", # 500 → retry later
|
||||
@@ -54,13 +58,28 @@ def test_ingest_outcomes(repo, monkeypatch):
|
||||
assert flaky["attempts"] == 1 and flaky["last_error"] == "error: HTTP 500"
|
||||
stats = patch["stats"]
|
||||
assert (stats["added"], stats["paid"], stats["dead"], stats["duplicate"]) == (1, 1, 1, 1)
|
||||
# A password-protected page is final: dropped from the queue, no attempt kept.
|
||||
assert stats["private"] == 1 and patch["ingest_state"]["https://dev.itch.io/locked"] is None
|
||||
assert (stats["deleted"], stats["invalid"], stats["retry"]) == (1, 1, 1)
|
||||
# How each finished link ended, for the admin's batch tracking: retries, invalid
|
||||
# entries and second spellings leave no outcome.
|
||||
outcomes = {url: e["outcome"] for url, e in patch["ingest_outcomes"].items()}
|
||||
assert outcomes == {
|
||||
"https://dev.itch.io/free": "added",
|
||||
"https://dev.itch.io/paid": "paid",
|
||||
"https://dev.itch.io/dead": "dead",
|
||||
"https://dev.itch.io/locked": "private",
|
||||
"https://dev.itch.io/known": "duplicate",
|
||||
"https://dev.itch.io/removed": "deleted",
|
||||
}
|
||||
assert all(e["at"].endswith("Z") for e in patch["ingest_outcomes"].values())
|
||||
# apply_patch compares canonical forms, so each processed link is covered once.
|
||||
removed = {canonicalize(u) or u for u in patch["queue_remove"]}
|
||||
assert removed == {
|
||||
"https://dev.itch.io/free",
|
||||
"https://dev.itch.io/paid",
|
||||
"https://dev.itch.io/dead",
|
||||
"https://dev.itch.io/locked",
|
||||
"https://dev.itch.io/known",
|
||||
"https://dev.itch.io/removed",
|
||||
"not a url",
|
||||
@@ -74,6 +93,7 @@ def test_gives_up_after_three_attempts_and_resets_on_requeue(repo, monkeypatch):
|
||||
patch = _run(monkeypatch, {}, [url])
|
||||
assert url in patch["queue_remove"]
|
||||
assert patch["ingest_state"][url]["attempts"] == 3 and "gave_up" in patch["ingest_state"][url]
|
||||
assert patch["ingest_outcomes"][url]["outcome"] == "gave_up"
|
||||
|
||||
save_json("scripts/state/ingest_state.json", {url: patch["ingest_state"][url]})
|
||||
patch = _run(monkeypatch, {}, [url])
|
||||
@@ -119,7 +139,7 @@ def test_duplicate_spelling_survives_a_rate_limit_stop(repo, monkeypatch):
|
||||
queue = ["https://dev.itch.io/a", "https://dev.itch.io/a"]
|
||||
save_json("scripts/temp_link.json", queue)
|
||||
monkeypatch.setattr(update_info, "fetch_with_backoff", lambda *_a: None)
|
||||
assert update_info.main(["--out", "patch.json"]) == 0
|
||||
update_info.main(["--out", "patch.json"])
|
||||
assert _apply(read_json("patch.json")) == queue
|
||||
|
||||
|
||||
@@ -141,7 +161,7 @@ def test_dispatched_url_is_processed_first_and_queued_until_done(repo, monkeypat
|
||||
save_json("scripts/temp_link.json", ["https://dev.itch.io/backlog"])
|
||||
monkeypatch.setenv("INPUT_URL", "https://dev.itch.io/Dispatched/")
|
||||
monkeypatch.setattr(update_info, "fetch_with_backoff", fetch)
|
||||
assert update_info.main(["--out", "patch.json"]) == 0
|
||||
update_info.main(["--out", "patch.json"])
|
||||
patch = read_json("patch.json")
|
||||
assert seen[0] == "https://dev.itch.io/dispatched"
|
||||
assert patch["queue_add"] == ["https://dev.itch.io/dispatched"]
|
||||
@@ -185,7 +205,7 @@ def test_failures_count_only_when_spaced_out(repo, monkeypatch):
|
||||
"2026-09-18T14:00:00Z", # 3 -> given up
|
||||
):
|
||||
monkeypatch.setattr(update_info, "now_iso", lambda s=stamp: s)
|
||||
assert update_info.main(["--out", "patch.json"]) == 0
|
||||
update_info.main(["--out", "patch.json"])
|
||||
write_patch("patch.json", read_json("patch.json"))
|
||||
assert apply_patch.main(["patch.json"]) == 0
|
||||
entry = read_json("scripts/state/ingest_state.json").get(url, {})
|
||||
|
||||
@@ -87,3 +87,22 @@ def test_state_map_one_line_per_url(tmp_path):
|
||||
assert json.loads(path.read_text(encoding="utf-8"))["https://b.itch.io/x"]["fails"] == 1
|
||||
save_state_map(str(path), {})
|
||||
assert json.loads(path.read_text(encoding="utf-8")) == {}
|
||||
|
||||
|
||||
def test_ingest_outcomes_file_is_checked_when_present(repo):
|
||||
seed_catalog([make_game("a")])
|
||||
good = {"https://dev.itch.io/a": {"outcome": "added", "at": "2026-10-01T00:00:00Z"}}
|
||||
save_state_map("scripts/state/ingest_outcomes.json", good)
|
||||
assert validate.validate() == ([], [])
|
||||
save_json(
|
||||
"scripts/state/ingest_outcomes.json",
|
||||
{
|
||||
"https://DEV.itch.io/a/": {"outcome": "added", "at": "2026-10-01T00:00:00Z"},
|
||||
"https://dev.itch.io/b": {"outcome": "maybe", "at": "2026-10-01T00:00:00Z"},
|
||||
"https://dev.itch.io/c": {"outcome": "paid", "at": "yesterday"},
|
||||
},
|
||||
)
|
||||
text = "\n".join(validate.validate()[0])
|
||||
assert "not a canonical game URL" in text
|
||||
assert "unknown outcome" in text
|
||||
assert "'at' must be" in text
|
||||
@@ -1 +1 @@
|
||||
24
|
||||
26
|
||||
+30
-18
@@ -3,12 +3,12 @@
|
||||
One codebase for everything people see of the catalog:
|
||||
|
||||
- the website **<https://freeitchgames.win>** — read-only for everyone (no accounts, no sign-in);
|
||||
- its **Cloudflare Worker** — image proxy, the public Suggest form, the browser-extension ingest API,
|
||||
the admin API and the scheduled RSS discovery;
|
||||
- its **Cloudflare Worker** — image proxy, the public Suggest form, the admin API and the scheduled RSS
|
||||
discovery;
|
||||
- the **admin** app at `/admin/` — Maintainer only, behind Cloudflare Access;
|
||||
- the **desktop and Android apps** — the same public app wrapped with Tauri 2 (see [`TAURI.md`](TAURI.md)).
|
||||
|
||||
Stack: React 19 + TypeScript 6 + Vite 8 (Rolldown) + Tailwind CSS 4 (`@tailwindcss/vite`, tokens in
|
||||
Stack: React 19 + TypeScript 7 + Vite 8 (Rolldown) + Tailwind CSS 4 (`@tailwindcss/vite`, tokens in
|
||||
[`src/index.css`](src/index.css)) + shadcn/ui (Radix), TanStack Query, React Router 8, Zustand, and the
|
||||
self-hosted Geist fonts. The Worker is plain TypeScript on Cloudflare Workers
|
||||
(R2, D1, Images, Turnstile, Rate Limiting, Access).
|
||||
@@ -28,12 +28,12 @@ key entries) and rewrites old `#/…` links to real paths ([`src/lib/legacy.ts`]
|
||||
| [`vite-plugins/catalog-data.ts`](vite-plugins/catalog-data.ts) | Bundles the catalog into `dist/data/` (packs + legacy JSON) + `sitemap.xml` |
|
||||
| [`public/`](public/) | Static files; [`public/_headers`](public/_headers) sets headers + CSP for them |
|
||||
| [`src-tauri/`](src-tauri/) | Tauri 2 shell for the desktop and Android apps |
|
||||
| [`scripts/`](scripts/) | `gen_assets.py` (PWA icons + OG image), `i18n-edit.mjs` (edit `en`/`vi` keys together) |
|
||||
| [`scripts/`](scripts/) | `gen_assets.py` (PWA icons + OG image), `i18n-edit.mjs` (edit `en`/`vi` keys together), `check-tauri-versions.mjs` (`npm run check:tauri`), and the repo-level tests `check-csp-hashes.test.mjs` (inline script hashes in the CSPs) and `check-contrast.test.mjs` (WCAG contrast of the colour tokens and the chart palette) |
|
||||
| [`wrangler.jsonc`](wrangler.jsonc) | Worker config: assets, bindings, vars, cron, `staging` env |
|
||||
|
||||
## Local dev
|
||||
|
||||
Requires Node.js 22.22+ (CI uses the version in [`.node-version`](.node-version)) and npm. The full
|
||||
Requires Node.js 26+ (CI uses the version in [`.node-version`](.node-version)) and npm. The full
|
||||
setup, including the Python pipeline, is in [`docs/dev_env.md`](../docs/dev_env.md).
|
||||
|
||||
```sh
|
||||
@@ -73,12 +73,13 @@ Path alias `@/*` → `src/*`. Vite injects `__BUILD_DATE__` for the About page.
|
||||
The same steps as [`webapp-ci.yml`](../.github/workflows/webapp-ci.yml):
|
||||
|
||||
```sh
|
||||
npm run check:tauri # Tauri crates and their npm packages share major.minor
|
||||
npm run cf:types -- --check # worker-configuration.d.ts matches wrangler.jsonc
|
||||
npm run lint # ESLint
|
||||
npm run knip # unused files / exports / deps
|
||||
npm test # Vitest: app + Worker (D1 tests run a local workerd)
|
||||
npm run build # includes tsc -b (or run npx tsc -b on its own)
|
||||
npx wrangler deploy --dry-run --env=""
|
||||
npm run cf:check # wrangler deploy --dry-run (deploys nothing)
|
||||
```
|
||||
|
||||
After editing `wrangler.jsonc`, run `npm run cf:types` and commit the regenerated
|
||||
@@ -95,7 +96,7 @@ local secrets can't leak into it. Secrets are typed by hand in [`worker/env.ts`]
|
||||
| `/charts` | [src/routes/charts.tsx](src/routes/charts.tsx) | Charts + KPI cards across 4 tabs |
|
||||
| `/removed` | [src/routes/deleted.tsx](src/routes/deleted.tsx) | Removed games, with reasons (`/deleted` redirects here) |
|
||||
| `/suggest` | [src/routes/suggest.tsx](src/routes/suggest.tsx) | Suggest a game (Turnstile, goes to the review queue) |
|
||||
| `/settings` | [src/routes/settings.tsx](src/routes/settings.tsx) | Theme, language, density, 18+ content opt-in (the header's display menu has the same) |
|
||||
| `/settings` | [src/routes/settings.tsx](src/routes/settings.tsx) | Theme, language, density, hide scrollbars, accessibility (the "/" search shortcut), 18+ content opt-in (the header's display menu has most of them) |
|
||||
| `/about` | [src/routes/about.tsx](src/routes/about.tsx) | Project info, legal links, third-party credits |
|
||||
| `/errors/:code` | [src/routes/error-preview.tsx](src/routes/error-preview.tsx) | Hidden error-page preview (not in the nav) |
|
||||
|
||||
@@ -116,8 +117,18 @@ verification page instead of the shell on every app route (and `403` on `/img`);
|
||||
Maintainer only. Cloudflare Access (the "Admin" application) guards `/admin` and `/api/admin/*`, and
|
||||
the Worker re-verifies the Access JWT and the `ADMIN_EMAILS` allow-list on every request
|
||||
([`worker/access.ts`](worker/access.ts), [`worker/admin.ts`](worker/admin.ts)). The app shell is only
|
||||
served after that check. Pages (hash routes): **Review queue**, **Add games**, **Catalog** (edit
|
||||
`safe_virus` / `notes` / `nsfw`, remove or restore a game).
|
||||
served after that check. Pages (hash routes):
|
||||
|
||||
- **Review queue**: approve (with override for removed games) or reject, in batches of 200.
|
||||
- **Add games**: paste any text or load a file, or read an itch.io collection; **Check** shows what Add
|
||||
would do with each URL before anything is written; Add queues the list in batches of 200 and then
|
||||
follows each game through the ingest (added / waiting / dropped and why, from
|
||||
`scripts/state/ingest_outcomes.json`).
|
||||
- **Catalog**: search, edit one game, or select up to 100 for a bulk edit (`nsfw` / `safe_virus` /
|
||||
`notes`) or a removal with a public reason (one commit); remove by list; restore removed games.
|
||||
- **New games** (added in the last 7 / 30 days, to review 18+ and virus checks in bulk), **Activity**
|
||||
(the D1 audit log) and **Settings** (auto-approve rules, followed itch.io collections, the last
|
||||
automatic run).
|
||||
|
||||
Writes go to the repo as a **GitHub App** (GraphQL `createCommitOnBranch`, so commits are
|
||||
"Verified"; [`worker/github.ts`](worker/github.ts), [`worker/repo.ts`](worker/repo.ts)). Approving a
|
||||
@@ -135,21 +146,22 @@ Worker. It runs for `wrangler.jsonc` `assets.run_worker_first` (`/`, `/img/*`, `
|
||||
| `/img/<160\|640>/<path>` | [worker/img.ts](worker/img.ts) | Resized WebP covers, stored in R2; only thumbnails that are in the catalog (`/data/urls.json`), upstream fixed to `img.itch.zone` |
|
||||
| `/api/health` | [worker/index.ts](worker/index.ts) | Health check |
|
||||
| `/api/suggest` | [worker/suggest.ts](worker/suggest.ts) | Suggest form: same-origin POST, per-IP rate limit, Turnstile, canonical itch.io URL, note ≤ 500 chars |
|
||||
| `/api/ingest` | [worker/ingest.ts](worker/ingest.ts) | Browser extension: Access service token, `Idempotency-Key`, rate limit per token |
|
||||
| `/api/admin/*` | [worker/admin.ts](worker/admin.ts) | Admin API (queue, add, edit, remove, restore) |
|
||||
| `/api/admin/*` | [worker/admin.ts](worker/admin.ts) | Admin API (queue, check, add, track, edit and remove one or up to 100 games, restore, activity, settings, itch.io collections) |
|
||||
| `/admin`, `/admin/*` | [worker/admin.ts](worker/admin.ts) | Admin app shell, after the Access check |
|
||||
| `/data/*.json` (not `/data/pack/`) | [worker/legacy-data.ts](worker/legacy-data.ts) | The readable catalog JSON, passed only to apps 4.0–4.1.1 (Tauri `Origin`); everyone else gets 410 + the repository links |
|
||||
| anything else | [worker/spa.ts](worker/spa.ts) | App shell for routes, real 404 for missing files (a missing pack too: `no-store`) |
|
||||
|
||||
**Cron** (`23 */4 * * *`, [`worker/discover.ts`](worker/discover.ts)): polls **one** itch.io RSS feed
|
||||
per run into the review queue, then does queue bookkeeping (queued → ingested / failed) and retention
|
||||
(idempotency records after 7 days, Suggest notes after 180). Nothing enters the catalog without the
|
||||
Maintainer's approval.
|
||||
**Cron** (`23 */4 * * *`, [`worker/index.ts`](worker/index.ts)), four steps that fail independently:
|
||||
[`discover.ts`](worker/discover.ts) polls **one** itch.io RSS feed into the review queue; queue
|
||||
bookkeeping settles queued rows with the pipeline's ingest outcomes (queued → ingested / failed);
|
||||
[`automation.ts`](worker/automation.ts) applies the Maintainer's automatic rules (auto-approve of
|
||||
unflagged items after the waiting time, new free games of followed collections, read with
|
||||
[`collections.ts`](worker/collections.ts)) in **one** commit; then retention (Suggest notes after 180
|
||||
days).
|
||||
|
||||
**Bindings**: `ASSETS`, `THUMBS` (R2 `freeitchgames-thumbs`), `DB` (D1 `freeitchgames`),
|
||||
`RL_SUGGEST` / `RL_INGEST` / `RL_GATE` (rate limits). **Vars**: `SITE_ORIGIN`, `GITHUB_REPO`, `BOT_UA`, `GH_APP_ID`,
|
||||
`GH_APP_INSTALLATION_ID`, `ACCESS_TEAM_DOMAIN`, `ACCESS_AUD_ADMIN`, `ACCESS_AUD_INGEST`,
|
||||
`TURNSTILE_SITEKEY`. **Secrets**: `GH_APP_PRIVATE_KEY`, `ADMIN_EMAILS`, `TURNSTILE_SECRET`
|
||||
`RL_SUGGEST` / `RL_GATE` (rate limits). **Vars**: `SITE_ORIGIN`, `GITHUB_REPO`, `BOT_UA`, `GH_APP_ID`,
|
||||
`GH_APP_INSTALLATION_ID`, `ACCESS_TEAM_DOMAIN`, `ACCESS_AUD_ADMIN`, `TURNSTILE_SITEKEY`. **Secrets**: `GH_APP_PRIVATE_KEY`, `ADMIN_EMAILS`, `TURNSTILE_SECRET`
|
||||
(`DEV_ADMIN_EMAIL` is for local runs only). Logs: Workers Observability, 10% head sampling.
|
||||
|
||||
`canonical.ts` and `catalog.ts` are ports of `scripts/canonical.py` and `scripts/data_store.py` +
|
||||
|
||||
@@ -0,0 +1,141 @@
|
||||
import { useState } from 'react'
|
||||
import { useInfiniteQuery } from '@tanstack/react-query'
|
||||
import { Badge } from '@/components/ui/badge'
|
||||
import { Button } from '@/components/ui/button'
|
||||
import { adminApi, shortSha, type AuditRow } from './api'
|
||||
import { errorText, when } from './texts'
|
||||
import { Notice, TabBar } from './ui'
|
||||
|
||||
const FILTERS = {
|
||||
all: { label: 'All', actions: [] },
|
||||
approvals: { label: 'Approvals', actions: ['approve', 'approve_override', 'auto_approve'] },
|
||||
collections: { label: 'Collections', actions: ['collection_add', 'collection_watch', 'collection_unwatch', 'collection_toggle'] },
|
||||
removals: { label: 'Removals', actions: ['delete'] },
|
||||
edits: { label: 'Edits', actions: ['edit'] },
|
||||
rejections: { label: 'Rejections', actions: ['reject'] },
|
||||
other: { label: 'Restores & settings', actions: ['restore', 'settings'] },
|
||||
} as const
|
||||
|
||||
type Filter = keyof typeof FILTERS
|
||||
|
||||
const ACTION: Record<string, string> = {
|
||||
approve: 'approved',
|
||||
approve_override: 'approved (override)',
|
||||
auto_approve: 'auto-approved',
|
||||
collection_add: 'added from a collection',
|
||||
collection_watch: 'followed a collection',
|
||||
collection_unwatch: 'stopped following',
|
||||
collection_toggle: 'switched a collection',
|
||||
delete: 'removed',
|
||||
edit: 'edited',
|
||||
reject: 'rejected',
|
||||
restore: 'restored',
|
||||
settings: 'changed settings',
|
||||
}
|
||||
|
||||
/** The audit log: every admin action and automatic run, with its commit. */
|
||||
export function ActivityPage({ repo }: { repo: string | null }) {
|
||||
const [filter, setFilter] = useState<Filter>('all')
|
||||
const log = useInfiniteQuery({
|
||||
queryKey: ['activity', filter],
|
||||
queryFn: ({ pageParam }) => adminApi.activity({ before: pageParam, actions: [...FILTERS[filter].actions] }),
|
||||
initialPageParam: null as number | null,
|
||||
getNextPageParam: (last) => last.next,
|
||||
})
|
||||
const rows = log.data?.pages.flatMap((p) => p.items) ?? []
|
||||
|
||||
return (
|
||||
<section>
|
||||
<h1 className="mb-3 text-lg font-semibold">Activity</h1>
|
||||
<TabBar
|
||||
label="Kind of action"
|
||||
value={filter}
|
||||
onChange={setFilter}
|
||||
options={(Object.keys(FILTERS) as Filter[]).map((id) => ({ id, label: FILTERS[id].label }))}
|
||||
/>
|
||||
{log.error && <Notice text={errorText(log.error)} tone="error" onClose={() => void log.refetch()} />}
|
||||
{log.isPending && <p className="text-sm text-muted-foreground">Loading…</p>}
|
||||
{log.data && rows.length === 0 && <p className="text-sm text-muted-foreground">Nothing recorded yet.</p>}
|
||||
{rows.length > 0 && (
|
||||
<table className="w-full text-sm">
|
||||
<thead className="border-b text-left text-xs uppercase text-muted-foreground">
|
||||
<tr>
|
||||
<th className="py-2 pr-3">When</th>
|
||||
<th className="py-2 pr-3">Who</th>
|
||||
<th className="py-2 pr-3">What</th>
|
||||
<th className="py-2">Details</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
{rows.map((r) => (
|
||||
<ActivityRow key={r.id} row={r} repo={repo} />
|
||||
))}
|
||||
</tbody>
|
||||
</table>
|
||||
)}
|
||||
{log.hasNextPage && (
|
||||
<Button className="mt-3" variant="outline" size="sm" disabled={log.isFetchingNextPage} onClick={() => void log.fetchNextPage()}>
|
||||
{log.isFetchingNextPage ? 'Loading…' : 'Load older'}
|
||||
</Button>
|
||||
)}
|
||||
</section>
|
||||
)
|
||||
}
|
||||
|
||||
function ActivityRow({ row, repo }: { row: AuditRow; repo: string | null }) {
|
||||
const targets = (row.target ?? '').split(' ').filter(Boolean)
|
||||
const link = (t: string) =>
|
||||
t.startsWith('https://') ? (
|
||||
<a href={t} target="_blank" rel="noreferrer noopener" className="hover:underline">
|
||||
{t.replace('https://', '')}
|
||||
</a>
|
||||
) : (
|
||||
t
|
||||
)
|
||||
return (
|
||||
<tr className="border-b align-top last:border-0">
|
||||
<td className="py-2 pr-3 text-xs whitespace-nowrap text-muted-foreground tabular-nums">{when(row.at)}</td>
|
||||
<td className="max-w-40 truncate py-2 pr-3 text-xs">{row.actor === 'cron' ? 'automatic' : row.actor}</td>
|
||||
<td className="py-2 pr-3">
|
||||
<Badge variant={row.action === 'delete' || row.action === 'reject' ? 'destructive' : 'outline'}>
|
||||
{ACTION[row.action] ?? row.action}
|
||||
</Badge>
|
||||
</td>
|
||||
<td className="py-2 text-xs">
|
||||
{targets.length === 1 && <div className="truncate">{link(targets[0])}</div>}
|
||||
{targets.length > 1 && (
|
||||
<details>
|
||||
<summary className="cursor-pointer">
|
||||
{targets.length} games: {link(targets[0])} …
|
||||
</summary>
|
||||
<ul className="mt-1 max-h-48 overflow-y-auto">
|
||||
{targets.map((t) => (
|
||||
<li key={t} className="truncate">
|
||||
{link(t)}
|
||||
</li>
|
||||
))}
|
||||
</ul>
|
||||
</details>
|
||||
)}
|
||||
{row.detail && <div className="mt-0.5 break-all text-muted-foreground">{row.detail}</div>}
|
||||
{row.commit_sha && (
|
||||
<div className="mt-0.5 text-muted-foreground">
|
||||
commit{' '}
|
||||
{repo ? (
|
||||
<a
|
||||
href={`https://github.com/${repo}/commit/${row.commit_sha}`}
|
||||
target="_blank"
|
||||
rel="noreferrer noopener"
|
||||
className="font-mono hover:underline"
|
||||
>
|
||||
{shortSha(row.commit_sha)}
|
||||
</a>
|
||||
) : (
|
||||
<span className="font-mono">{shortSha(row.commit_sha)}</span>
|
||||
)}
|
||||
</div>
|
||||
)}
|
||||
</td>
|
||||
</tr>
|
||||
)
|
||||
}
|
||||
+459
-64
@@ -1,93 +1,488 @@
|
||||
import { useState } from 'react'
|
||||
import { useMutation, useQueryClient } from '@tanstack/react-query'
|
||||
import { useMemo, useRef, useState, type DragEvent } from 'react'
|
||||
import { useQuery, useQueryClient } from '@tanstack/react-query'
|
||||
import { Button } from '@/components/ui/button'
|
||||
import { adminApi, errorText, shortSha, type AddResult } from './api'
|
||||
import { Notice, PUBLISH_NOTE } from './app'
|
||||
import { Input } from '@/components/ui/input'
|
||||
import { cn } from '@/lib/utils'
|
||||
import { MAX_TRACK_URLS, MAX_URLS } from '../worker/limits'
|
||||
import {
|
||||
adminApi,
|
||||
shortSha,
|
||||
type AddResult,
|
||||
type CheckResult,
|
||||
type CollectionItem,
|
||||
type CollectionRead,
|
||||
type TrackItem,
|
||||
} from './api'
|
||||
import { chunk, runBatches } from './batch'
|
||||
import { GROUPS, groupResults } from './check-groups'
|
||||
import { confirm } from './confirm'
|
||||
import { extractGameUrls } from './extract'
|
||||
import { INGEST_TEXT, PUBLISH_NOTE, errorText, plural, when } from './texts'
|
||||
import { summarize, useTracking, type TrackedBatch } from './tracking'
|
||||
import { BatchProgress, Notice, TabBar, type NoticeState } from './ui'
|
||||
|
||||
const OUTCOME: Record<string, string> = {
|
||||
queued: 'new',
|
||||
invalid_url: 'not an itch.io game URL',
|
||||
duplicate_in_request: 'listed twice',
|
||||
duplicate_catalog: 'already in the catalog',
|
||||
duplicate_pending: 'already in the queue',
|
||||
previously_deleted: 'removed before',
|
||||
rejected: 'rejected before',
|
||||
const MAX_FILE_BYTES = 5 * 1024 * 1024
|
||||
/** One ingest run (45 minutes at ≈ 14.5 games a minute) handles about this many games. */
|
||||
const PER_INGEST_RUN = 650
|
||||
|
||||
type Source = 'paste' | 'collection'
|
||||
|
||||
interface Collected {
|
||||
read: CollectionRead['collection']
|
||||
free: CollectionItem[]
|
||||
priced: number
|
||||
pages: number
|
||||
nextPage: number | null
|
||||
stopped?: string
|
||||
}
|
||||
|
||||
export function AddPage() {
|
||||
const [source, setSource] = useState<Source>('paste')
|
||||
const [text, setText] = useState('')
|
||||
const [override, setOverride] = useState(false)
|
||||
const [result, setResult] = useState<AddResult | null>(null)
|
||||
const [error, setError] = useState<string | null>(null)
|
||||
const [collected, setCollected] = useState<Collected | null>(null)
|
||||
const [checked, setChecked] = useState<{ key: string; results: CheckResult[] } | null>(null)
|
||||
const [withRemoved, setWithRemoved] = useState(false)
|
||||
const [withRejected, setWithRejected] = useState(false)
|
||||
const [progress, setProgress] = useState<{ label: string; done: number; total: number } | null>(null)
|
||||
const [notice, setNotice] = useState<NoticeState>(null)
|
||||
const client = useQueryClient()
|
||||
const urls = text
|
||||
.split(/\s+/)
|
||||
.map((u) => u.trim())
|
||||
.filter(Boolean)
|
||||
const track = useTracking((s) => s.track)
|
||||
|
||||
const add = useMutation({
|
||||
mutationFn: () => adminApi.add(urls, override),
|
||||
onSuccess: (r) => {
|
||||
setResult(r)
|
||||
setError(null)
|
||||
if (r.results.some((x) => x.approved)) setText('')
|
||||
void client.invalidateQueries({ queryKey: ['queue'] })
|
||||
},
|
||||
onError: (e) => setError(errorText(e)),
|
||||
})
|
||||
const pasted = useMemo(() => extractGameUrls(text), [text])
|
||||
const urls = source === 'paste' ? pasted.urls : (collected?.free.map((i) => i.url) ?? [])
|
||||
const via = source === 'collection' && collected ? `collection:${collected.read.id}` : undefined
|
||||
const key = `${source}\n${urls.join('\n')}`
|
||||
const results = checked?.key === key ? checked.results : null
|
||||
const groups = useMemo(() => (results ? groupResults(results) : null), [results])
|
||||
const busy = progress !== null
|
||||
|
||||
const check = async () => {
|
||||
setNotice(null)
|
||||
const run = await runBatches(
|
||||
chunk(urls, MAX_URLS),
|
||||
(batch) => adminApi.check(batch),
|
||||
(done, total) => setProgress({ label: 'Checking', done, total }),
|
||||
)
|
||||
setProgress(null)
|
||||
if (run.failed) setNotice({ tone: 'error', text: errorText(run.failed.error) })
|
||||
else setChecked({ key, results: run.results.flatMap((r) => r.results) })
|
||||
}
|
||||
|
||||
const add = async () => {
|
||||
if (!groups) return
|
||||
const normal = [...groups.new, ...groups.waiting]
|
||||
const override = [...(withRemoved ? groups.removed : []), ...(withRejected ? groups.rejected : [])]
|
||||
const total = normal.length + override.length
|
||||
if (total > 1000) {
|
||||
const runs = Math.ceil(total / PER_INGEST_RUN)
|
||||
const ok = await confirm({
|
||||
title: `Queue ${plural(total, 'game')}?`,
|
||||
body: `The ingest workflow handles about ${PER_INGEST_RUN} games per run, so this takes about ${runs} runs (45 minutes each); the rest waits in the queue meanwhile.`,
|
||||
action: `Queue ${plural(total, 'game')}`,
|
||||
})
|
||||
if (!ok) return
|
||||
}
|
||||
setNotice(null)
|
||||
const batches = [
|
||||
...chunk(normal, MAX_URLS).map((b) => ({ urls: b, override: false })),
|
||||
...chunk(override, MAX_URLS).map((b) => ({ urls: b, override: true })),
|
||||
]
|
||||
const run = await runBatches(
|
||||
batches.map((b) => [b]),
|
||||
([b]) => adminApi.add(b.urls, b.override, via),
|
||||
(done, all) => setProgress({ label: 'Adding', done, total: all }),
|
||||
)
|
||||
setProgress(null)
|
||||
const done: AddResult[] = run.results
|
||||
const queued = done.flatMap((r) => r.results.filter((x) => x.approved && x.url).map((x) => x.url as string))
|
||||
if (queued.length > 0 && done[0]) {
|
||||
const label = via ? `Collection #${collected?.read.id}: ${plural(queued.length, 'game')}` : `Add: ${plural(queued.length, 'game')}`
|
||||
track(label, done[0].at, queued)
|
||||
}
|
||||
const commits = done.map((r) => shortSha(r.sha)).filter((s) => s !== 'no commit')
|
||||
const lines: string[] = []
|
||||
if (queued.length > 0 || !run.failed) {
|
||||
lines.push(
|
||||
`Queued ${plural(queued.length, 'game')} for ingest${commits.length ? ` (${commits.join(', ')})` : ''}. Follow them under “Recent batches”. ${PUBLISH_NOTE}`,
|
||||
)
|
||||
}
|
||||
if (run.failed) {
|
||||
lines.push(errorText(run.failed.error))
|
||||
lines.push(
|
||||
`${plural(run.remaining.flat().reduce((n, b) => n + b.urls.length, 0), 'game')} not sent: Check again, then Add sends what is left.`,
|
||||
)
|
||||
}
|
||||
setNotice({ tone: run.failed ? 'error' : 'info', text: lines.join('\n') })
|
||||
if (!run.failed) {
|
||||
setChecked(null)
|
||||
if (source === 'paste') setText('')
|
||||
else setCollected(null)
|
||||
} else {
|
||||
// Re-check what is left, so a second Add sends only that.
|
||||
setChecked(null)
|
||||
}
|
||||
void client.invalidateQueries({ queryKey: ['queue'] })
|
||||
}
|
||||
|
||||
const addable = groups ? groups.new.length + groups.waiting.length : 0
|
||||
const overridable = groups ? (withRemoved ? groups.removed.length : 0) + (withRejected ? groups.rejected.length : 0) : 0
|
||||
|
||||
return (
|
||||
<section className="max-w-3xl">
|
||||
<section className="max-w-4xl">
|
||||
<h1 className="mb-1 text-lg font-semibold">Add games</h1>
|
||||
<p className="mb-3 text-sm text-muted-foreground">
|
||||
Paste itch.io game URLs (one per line, up to 200). New ones are approved right away and scraped by the
|
||||
ingest workflow; paid games are dropped there.
|
||||
Paste or upload any list (plain links, Markdown, CSV, HTML, JSON), or read an itch.io collection. Check it
|
||||
first: new games are queued for the ingest workflow, which drops the ones that turn out to be paid.
|
||||
</p>
|
||||
|
||||
<TabBar
|
||||
label="Where the list comes from"
|
||||
value={source}
|
||||
onChange={setSource}
|
||||
options={[
|
||||
{ id: 'paste', label: 'Paste or upload' },
|
||||
{ id: 'collection', label: 'itch.io collection' },
|
||||
]}
|
||||
/>
|
||||
|
||||
{source === 'paste' ? (
|
||||
<PasteInput text={text} onText={setText} found={pasted.urls.length} repeats={pasted.duplicates} onError={setNotice} />
|
||||
) : (
|
||||
<CollectionInput collected={collected} onCollected={setCollected} onError={setNotice} />
|
||||
)}
|
||||
|
||||
{notice && (
|
||||
<div className="mt-4">
|
||||
<Notice text={notice.text} tone={notice.tone} onClose={() => setNotice(null)} />
|
||||
</div>
|
||||
)}
|
||||
{progress && <BatchProgress label={progress.label} done={progress.done} total={progress.total} />}
|
||||
|
||||
<div className="mt-3 flex flex-wrap items-center gap-3 text-sm">
|
||||
<Button variant="outline" disabled={urls.length === 0 || busy} onClick={() => void check()}>
|
||||
{busy && progress?.label === 'Checking' ? 'Checking…' : `Check ${urls.length ? plural(urls.length, 'URL') : ''}`}
|
||||
</Button>
|
||||
{groups && (
|
||||
<Button disabled={addable + overridable === 0 || busy} onClick={() => void add()}>
|
||||
{busy && progress?.label === 'Adding' ? 'Adding…' : `Add ${plural(addable + overridable, 'game')}`}
|
||||
</Button>
|
||||
)}
|
||||
{urls.length > 0 && !groups && <span className="text-muted-foreground">Check the list to see what Add would do.</span>}
|
||||
</div>
|
||||
|
||||
{groups && (
|
||||
<div className="mt-4 space-y-2">
|
||||
{GROUPS.filter((g) => groups[g.id].length > 0).map((g) => (
|
||||
<details key={g.id} className="rounded-md border px-3 py-2 text-sm" open={g.id === 'new' && groups.new.length <= 20}>
|
||||
<summary className="flex cursor-pointer flex-wrap items-center gap-2">
|
||||
<span className="font-medium">{g.label}</span>
|
||||
<span className="tabular-nums text-muted-foreground">{groups[g.id].length.toLocaleString('en-GB')}</span>
|
||||
<span className="text-xs text-muted-foreground">{g.hint}</span>
|
||||
{g.id === 'removed' && (
|
||||
<label className="ml-auto flex items-center gap-2" onClick={(e) => e.stopPropagation()}>
|
||||
<input type="checkbox" checked={withRemoved} onChange={(e) => setWithRemoved(e.target.checked)} />
|
||||
Add with override
|
||||
</label>
|
||||
)}
|
||||
{g.id === 'rejected' && (
|
||||
<label className="ml-auto flex items-center gap-2" onClick={(e) => e.stopPropagation()}>
|
||||
<input type="checkbox" checked={withRejected} onChange={(e) => setWithRejected(e.target.checked)} />
|
||||
Add with override
|
||||
</label>
|
||||
)}
|
||||
</summary>
|
||||
<ul className="mt-2 max-h-60 overflow-y-auto font-mono text-xs">
|
||||
{groups[g.id].map((u) => (
|
||||
<li key={u} className="truncate py-0.5">
|
||||
{u}
|
||||
</li>
|
||||
))}
|
||||
</ul>
|
||||
</details>
|
||||
))}
|
||||
</div>
|
||||
)}
|
||||
|
||||
<RecentBatches />
|
||||
</section>
|
||||
)
|
||||
}
|
||||
|
||||
function PasteInput({
|
||||
text,
|
||||
onText,
|
||||
found,
|
||||
repeats,
|
||||
onError,
|
||||
}: {
|
||||
text: string
|
||||
onText: (text: string) => void
|
||||
found: number
|
||||
repeats: number
|
||||
onError: (n: NoticeState) => void
|
||||
}) {
|
||||
const file = useRef<HTMLInputElement>(null)
|
||||
const [dragging, setDragging] = useState(false)
|
||||
|
||||
const load = async (files: FileList | null) => {
|
||||
const picked = files?.[0]
|
||||
if (!picked) return
|
||||
if (picked.size > MAX_FILE_BYTES) {
|
||||
onError({ tone: 'error', text: `${picked.name} is larger than 5 MB.` })
|
||||
return
|
||||
}
|
||||
const content = await picked.text()
|
||||
onText(text ? `${text}\n${content}` : content)
|
||||
}
|
||||
const drop = (e: DragEvent) => {
|
||||
e.preventDefault()
|
||||
setDragging(false)
|
||||
void load(e.dataTransfer.files)
|
||||
}
|
||||
|
||||
return (
|
||||
<div>
|
||||
<label htmlFor="urls" className="sr-only">
|
||||
Game URLs
|
||||
Game URLs or any text containing them
|
||||
</label>
|
||||
<textarea
|
||||
id="urls"
|
||||
value={text}
|
||||
onChange={(e) => setText(e.target.value)}
|
||||
onChange={(e) => onText(e.target.value)}
|
||||
onDragOver={(e) => {
|
||||
e.preventDefault()
|
||||
setDragging(true)
|
||||
}}
|
||||
onDragLeave={() => setDragging(false)}
|
||||
onDrop={drop}
|
||||
rows={8}
|
||||
spellCheck={false}
|
||||
placeholder="https://creator.itch.io/game"
|
||||
className="w-full rounded-md border bg-background p-2 font-mono text-sm"
|
||||
placeholder="https://creator.itch.io/game — or drop a .txt / .csv / .md / .html / .json file here"
|
||||
className={cn('w-full rounded-md border bg-background p-2 font-mono text-sm', dragging && 'border-primary ring-2 ring-primary/30')}
|
||||
/>
|
||||
<div className="mt-2 flex flex-wrap items-center gap-4 text-sm">
|
||||
<label className="flex items-center gap-2">
|
||||
<input type="checkbox" checked={override} onChange={(e) => setOverride(e.target.checked)} />
|
||||
Override: also bring back removed or rejected games
|
||||
</label>
|
||||
<Button className="ml-auto" disabled={!urls.length || urls.length > 200 || add.isPending} onClick={() => add.mutate()}>
|
||||
{add.isPending ? 'Adding…' : `Add ${urls.length || ''}`}
|
||||
<div className="mt-1 flex flex-wrap items-center gap-3 text-sm">
|
||||
<span className="text-muted-foreground">
|
||||
{found ? `${plural(found, 'game URL')} found` : 'No itch.io game URL yet'}
|
||||
{repeats > 0 && ` (${plural(repeats, 'repeat')} ignored)`}
|
||||
</span>
|
||||
<input
|
||||
ref={file}
|
||||
type="file"
|
||||
accept=".txt,.csv,.md,.html,.htm,.json,text/plain,text/csv,text/markdown,text/html,application/json"
|
||||
className="hidden"
|
||||
onChange={(e) => {
|
||||
void load(e.target.files)
|
||||
e.target.value = ''
|
||||
}}
|
||||
/>
|
||||
<Button size="sm" variant="ghost" onClick={() => file.current?.click()}>
|
||||
Load a file…
|
||||
</Button>
|
||||
{text && (
|
||||
<Button size="sm" variant="ghost" onClick={() => onText('')}>
|
||||
Clear
|
||||
</Button>
|
||||
)}
|
||||
</div>
|
||||
</div>
|
||||
)
|
||||
}
|
||||
|
||||
{error && (
|
||||
<div className="mt-4">
|
||||
<Notice text={error} tone="error" onClose={() => setError(null)} />
|
||||
function CollectionInput({
|
||||
collected,
|
||||
onCollected,
|
||||
onError,
|
||||
}: {
|
||||
collected: Collected | null
|
||||
onCollected: (c: Collected | null) => void
|
||||
onError: (n: NoticeState) => void
|
||||
}) {
|
||||
const [url, setUrl] = useState('')
|
||||
const [reading, setReading] = useState(false)
|
||||
const [watching, setWatching] = useState(false)
|
||||
const stop = useRef(false)
|
||||
const client = useQueryClient()
|
||||
|
||||
/** Ten pages per request, until the end of the collection or Stop. */
|
||||
const read = async () => {
|
||||
stop.current = false
|
||||
setReading(true)
|
||||
onError(null)
|
||||
let page = 1
|
||||
let free: CollectionItem[] = []
|
||||
const seen = new Set<string>()
|
||||
let priced = 0
|
||||
let pages = 0
|
||||
try {
|
||||
for (;;) {
|
||||
const r = await adminApi.readCollection(url, page)
|
||||
const fresh = r.items.filter((i) => i.price === null && !seen.has(i.url))
|
||||
for (const i of fresh) seen.add(i.url)
|
||||
free = [...free, ...fresh]
|
||||
priced += r.items.filter((i) => i.price !== null).length
|
||||
pages += r.pages
|
||||
onCollected({ read: r.collection, free, priced, pages, nextPage: r.nextPage, stopped: r.stopped })
|
||||
if (r.nextPage === null || r.stopped || stop.current) break
|
||||
page = r.nextPage
|
||||
}
|
||||
} catch (e) {
|
||||
onError({ tone: 'error', text: errorText(e) })
|
||||
} finally {
|
||||
setReading(false)
|
||||
}
|
||||
}
|
||||
|
||||
const watch = async () => {
|
||||
setWatching(true)
|
||||
try {
|
||||
const { collection } = await adminApi.watch(collected?.read.url ?? url)
|
||||
onError({ tone: 'info', text: `Following collection #${collection.id}: the cron queues its new free games (Settings lists it).` })
|
||||
void client.invalidateQueries({ queryKey: ['settings'] })
|
||||
} catch (e) {
|
||||
onError({ tone: 'error', text: errorText(e) })
|
||||
} finally {
|
||||
setWatching(false)
|
||||
}
|
||||
}
|
||||
|
||||
return (
|
||||
<div className="space-y-2 text-sm">
|
||||
<div className="flex flex-wrap gap-2">
|
||||
<Input
|
||||
value={url}
|
||||
onChange={(e) => setUrl(e.target.value)}
|
||||
placeholder="https://itch.io/c/1234567/collection-name"
|
||||
aria-label="itch.io collection URL"
|
||||
className="max-w-xl flex-1"
|
||||
/>
|
||||
{reading ? (
|
||||
<Button variant="outline" onClick={() => (stop.current = true)}>
|
||||
Stop
|
||||
</Button>
|
||||
) : (
|
||||
<Button variant="outline" disabled={!url.trim()} onClick={() => void read()}>
|
||||
Read collection
|
||||
</Button>
|
||||
)}
|
||||
</div>
|
||||
{collected && (
|
||||
<div className="flex flex-wrap items-center gap-3 text-muted-foreground">
|
||||
<span>
|
||||
<a href={collected.read.url} target="_blank" rel="noreferrer noopener" className="font-medium text-foreground hover:underline">
|
||||
Collection #{collected.read.id}
|
||||
</a>
|
||||
: {plural(collected.free.length, 'free game')} from {plural(collected.pages, 'page')}
|
||||
{collected.priced > 0 && ` (${plural(collected.priced, 'priced game')} skipped)`}
|
||||
{reading && ' — reading…'}
|
||||
{!reading && collected.nextPage !== null && ' — stopped before the end'}
|
||||
{collected.stopped && ` — itch.io: ${collected.stopped.replace(/_/g, ' ')}`}
|
||||
</span>
|
||||
<Button size="sm" variant="ghost" disabled={watching} onClick={() => void watch()}>
|
||||
Follow this collection
|
||||
</Button>
|
||||
</div>
|
||||
)}
|
||||
{result && (
|
||||
<div className="mt-6">
|
||||
<p className="mb-2 text-sm">
|
||||
{result.results.filter((r) => r.approved).length} queued for ingest ({shortSha(result.sha)}). {PUBLISH_NOTE}
|
||||
</p>
|
||||
<table className="w-full text-sm">
|
||||
<tbody>
|
||||
{result.results.map((r, i) => (
|
||||
<tr key={`${r.input}-${i}`} className="border-b last:border-0">
|
||||
<td className="py-1.5 font-mono text-xs">{r.url ?? r.input}</td>
|
||||
<td className="py-1.5 text-muted-foreground">{OUTCOME[r.outcome] ?? r.outcome}</td>
|
||||
<td className="py-1.5">{r.approved ? 'queued' : r.reason ? r.reason.replace(/_/g, ' ') : '—'}</td>
|
||||
</tr>
|
||||
))}
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
</div>
|
||||
)
|
||||
}
|
||||
|
||||
const STATE_TEXT: Record<TrackItem['state'], string> = {
|
||||
waiting: 'waiting for the ingest',
|
||||
added: 'added',
|
||||
dropped: 'not added',
|
||||
unknown: 'unknown',
|
||||
}
|
||||
|
||||
/** The batches queued from this browser, and how each game's ingest went. */
|
||||
function RecentBatches() {
|
||||
const batches = useTracking((s) => s.batches)
|
||||
if (batches.length === 0) return null
|
||||
return (
|
||||
<div className="mt-8">
|
||||
<h2 className="mb-2 text-base font-semibold">Recent batches</h2>
|
||||
<p className="mb-3 text-xs text-muted-foreground">
|
||||
Queued from this browser. The ingest workflow starts right after each commit; results show up here as it
|
||||
finishes (checked every minute while something is waiting).
|
||||
</p>
|
||||
<div className="space-y-2">
|
||||
{batches.map((b, i) => (
|
||||
<BatchCard key={b.id} batch={b} live={i < 3} />
|
||||
))}
|
||||
</div>
|
||||
</div>
|
||||
)
|
||||
}
|
||||
|
||||
async function trackAll(batch: TrackedBatch): Promise<TrackItem[]> {
|
||||
const items: TrackItem[] = []
|
||||
for (const part of chunk(batch.urls, MAX_TRACK_URLS)) items.push(...(await adminApi.track(part, batch.at)).items)
|
||||
return items
|
||||
}
|
||||
|
||||
function BatchCard({ batch, live }: { batch: TrackedBatch; live: boolean }) {
|
||||
const [open, setOpen] = useState(false)
|
||||
const forget = useTracking((s) => s.forget)
|
||||
const status = useQuery({
|
||||
queryKey: ['track', batch.id],
|
||||
queryFn: () => trackAll(batch),
|
||||
enabled: live || open,
|
||||
refetchInterval: (q) => (q.state.data?.some((i) => i.state === 'waiting') ? 60_000 : false),
|
||||
refetchIntervalInBackground: false,
|
||||
})
|
||||
const sum = status.data ? summarize(status.data) : null
|
||||
return (
|
||||
<details className="rounded-md border px-3 py-2 text-sm" onToggle={(e) => setOpen(e.currentTarget.open)}>
|
||||
<summary className="flex cursor-pointer flex-wrap items-center gap-x-3 gap-y-1">
|
||||
<span className="font-medium">{batch.label}</span>
|
||||
<span className="text-xs text-muted-foreground">{when(batch.at)}</span>
|
||||
{sum && (
|
||||
<span className="text-xs tabular-nums">
|
||||
<span className="text-success">{sum.added} added</span>
|
||||
{sum.waiting > 0 && <span className="text-muted-foreground"> · {sum.waiting} waiting</span>}
|
||||
{sum.dropped > 0 && <span className="text-destructive"> · {sum.dropped} not added</span>}
|
||||
{sum.unknown > 0 && <span className="text-muted-foreground"> · {sum.unknown} unknown</span>}
|
||||
</span>
|
||||
)}
|
||||
{status.isFetching && <span className="text-xs text-muted-foreground">checking…</span>}
|
||||
{status.error && <span className="text-xs text-destructive">{errorText(status.error).split('\n')[0]}</span>}
|
||||
<button
|
||||
className="ml-auto text-xs text-muted-foreground underline-offset-4 hover:underline"
|
||||
onClick={(e) => {
|
||||
e.preventDefault()
|
||||
void status.refetch()
|
||||
}}
|
||||
>
|
||||
Check now
|
||||
</button>
|
||||
<button
|
||||
className="text-xs text-muted-foreground underline-offset-4 hover:underline"
|
||||
onClick={(e) => {
|
||||
e.preventDefault()
|
||||
forget(batch.id)
|
||||
}}
|
||||
>
|
||||
Forget
|
||||
</button>
|
||||
</summary>
|
||||
{status.data && (
|
||||
<table className="mt-2 w-full text-xs">
|
||||
<tbody>
|
||||
{status.data.map((i) => (
|
||||
<tr key={i.url} className="border-b last:border-0">
|
||||
<td className="max-w-0 truncate py-1 pr-2 font-mono">
|
||||
<a href={i.url} target="_blank" rel="noreferrer noopener" className="hover:underline">
|
||||
{i.url.replace('https://', '')}
|
||||
</a>
|
||||
</td>
|
||||
<td className="py-1 whitespace-nowrap text-muted-foreground">
|
||||
{i.outcome ? (INGEST_TEXT[i.outcome] ?? i.outcome) : STATE_TEXT[i.state]}
|
||||
{i.attempts ? ` (${plural(i.attempts, 'failed attempt')}: ${i.error ?? ''})` : ''}
|
||||
</td>
|
||||
</tr>
|
||||
))}
|
||||
</tbody>
|
||||
</table>
|
||||
)}
|
||||
</section>
|
||||
</details>
|
||||
)
|
||||
}
|
||||
+145
-31
@@ -11,7 +11,7 @@ export class SessionExpired extends Error {
|
||||
}
|
||||
}
|
||||
|
||||
class ApiError extends Error {
|
||||
export class ApiError extends Error {
|
||||
readonly status: number
|
||||
readonly code: string
|
||||
|
||||
@@ -42,13 +42,18 @@ export function isSessionExpired(): boolean {
|
||||
}
|
||||
|
||||
async function api<T>(method: string, path: string, body?: unknown): Promise<T> {
|
||||
const res = await fetch(path, {
|
||||
method,
|
||||
credentials: 'same-origin',
|
||||
redirect: 'manual',
|
||||
headers: body === undefined ? undefined : { 'Content-Type': 'application/json' },
|
||||
body: body === undefined ? undefined : JSON.stringify(body),
|
||||
})
|
||||
let res: Response
|
||||
try {
|
||||
res = await fetch(path, {
|
||||
method,
|
||||
credentials: 'same-origin',
|
||||
redirect: 'manual',
|
||||
headers: body === undefined ? undefined : { 'Content-Type': 'application/json' },
|
||||
body: body === undefined ? undefined : JSON.stringify(body),
|
||||
})
|
||||
} catch {
|
||||
throw new ApiError(0, 'network_error')
|
||||
}
|
||||
if (res.type === 'opaqueredirect' || res.status === 401) throw new SessionExpired()
|
||||
const data = (await res.json().catch(() => ({}))) as { error?: string; message?: string }
|
||||
if (!res.ok) throw new ApiError(res.status, data.error ?? `http_${res.status}`, data.message)
|
||||
@@ -56,10 +61,11 @@ async function api<T>(method: string, path: string, body?: unknown): Promise<T>
|
||||
}
|
||||
|
||||
export type CandidateStatus = 'pending' | 'rejected' | 'queued' | 'ingested' | 'failed'
|
||||
export type CandidateSource = 'rss' | 'form' | 'admin'
|
||||
|
||||
export interface Candidate {
|
||||
url: string
|
||||
source: 'rss' | 'form' | 'ext' | 'admin'
|
||||
source: CandidateSource
|
||||
status: CandidateStatus
|
||||
title: string | null
|
||||
image_url: string | null
|
||||
@@ -69,57 +75,165 @@ export interface Candidate {
|
||||
submitter: string | null
|
||||
discovered_at: string
|
||||
decided_at: string | null
|
||||
decided_by: string | null
|
||||
/** How the last ingest ended (added, paid, dead, private, …, timeout). */
|
||||
outcome: string | null
|
||||
outcome_at: string | null
|
||||
}
|
||||
|
||||
export interface Me {
|
||||
email: string
|
||||
writes: boolean
|
||||
/** "owner/name" of the data repository, for commit links. */
|
||||
repo: string | null
|
||||
}
|
||||
|
||||
export interface Decision {
|
||||
sha: string | null
|
||||
approved: string[]
|
||||
skipped: { url: string; reason: string }[]
|
||||
at: string
|
||||
}
|
||||
|
||||
export interface CheckResult {
|
||||
input: string
|
||||
url: string | null
|
||||
outcome: string
|
||||
/** The queue status of a URL the queue already knows. */
|
||||
status: CandidateStatus | null
|
||||
reason?: string
|
||||
}
|
||||
|
||||
export interface AddResult {
|
||||
sha: string | null
|
||||
at: string
|
||||
results: { input: string; url: string | null; outcome: string; approved: boolean; reason?: string }[]
|
||||
}
|
||||
|
||||
export interface TrackItem {
|
||||
url: string
|
||||
state: 'waiting' | 'added' | 'dropped' | 'unknown'
|
||||
outcome?: string
|
||||
at?: string
|
||||
attempts?: number
|
||||
error?: string | null
|
||||
}
|
||||
|
||||
export type GameEdit = Partial<Record<'safe_virus' | 'nsfw' | 'notes', string>>
|
||||
|
||||
export interface RemoveResult {
|
||||
sha: string | null
|
||||
removed: string[]
|
||||
notFound: string[]
|
||||
invalid: string[]
|
||||
covers: { deleted: number; failed: number }
|
||||
warnings: string[]
|
||||
}
|
||||
|
||||
export interface BulkEditResult {
|
||||
sha: string | null
|
||||
edited: string[]
|
||||
unchanged: string[]
|
||||
notFound: string[]
|
||||
}
|
||||
|
||||
export interface AuditRow {
|
||||
id: number
|
||||
at: string
|
||||
actor: string
|
||||
action: string
|
||||
target: string | null
|
||||
commit_sha: string | null
|
||||
detail: string | null
|
||||
}
|
||||
|
||||
export interface Automation {
|
||||
enabled: boolean
|
||||
sources: CandidateSource[]
|
||||
hours: number
|
||||
since: string
|
||||
}
|
||||
|
||||
interface LastRun {
|
||||
at: string
|
||||
approved: number
|
||||
added: number
|
||||
review: number
|
||||
duplicates: number
|
||||
pages: number
|
||||
sha: string | null
|
||||
errors: string[]
|
||||
collections: { id: string; status: number | null; found: number; added: number; next_page: number }[]
|
||||
}
|
||||
|
||||
export interface WatchedCollection {
|
||||
id: string
|
||||
slug: string
|
||||
enabled: number
|
||||
added_at: string
|
||||
last_polled_at: string | null
|
||||
last_status: number | null
|
||||
backoff_until: string | null
|
||||
next_page: number
|
||||
last_found: number | null
|
||||
last_added: number | null
|
||||
}
|
||||
|
||||
export interface SettingsData {
|
||||
automation: Automation
|
||||
lastRun: LastRun | null
|
||||
collections: WatchedCollection[]
|
||||
writes: boolean
|
||||
}
|
||||
|
||||
export interface CollectionItem {
|
||||
url: string
|
||||
title: string
|
||||
image: string | null
|
||||
genre: string | null
|
||||
price: string | null
|
||||
}
|
||||
|
||||
export interface CollectionRead {
|
||||
collection: { id: string; slug: string; url: string }
|
||||
items: CollectionItem[]
|
||||
pages: number
|
||||
nextPage: number | null
|
||||
/** Set when the read stopped early on an error, after some pages. */
|
||||
stopped?: string
|
||||
}
|
||||
|
||||
export const adminApi = {
|
||||
me: () => api<Me>('GET', '/api/admin/me'),
|
||||
queue: (status: CandidateStatus) =>
|
||||
api<{ counts: Record<CandidateStatus, number>; items: Candidate[] }>(
|
||||
'GET',
|
||||
`/api/admin/queue?status=${status}&limit=500`,
|
||||
),
|
||||
api<{ counts: Record<CandidateStatus, number>; items: Candidate[] }>('GET', `/api/admin/queue?status=${status}&limit=500`),
|
||||
approve: (urls: string[], override: boolean) =>
|
||||
api<Decision>('POST', '/api/admin/queue/decide', { action: 'approve', urls, override }),
|
||||
reject: (urls: string[]) => api<{ rejected: string[] }>('POST', '/api/admin/queue/decide', { action: 'reject', urls }),
|
||||
add: (urls: string[], override: boolean) => api<AddResult>('POST', '/api/admin/add', { urls, override }),
|
||||
check: (urls: string[]) => api<{ results: CheckResult[] }>('POST', '/api/admin/check', { urls }),
|
||||
add: (urls: string[], override: boolean, via?: string) =>
|
||||
api<AddResult>('POST', '/api/admin/add', { urls, override, ...(via ? { via } : {}) }),
|
||||
track: (urls: string[], since: string) => api<{ head: string; items: TrackItem[] }>('POST', '/api/admin/track', { urls, since }),
|
||||
edit: (url: string, edit: GameEdit) => api<{ sha: string | null; edited: number }>('PATCH', '/api/admin/games', { url, edit }),
|
||||
remove: (url: string, reason: string) =>
|
||||
api<{ sha: string | null; removed: number }>('DELETE', '/api/admin/games', { url, reason }),
|
||||
restore: (url: string) => api<{ sha: string | null; queued: boolean }>('POST', '/api/admin/games/restore', { url }),
|
||||
editMany: (edits: { url: string; edit: GameEdit }[]) => api<BulkEditResult>('PATCH', '/api/admin/games/bulk', { edits }),
|
||||
removeMany: (urls: string[], reason: string) => api<RemoveResult>('POST', '/api/admin/games/remove', { urls, reason }),
|
||||
restore: (url: string) => api<{ sha: string | null; queued: boolean; at: string }>('POST', '/api/admin/games/restore', { url }),
|
||||
activity: (params: { before?: number | null; actions?: string[] }) => {
|
||||
const q = new URLSearchParams({ limit: '50' })
|
||||
if (params.before) q.set('before', String(params.before))
|
||||
if (params.actions?.length) q.set('actions', params.actions.join(','))
|
||||
return api<{ items: AuditRow[]; next: number | null }>('GET', `/api/admin/activity?${q}`)
|
||||
},
|
||||
settings: () => api<SettingsData>('GET', '/api/admin/settings'),
|
||||
saveAutomation: (automation: Omit<Automation, 'since'> & { includeOlder?: boolean }) =>
|
||||
api<{ automation: Automation }>('PUT', '/api/admin/settings', { automation }),
|
||||
readCollection: (url: string, page: number) => api<CollectionRead>('POST', '/api/admin/collections/read', { url, page }),
|
||||
watch: (url: string) => api<{ collection: WatchedCollection }>('POST', '/api/admin/collections', { url }),
|
||||
toggleCollection: (id: string, enabled: boolean) =>
|
||||
api<{ collection: WatchedCollection }>('PATCH', '/api/admin/collections', { id, enabled }),
|
||||
unwatch: (id: string) => api<{ removed: boolean }>('DELETE', '/api/admin/collections', { id }),
|
||||
}
|
||||
|
||||
export function shortSha(sha: string | null): string {
|
||||
return sha ? sha.slice(0, 7) : 'no commit'
|
||||
}
|
||||
|
||||
export function errorText(e: unknown): string {
|
||||
if (e instanceof SessionExpired) return e.message
|
||||
if (e instanceof ApiError) {
|
||||
const known: Record<string, string> = {
|
||||
forbidden: 'This account is not allowed to use the admin.',
|
||||
not_configured: 'The admin is not configured yet (Cloudflare Access / D1).',
|
||||
github_not_configured: 'Writes are off: the GitHub App is not configured.',
|
||||
needs_override: 'Previously removed — approve with override.',
|
||||
}
|
||||
return known[e.code] ?? e.message
|
||||
}
|
||||
return e instanceof Error ? e.message : String(e)
|
||||
}
|
||||
Loaded 100 of 260 files, more files were not shown because too many files have changed in this diff.
Show more
Reference in new issue
Block a user