@@ -20,7 +20,7 @@ skip CI for that PR.
20
20
* Note: If GitHub Actions ever supports this feature natively for pull requests,
21
21
then we do not need this action.*
22
22
23
- #### Ways to customize
23
+ ## Ways to customize
24
24
25
25
The behavior described above is the default, but it could be customized
26
26
using these options (also see examples below):
@@ -32,7 +32,7 @@ using these options (also see examples below):
32
32
Instead, it would set an output value for ` run_next ` to ` true ` or ` false `
33
33
to be used by downstream jobs.
34
34
35
- #### Examples
35
+ ## Examples
36
36
37
37
Here are some simple examples to use this action in your workflows.
38
38
53
53
runs-on: ubuntu-latest
54
54
steps:
55
55
- name: Fail means CI is skipped on purpose
56
- uses: pllim /action-skip-ci@main
56
+ uses: OpenAstronomy /action-skip-ci@main
57
57
with:
58
58
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
59
59
87
87
run_next: ${{ steps.skip_ci_step.outputs.run_next }}
88
88
steps:
89
89
- name: Set output to skip CI
90
- uses: pllim /action-skip-ci@main
90
+ uses: OpenAstronomy /action-skip-ci@main
91
91
id: skip_ci_step
92
92
with:
93
93
NO_FAIL: true
@@ -102,9 +102,24 @@ jobs:
102
102
...
103
103
```
104
104
105
- #### Why does this action not cancel workflow instead of failing?
105
+ ## Why does this action not cancel workflow instead of failing?
106
106
107
107
This is because cancelling the workflow does not work when the command
108
108
is issued from a pull request opened from a fork due to lack of
109
109
write access from the fork's GitHub token. The cancellation does not
110
110
fail but nothing gets cancelled anyway.
111
+
112
+ ## For developers
113
+
114
+ To install/update dependencies:
115
+
116
+ npm install
117
+
118
+ To build:
119
+
120
+ npm run build
121
+
122
+ To run it locally (might require tinkering with ` src/main.ts ` to mock
123
+ the GitHub events):
124
+
125
+ node dist/index.js
0 commit comments