https://github.com/parkjong-hun/roborazzi-compare-on-github-comment-sample-with-circleci
roborazzi-compare-on-github-comment-sample with Circle CI
https://github.com/parkjong-hun/roborazzi-compare-on-github-comment-sample-with-circleci
android circle-ci roborazzi
Last synced: 18 days ago
JSON representation
roborazzi-compare-on-github-comment-sample with Circle CI
- Host: GitHub
- URL: https://github.com/parkjong-hun/roborazzi-compare-on-github-comment-sample-with-circleci
- Owner: ParkJong-Hun
- License: apache-2.0
- Created: 2024-02-27T10:39:20.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-04-08T13:38:06.000Z (over 1 year ago)
- Last Synced: 2025-09-11T04:49:45.396Z (25 days ago)
- Topics: android, circle-ci, roborazzi
- Language: Kotlin
- Homepage:
- Size: 229 KB
- Stars: 6
- Watchers: 1
- Forks: 0
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# roborazzi-compare-on-github-comment-sample-with-circleci
This is a sample of using [Roborazzi](https://github.com/takahirom/roborazzi) in Circle CI, which is widely used in mobile development, to issue comments on a Pull Request by a bot when changes exist.
Inspired by [CircleCI code](https://github.com/kosenda/hiragana-converter/blob/develop/.circleci/config.yml) in [kosenda's app repository](https://github.com/kosenda/hiragana-converter), Github Actions code in [takahirom's sample repository](https://github.com/takahirom/roborazzi-compare-on-github-comment-sample).
## Artifact as Github Branch Mode
When any pull request is created or updated, This will pushes historical test output and comparison output as a branch to remote repository.
### Requirement
1. Register a Deploy key with read/**write** access to GitHub and register the corresponding private key in CircleCI.
2. Prepare **Github bot account** for commenting or pushing branches, and add the account information to circle ci project's environment variables.
- `GITHUB_BOT_NAME`
- `GITHUB_BOT_EMAIL`
- `GITHUB_BOT_ACCESS_TOKEN`
## Artifact as CircleCI Artifact Mode
When any pull request is created or updated, This will store historical test output and comparison output as a artifact to circle ci.
### Requirement
> [!WARNING]
> preparing...