Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file modified .polygo-launch-shots/02-review.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ All notable changes to polygo. Versions follow [SemVer](https://semver.org); dat

## Unreleased

- The GitHub App is [polygolint](https://github.com/apps/polygolint): `polygo` was taken by a dormant account, and app names share the username namespace. The bot comments as `polygolint[bot]`. The crate, binary, container and Cloud Run service keep the name `polygo-bot` — they are internal, and the service URL is wired into the app's webhook.

- The README leads with the bot: what lands on a pull request, then the three ways to run it (install the app, four lines of CI, or the binary), each of them needing no configuration. `docs/img/review-comment-{light,dark}.svg` is the review as it appears on a pull request.

- The bot notes Marketplace events (`marketplace_purchase`) in its log rather than treating them as a malformed pull request; a listed app has to receive them. `bot/PRIVACY.md` is the App's privacy policy, which a Marketplace listing requires and anyone installing it deserves; `docs/img/feature-card.svg` is the listing's card.
Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
<p align="center">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="docs/img/review-comment-dark.svg">
<img src="docs/img/review-comment-light.svg" width="860" alt="polygo-bot commenting on a pull request: the placeholder name {{user}} was translated to {{usuario}}, with a suggested change and an Apply suggestion button">
<img src="docs/img/review-comment-light.svg" width="860" alt="polygolint commenting on a pull request: the placeholder name {{user}} was translated to {{usuario}}, with a suggested change and an Apply suggestion button">
</picture>
</p>

Expand All @@ -34,7 +34,7 @@

## Three ways to run it, none of which need configuring

**On every pull request** — [**install polygo-bot**](https://github.com/apps/polygo-bot) on a repository and stop. It reviews the pull requests that touch translation files, comments on the lines that broke, and leaves a committable suggestion where the fix is mechanical. It never blocks a pull request, and it says a thing only once.
**On every pull request** — [**install polygolint**](https://github.com/apps/polygolint) on a repository and stop. It reviews the pull requests that touch translation files, comments on the lines that broke, and leaves a committable suggestion where the fix is mechanical. It never blocks a pull request, and it says a thing only once.

**In your own CI**, if you would rather not install an app — the same review, posted by your own workflow with the repository's token, nothing leaving the runner:

Expand Down Expand Up @@ -116,7 +116,7 @@ It ends with the coverage per locale. A translated placeholder name is the one b

`sarif: "true"` also files them in GitHub's Security tab with new/fixed history. Any other CI: `polygo check --github` or `--sarif`. Pre-commit: `entry: polygo check` ([snippet](action/README.md#pre-commit)).

**As a reviewer**, `review: "true"` turns those annotations into inline comments with committable suggestions — the same thing [polygo-bot](https://github.com/apps/polygo-bot) does, running in your own CI instead. The app is the same code, deployed: [`bot/`](bot/README.md) is one container, no database, nothing kept between events.
**As a reviewer**, `review: "true"` turns those annotations into inline comments with committable suggestions — the same thing [polygolint](https://github.com/apps/polygolint) does, running in your own CI instead. The app is the same code, deployed: [`bot/`](bot/README.md) is one container, no database, nothing kept between events.

<br>

Expand Down
4 changes: 2 additions & 2 deletions bot/PRIVACY.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# polygo-bot — privacy
# polygolint — privacy

*Last updated: 23 September 2026. The app is [polygo-bot](https://github.com/apps/polygo-bot),
*Last updated: 24 September 2026. The app is [polygolint](https://github.com/apps/polygolint),
published by [@Na5co](https://github.com/Na5co) and built on
[polygo](https://github.com/Na5co/polygo), which is MIT-licensed and readable in full —
including [the bot itself](https://github.com/Na5co/polygo/tree/main/bot).*
Expand Down
5 changes: 4 additions & 1 deletion bot/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
# polygo-bot — a GitHub App that reviews translations
# polygolint — the GitHub App that reviews translations

*The app is [polygolint](https://github.com/apps/polygolint); the binary that serves it is
`polygo-bot`, in this directory.*

A pull request touches `de.json`, and a minute later there is a review on it: an inline
comment on the line that broke, and — where the repair is mechanical, a translator having
Expand Down
2 changes: 1 addition & 1 deletion docs/img/review-comment-dark.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/img/review-comment-light.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading