{"id":15140320,"url":"https://github.com/taiga-family/argus","last_synced_at":"2025-10-23T17:30:58.162Z","repository":{"id":39533810,"uuid":"401998605","full_name":"taiga-family/argus","owner":"taiga-family","description":"GitHub App for screenshots tests in CI","archived":false,"fork":false,"pushed_at":"2025-01-01T01:46:59.000Z","size":1235,"stargazers_count":19,"open_issues_count":5,"forks_count":0,"subscribers_count":5,"default_branch":"main","last_synced_at":"2025-01-02T08:04:11.239Z","etag":null,"topics":["cypress","github","github-app","probot","screenshot-testing"],"latest_commit_sha":null,"homepage":"https://github.com/apps/lumberjack-bot","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/taiga-family.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-09-01T09:08:39.000Z","updated_at":"2024-12-28T15:21:38.000Z","dependencies_parsed_at":"2023-10-23T20:38:54.345Z","dependency_job_id":"a0426ffd-27c0-4558-9358-978ccee138bd","html_url":"https://github.com/taiga-family/argus","commit_stats":{"total_commits":285,"total_committers":4,"mean_commits":71.25,"dds":"0.30175438596491233","last_synced_commit":"14d06b1de6ea59c01f994ada12e28ad7cbdb4b56"},"previous_names":["taiga-family/argus"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/taiga-family%2Fargus","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/taiga-family%2Fargus/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/taiga-family%2Fargus/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/taiga-family%2Fargus/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/taiga-family","download_url":"https://codeload.github.com/taiga-family/argus/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":237861311,"owners_count":19377965,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cypress","github","github-app","probot","screenshot-testing"],"created_at":"2024-09-26T08:02:05.949Z","updated_at":"2025-10-23T17:30:58.148Z","avatar_url":"https://github.com/taiga-family.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Argus\n\n**Argus** is a bot built with [Probot](https://github.com/probot/probot)\nto watch for repository's workflows with tests, download artifacts with screenshots differences images,\nand pin these images to bot's comment of pull request.\n\n\u003e **Why \"Argus\"?** Argus is a many-eyed \"all-seeing\" giant in Greek mythology.\n\u003e This character is known for having generated the saying \"the eyes of Argus\"\n\u003e (being subject to strict scrutiny in one's actions to an invasive, distressing degree).\n\u003e [(c) Wikipedia](https://en.wikipedia.org/wiki/Argus_Panoptes)\n\nRead more about this tool:\n\n-   [«Bots should work, developers should think»: Writing Github App with Node.js](https://medium.com/its-tinkoff/bots-should-work-developers-should-think-writing-github-app-with-node-js-2e8eb049d7e4) (English)\n-   [«Боты должны работать, разработчики должны думать»: пишем Github App на Node.js](https://habr.com/ru/company/tbank/blog/580936/) (Russian)\n\n## Setup :rocket:\n\nGitHub Action is recommended approach to use bot.\u003cbr /\u003e\nHowever, its deployment as GitHub App is option too.\n\n### As GitHub Action\n\n```yml\n# .github/workflows/screenshot-bot.yml\non:\n    workflow_run:\n        workflows: [E2E Results] # \u003c-- Choose any workflows to be watched by bot\n        types: [requested, completed]\n        branches-ignore:\n            - 'main'\n            - 'release/**'\n    pull_request:\n        types: [closed]\n\njobs:\n    awake-screenshot-bot:\n        runs-on: ubuntu-latest\n        permissions:\n            actions: read\n            contents: write\n            pull-requests: write\n        steps:\n            - uses: taiga-family/argus\n              env:\n                  GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n```\n\n### As GitHub App\n\nYou can deploy your own Github App using this code and recipes from [Probot documentation](https://probot.github.io/docs/deployment).\n\nAfter deployment:\n\n-   Invite bot to you repo.\n-   See its [configurable params](#bot-configurations-gear) or use default ones.\n\n## Bot configurations :gear:\n\nBot has configurable params which can be unique for every Github repository.\u003cbr\u003e\nEvery param is optional, and you can skip this section if default configuration satisfies you.\n\nTo pass custom params for bot you should create `screenshot-bot.config.yml` file inside the `.github` directory of repository.\n\n**Example of `screenshot-bot.config.yml` file content** (you can paste it as it is) and **default values** of each param:\n\n```yaml\n# array of RegExp strings to match images inside artifacts (by their path or file name)\n# which shows difference between two screenshot and which will be added to bot report comment\ndiff-paths: [\n        # it is default Cypress folder name into which snapshot diffs are put\n        '.*__diff_output__.*',\n    ]\n\n# array of attributes (key=\"value\") for html-tag \u003cimg /\u003e (screenshots)\n# e.g. ['width=\"200px\"', 'height=\"300px\"']\nimg-attrs: []\n\n# Text which is placed at the beginning of section \"Failed tests\"\nfailed-report-description: ''\n\n# Regular expression string to match images inside artifacts (by their path or file name)\n# which are created by new screenshot tests.\nnew-screenshot-mark: '.*==new==.*'\n\n##################################\n# Not relevant for GitHub Action #\n##################################\n\n# array of regular expression strings to match workflow names\n# which should be watched by bot\nworkflows: [\n        # all workflows with sub-string \"screenshot\" in their names\n        '.*screenshot.*',\n    ]\n\n# array of RegExp strings to match branch names which should be skipped by bot\nbranches-ignore: []\n```\n\n## What bot can do? :bulb:\n\n-   Holds first PR comment.\n    All workflow updates edit already existing bot comment.\n    No endless stream of comments from bot!\n-   Sets loading state comment when PR is opened or new commits are pushed to PR.\n    ![loading-demo](.demo/loading.png)\n-   Downloads artifacts from workflow with tests, finds screenshots diffs images, and pins them to the tests failure report.\n    ![error-report-demo](.demo/error-report.png)\n-   Removes all uploaded images (for current PR) after closing pull request.\n    ![closed-pr-demo](.demo/pr-closed.png)\n\n## About Permissions :closed_lock_with_key:\n\nIf you use bot as GitHub Action it is required to provide `permissions` property in your `yml` file.\u003cbr\u003e\nIf you use bot as GitHub App it asks for some permissions at the beginning of the bot's installation.\u003cbr\u003e\nAll requested permissions are really needed, and we do not ask for more permissions than necessary.\n\n#### Permissions\n\nBot requires the following repository's **permissions**:\n\n-   `actions: read` - to get list of workflow run artifacts and download these artifacts.\n-   `contents: write` - to create new branch for storage of screenshot diffs images\n    and to ability to upload/delete these screenshot diffs images.\n-   `metadata: read` - mandatory for Github App.\n-   `pull_requests: write` - to create/edit PR's comment with bot's tests reports.\n\n#### Events\n\nBot listens to the following repository's **events**:\n\n-   `pull_request` — bot listens to pull request closing to delete all saved screenshots for current closed PR.\n-   `workflow_run` — bot listens to workflow completion to download artifacts and send tests report as PR comment.\n\n## Contributing\n\nIf you have suggestions for how bot could be improved, or want to report a bug, open an issue!\nWe'd love all and any contributions.\n\nFor more, check out the [Contributing Guide](CONTRIBUTING.md).\n\n## License\n\n🆓 Feel free to use our bot in your commercial and private applications.\n\nBot is covered by [Apache 2.0](/LICENSE).\n\nRead more about this license [here](https://choosealicense.com/licenses/apache-2.0/).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftaiga-family%2Fargus","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftaiga-family%2Fargus","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftaiga-family%2Fargus/lists"}