https://github.com/prettier/prettier-regression-testing
Automates the prettier/prettier regression checks with GitHub Actions.
https://github.com/prettier/prettier-regression-testing
Last synced: 4 months ago
JSON representation
Automates the prettier/prettier regression checks with GitHub Actions.
- Host: GitHub
- URL: https://github.com/prettier/prettier-regression-testing
- Owner: prettier
- Created: 2020-09-29T08:39:49.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-05-30T06:56:57.000Z (about 1 year ago)
- Last Synced: 2024-10-29T15:15:10.758Z (7 months ago)
- Language: TypeScript
- Homepage:
- Size: 393 KB
- Stars: 12
- Watchers: 7
- Forks: 9
- Open Issues: 38
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# prettier-regression-testing
## Motivation
https://github.com/prettier/prettier/issues/9290
We run Prettier on other projects prior to release to check for regressions. (See [Release Checklist](https://github.com/prettier/prettier/wiki/Release-Checklist))
We used to do that manually.
- https://github.com/sosukesuzuki/eslint-plugin-vue/pull/1
- https://github.com/sosukesuzuki/typescript-eslint/pull/1
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 3 ways to specify.
1. Versions (e.g. `2.0.0`, `1.7.1`)
2. Repository name + ref (e.g. `sosukesuzuki/prettier#2f3fc241f8cb1867a0a3073ceac9d662e4b25fab`).
3. Pull Request number on [prettier/prettier](https://github.com/prettier/prettier) repository (e.g. `#110168`).
### `originalVersionPrettier`
Optional.
In default, use `prettier/prettier#main`.
Also, you can specify with the logic same as `alternativeVersionPrettier`.
## Examples
```
run #110168
```
```
run #110168 vs sosukesuzuki/prettier#main
```
```
run sosukesuzuki/prettier#main vs 1.8.1
```
## Add new project
Add a project info to `projects.json`.