Skip to content

feat: add Screenshot bot Argus #640

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

nsbarsukov
Copy link

This bot:

  • A good demonstration of almost all powers of Probot framework (this bot has really huge codebase)
  • It can be a good reference for new users of Probot frameworks – it demonstrates:
    • How to build bot using strict TypeScript
    • How to build all Typescript files into a single executable script (GitHub Action requirement)
    • How to use bot as both GitHub App and Github Action
  • It is used by popular Open Source project Taiga UI

Learn more about main idea of the bot in the article:
«Bots should work, developers should think»: Writing Github App with Node.js.

@nsbarsukov nsbarsukov requested a review from a team as a code owner August 5, 2025 17:36
@nsbarsukov
Copy link
Author

nsbarsukov commented Aug 5, 2025

You can use this sandbox to ensure that bot actually works:
https://github.com/nsbarsukov/argus-sandbox

For example:
nsbarsukov/argus-sandbox#11 (comment)

GitHub
Contribute to nsbarsukov/argus-sandbox development by creating an account on GitHub.

@wolfy1339 wolfy1339 requested a review from Copilot August 5, 2025 20:40
Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR introduces comprehensive documentation for the "Screenshot bot Argus" - a GitHub App/Action that automates screenshot testing workflows by monitoring test results and pinning screenshot differences to pull request comments.

  • Adds complete setup instructions for both GitHub Action and GitHub App deployment methods
  • Documents configuration options through screenshot-bot.config.yml with detailed examples
  • Explains bot capabilities including comment management, artifact processing, and cleanup features

Copy link
Contributor

@wolfy1339 wolfy1339 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Rewording and grammar fixes for better comprehension

Co-authored-by: wolfy1339 <4595477+wolfy1339@users.noreply.github.com>
@nsbarsukov
Copy link
Author

@wolfy1339 Thanks for your review! I've accepted all suggestions

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants