Skip to content

Automates the prettier/prettier regression checks with GitHub Actions.

Notifications You must be signed in to change notification settings

prettier/prettier-regression-testing

Repository files navigation

prettier-regression-testing

Motivation

prettier/prettier#9290

We run Prettier on other projects prior to release to check for regressions. (See Release Checklist)

We used to do that manually.

This is a lot of work, so we use GitHub Actions to automate it.

Usage

Create an issue comment like the one below:

run alternativeVersionPrettier vs originalVersionPrettier

alternativeVersionPrettier

Required.

There are 2 ways to specify.

  1. Versions or repository name + ref (e.g. 2.0.0, 1.7.1, or sosukesuzuki/prettier#2f3fc241f8cb1867a0a3073ceac9d662e4b25fab), it's installed directly with yarn add, so anything that yarn add allows
  2. Pull Request number on prettier/prettier repository (e.g. #110168).

originalVersionPrettier

Optional.

In default, use prettier/prettier.

Also, you can specify with the logic same as alternativeVersionPrettier.

Examples

run #110168
run #110168 vs sosukesuzuki/prettier#fix-foo
run sosukesuzuki/prettier#fix-foo vs 1.8.1

Add new project

Add a project info to projects.json.

About

Automates the prettier/prettier regression checks with GitHub Actions.

Resources

Code of conduct

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 7