Skip to content

Commit

Permalink
Merge remote-tracking branch 'origin/main' into catchup-main-11
Browse files Browse the repository at this point in the history
  • Loading branch information
bokuweb committed Nov 10, 2024
2 parents 8a1a490 + 24dcf98 commit 5031b9a
Show file tree
Hide file tree
Showing 13 changed files with 2,427 additions and 2,771 deletions.
2 changes: 2 additions & 0 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,3 +16,5 @@ jobs:
with:
github-token: "${{ secrets.GITHUB_TOKEN }}"
image-directory-path: "./images"
disable-branch: true
report-file-path: './'
26 changes: 23 additions & 3 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](./action.yml).
Input definitions are written in [action.yml](https://github.com/reg-viz/reg-actions/blob/main/dist/action.yml).
#### `github-token` (Required)

Expand Down Expand Up @@ -163,12 +163,32 @@ Default is "reg_actions".
- Type: Boolean
- Default: `false`

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.
The option to disable push to a branch. When set to true, 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

- If the `artifact` is deleted, the report will also be deleted, see [`Artifact and log retention policy`](https://docs.github.com/ja/actions/learn-github-actions/usage-limits-billing-and-administration#artifact-and-log-retention-policy) for the retention period of the `artifact`.
- If the `artifact` is deleted, the report will also be deleted, see [`Artifact and log retention policy`](https://docs.github.com/en/actions/learn-github-actions/usage-limits-billing-and-administration#artifact-and-log-retention-policy) for the retention period of the `artifact`.

## Troubleshooting

Expand Down
11 changes: 10 additions & 1 deletion dist/action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,16 @@ 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
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
runs:
using: "node20"
main: "lib/index.cjs"
Expand Down
39 changes: 20 additions & 19 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -37,33 +37,34 @@
}
},
"dependencies": {
"@actions/artifact": "^1.1.0",
"@actions/core": "^1.10.0",
"@actions/artifact": "^2.1.11",
"@actions/core": "^1.11.1",
"@actions/exec": "^1.1.1",
"@actions/github": "^6.0.0",
"@actions/io": "^1.1.2",
"@actions/io": "^1.1.3",
"@actions/tool-cache": "^2.0.1",
"@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",
"@bokuweb/reg-cli-wasm": "0.0.0-experimental0"
"@bokuweb/reg-cli-wasm": "0.0.0-experimental0",
"@types/glob": "^8.1.0",
"adm-zip": "^0.5.16",
"axios": "^1.7.7",
"chalk": "^5.3.0",
"cpy": "^11.1.0",
"exponential-backoff": "^3.1.1",
"fast-glob": "^3.3.2",
"glob": "^10.4.1",
"loglevel": "^1.9.2",
"make-dir": "^4.0.0",
"reg-cli": "^0.18.8"
},
"devDependencies": {
"@octokit/openapi-types": "^19.0.0",
"@types/adm-zip": "^0.5.0",
"@octokit/openapi-types": "^22.2.0",
"@types/adm-zip": "^0.5.5",
"@types/axios": "^0.14.0",
"@types/loglevel": "^1.6.3",
"@types/make-dir": "^2.1.0",
"@types/node": "^18.18.6",
"@vercel/ncc": "^0.34.0",
"esbuild": "^0.24.0",
"typescript": "^4.8.4"
"@types/node": "^22.7.7",
"@vercel/ncc": "^0.38.2",
"typescript": "^5.6.3"
}
}
Loading

0 comments on commit 5031b9a

Please sign in to comment.