Skip to content
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

Revert "feat: allow specifying expected images directory" #149

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 0 additions & 2 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,5 +16,3 @@ jobs:
with:
github-token: "${{ secrets.GITHUB_TOKEN }}"
image-directory-path: "./images"
disable-branch: true
report-file-path: './'
34 changes: 2 additions & 32 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ jobs:

### Action inputs

Input definitions are written in [action.yml](https://github.com/reg-viz/reg-actions/blob/main/dist/action.yml).
Input definitions are written in [action.yml](./action.yml).

#### `github-token` (Required)

Expand All @@ -87,17 +87,7 @@ It is used to upload test report and add comment to pull request.
- Type: String
- Default: N/A

Path to images directory. The images stored in this directory will be compared with the expected images from the last upload.

#### `expected-images-directory-path` (Optional)

- Type: String
- Default: N/A

Path to expected images directory. These images will be compared with images stored in `image-directory-path`.

If this option is specified, images from artifact upload are ignored.
Instead, the images are copied directly from the specified directory.
Path to images directory.The images stored in this directory will be compared with the expected images from the last upload.

#### `enable-antialias` (Optional)

Expand Down Expand Up @@ -175,26 +165,6 @@ Default is "reg_actions".

The option to disable push to a branch. When set to false, the `branch` option is ignored, and images will not be displayed in the comments.

#### `comment-report-format` (Optional)

- Type: String
- Default: `"raw"`

The option how to render changed file in comment. This action will change PR and workflow summary report format. Available options are `raw` and `summarized`. `raw` will render report comment with expanded results. `summarized` will render report comment using `<details>` tag to summarize by changed files.

#### `outdated-comment-action` (Optional)

- Type: String
- Default: `"none"`

The option to handle outdated comments in the PR. Available options are `none` and `minimize`. `none` do nothing. `minimize` will minimize outdated action comments.

### `retention-days` (Optional)

- Type: number
- Default: `30`

This option allows you to specify the duration for which images are stored in the branch. If not specified, the default is 30 days.

## Limitation

Expand Down
14 changes: 1 addition & 13 deletions dist/action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,6 @@ inputs:
image-directory-path:
description: "Path to images directory.The images stored in this directory will be compared with the expected images from the last upload."
required: true
expected-images-directory-path:
description: "Path to expected images directory. The images stored in this directory will be compared with the actual images from image-directory-path."
required: false
enable-antialias:
description: "Enable antialias. If omitted false."
required: false
Expand Down Expand Up @@ -43,16 +40,7 @@ inputs:
required: false
report-file-path:
description: "Path of the generated report html file. This file can be deployed in other Actions steps, but is not included in the artifact. If omitted, no html report is generated."
required: false
comment-report-format:
description: "The option how to render changed file in comment. `raw` by default."
required: false
outdated-comment-action:
description: "The option to handle outdated comments. `none` by default."
required: false
retention-days:
description: "This option allows you to specify the duration for which images are stored in the branch. If not specified, the default is 30 days."
required: false
required: false
runs:
using: "node20"
main: "lib/index.js"
Expand Down
38 changes: 19 additions & 19 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -35,32 +35,32 @@
}
},
"dependencies": {
"@actions/artifact": "^2.1.7",
"@actions/core": "^1.10.1",
"@actions/artifact": "^1.1.0",
"@actions/core": "^1.10.0",
"@actions/exec": "^1.1.1",
"@actions/github": "^6.0.0",
"@actions/io": "^1.1.3",
"@actions/io": "^1.1.2",
"@actions/tool-cache": "^2.0.1",
"@types/glob": "^8.1.0",
"adm-zip": "^0.5.14",
"axios": "^1.7.2",
"chalk": "^5.3.0",
"cpy": "^11.0.1",
"exponential-backoff": "^3.1.1",
"fast-glob": "^3.3.2",
"glob": "^10.4.1",
"loglevel": "^1.9.1",
"make-dir": "^4.0.0",
"reg-cli": "^0.18.6"
"@types/glob": "^8.0.0",
"adm-zip": "^0.5.9",
"axios": "^1.1.3",
"chalk": "^5.1.2",
"cpy": "^10.1.0",
"exponential-backoff": "^3.1.0",
"fast-glob": "^3.3.1",
"glob": "^8.0.3",
"loglevel": "^1.8.0",
"make-dir": "^3.1.0",
"reg-cli": "^0.17.7"
},
"devDependencies": {
"@octokit/openapi-types": "^22.2.0",
"@types/adm-zip": "^0.5.5",
"@octokit/openapi-types": "^19.0.0",
"@types/adm-zip": "^0.5.0",
"@types/axios": "^0.14.0",
"@types/loglevel": "^1.6.3",
"@types/make-dir": "^2.1.0",
"@types/node": "^20.13.0",
"@vercel/ncc": "^0.38.1",
"typescript": "^5.4.5"
"@types/node": "^18.11.5",
"@vercel/ncc": "^0.34.0",
"typescript": "^4.8.4"
}
}
Loading
Loading