Skip to content

Commit 152ed15

Browse files
authored
update Readme
1 parent bba1119 commit 152ed15

File tree

1 file changed

+8
-5
lines changed

1 file changed

+8
-5
lines changed

README.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Yarn Lock Changes
22

3+
[<sub><img src="https://git.io/J38HP" height="16" /></sub>](#)[<sub><img src="https://git.io/J38dY" height="16" /></sub>](#)[<sub><img src="https://git.io/J38ds" height="16" /></sub>](#)[<sub><img src="https://git.io/J38dt" height="16" /></sub>](#)
4+
35
Creates a comment inside Pull Request with the human-readable summary of the changes to the `yarn.lock` file. Works in public and private repositories, offers a degree of customization.
46

57
## Usage
@@ -19,7 +21,7 @@ Creates a comment inside Pull Request with the human-readable summary of the cha
1921
| `collapsibleThreshold` | No | `'25'` | Number of lock changes, which will result in collapsed comment content an addition of summary table. |
2022
| `failOnDowngrade` | No | `'false'` | When a dependency downgrade is detected, fail the action. |
2123
| `path` | No | `'yarn.lock'` | Path to the `yarn.lock` file in the repository. Default value points to the file at project root. |
22-
| `token` | **Yes** | - | GitHub token for the bot, so it can publish a comment in the pull request. |
24+
| `token` | <ins>**Yes**</ins> | | GitHub token for the bot, so it can publish a comment in the pull request. |
2325
| `updateComment` | No | `'true'` | Update the comment on each new commit. If value is set to `'false'`, bot will post a new one on each change. |
2426

2527
### Workflow Example
@@ -48,10 +50,11 @@ jobs:
4850

4951
## Preview
5052

51-
### Short list of changes
53+
### Basic comment appearance
54+
55+
<img alt="basic" src="https://user-images.githubusercontent.com/719641/116818857-c5029d80-ab6d-11eb-8b48-122b851c1d9e.png">
5256

53-
<img alt="Screenshot 2021-04-28 120655" src="https://user-images.githubusercontent.com/719641/116386618-3f53ba80-a81a-11eb-9438-6601d401f880.png">
57+
### Comment appearance when `collapsibleThreshold` has been reached
5458

55-
### Long list of changes
59+
<img alt="summary" src="https://user-images.githubusercontent.com/719641/116819012-7efa0980-ab6e-11eb-99f1-15996b6f12b4.png">
5660

57-
<img alt="Screenshot 2021-04-28 115019" src="https://user-images.githubusercontent.com/719641/116385385-09620680-a819-11eb-857c-113f9048d856.png">

0 commit comments

Comments
 (0)