You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+22-7Lines changed: 22 additions & 7 deletions
Original file line number
Diff line number
Diff line change
@@ -14,11 +14,11 @@ GitHub does not update the status of a commit when running workflow and therefor
14
14
* token: Auth token used to add status commits
15
15
16
16
* required
17
-
* default: ${ github.token }
17
+
* default: "${ github.token }"
18
18
19
19
* name: The Name of the status check to add to the commit
20
20
* required
21
-
* default: GithubActions - ${GITHUB_WORKFLOW}
21
+
* default: "GithubActions - ${GITHUB_WORKFLOW}"
22
22
23
23
* status: Commit or job status, based on this the action will set the correct status in the commit: Accepted values are: `error`, `failure`, `pending`, `success` and `cancelled`.
24
24
@@ -31,7 +31,7 @@ GitHub does not update the status of a commit when running workflow and therefor
31
31
If the passed status is `error` it will set status commit `error`.
32
32
33
33
* required
34
-
* default: ${ job.status }
34
+
* default: "pending"
35
35
36
36
* url: URL for the status check.
37
37
@@ -77,14 +77,29 @@ name: Test
77
77
78
78
on: [pull_request]
79
79
80
+
jobs:
81
+
build:
82
+
runs-on: ubuntu-latest
83
+
steps:
84
+
- uses: actions/checkout@v2
85
+
- uses: ouzi-dev/commit-status-updater@v1.0.0
86
+
```
87
+
88
+
### Action sets commit to error status without comment
89
+
90
+
```
91
+
name: Test
92
+
93
+
on: [pull_request]
94
+
80
95
jobs:
81
96
build:
82
97
runs-on: ubuntu-latest
83
98
steps:
84
99
- uses: actions/checkout@v2
85
100
- uses: ouzi-dev/commit-status-updater@v1.0.0
86
101
with:
87
-
status: "pending"
102
+
status: "error"
88
103
```
89
104
90
105
### Action sets commit to pending status with comment, and updates check and adds comment at the end of the workflow
@@ -101,12 +116,12 @@ jobs:
101
116
- uses: actions/checkout@v2
102
117
- uses: ouzi-dev/commit-status-updater@v1.0.0
103
118
with:
104
-
status: "pending"
105
119
addHoldComment: "true"
106
120
- if: always()
107
121
uses: ouzi-dev/commit-status-updater@v1.0.0
108
122
with:
109
123
addHoldComment: "true"
124
+
status: "${{ job.status }}"
110
125
```
111
126
112
127
### Action with custom hold comments
@@ -130,7 +145,7 @@ jobs:
130
145
failComment: "action failed!"
131
146
```
132
147
133
-
### Action no comments, set commit to "pending" status and set url, description and specific name
148
+
### Action no comments, set commit to "error" status and set url, description and specific name
0 commit comments