✨ Use @percy/cli #142
Merged
✨ Use @percy/cli #142
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What is this?
There is a new kid on the block,
@percy/cli, that takes what@percy/agenthas done and makes it more robust, more modular, more extensible, and more feature-rich than@percy/agentcan ever be in its current state. This PR brings@percy/clito this SDK by refactoring the entire SDK from the ground up, including new tests, new CI config, and other niceties. The new@percy/clihas many benefits over@percy/agent, so I won't list all of them here. But importantly, there are a few necessary breaking changes.Breaking Changes
@percy/agentis no longer a dependency, obviously, but neither is@percy/cli. This enables users to install the SDK as a development dependency without requiring the entire SDK umbrella on install (including a lengthy chromium download). When usingnpx, users will have to usenpx @percy/cli ...rather thannpx percy, as the latter refers to@percy/agentand has gaps in its version history that would prevent some future releases.To enable normal package script behavior with
percy <command>, users will have to install the CLI alongside the SDK –npm install @percy/cli @percy/protractor. The new CLI does not download Chromium on install, and instead does so the first time asset discovery is started. So even when choosing to install the CLI as a development dependency, it has a much smaller footprint than its predecessor.The format of Percy configuration files has changed. Common options can be viewed in the
@percy/cli-commandpackage, and previous configuration options can be migrated to the new format usingpercy config:migrate.There are no other breaking changes within the SDK itself.
Repo Changes:
Tests were re-written to be functional. The previous tests were visual only and in reality were testing the behavior of
@percy/agentusing the SDK rather than testing the SDK itself. Coverage reporting has also been added and is a requirement for tests to pass to have complete coverage.GitHub Actions are now the default CI and other CIs do not need to be tested within since this repo should be testing the SDK and not CI integrations. Separate workflows exist for linting and tests so their failures can be reported separately (rather than having tests be cancelled due to failed linting).
The changelog and release processes have also been updated to fully utilize GitHub features such as tags and releases. The semantic release bot and several semantic release packages were replaced with release-drafter which utilizes PRs and labels to create changelogs found alongside each release on the releases page.
Automatic package releasing is now a semi-manual process due to bots not always being able to correctly guess the proper version number and sometimes releasing the incorrect version. To release, the version number should be bumped appropriately and then the automatically created draft release can be published from the releases page. In the future, we can automate the version bump to reflect the release version to make this process smoother, while still requiring a human to approve the release.