Skip to content

Commit 70d8add

Browse files
rytswdrytswd
authored
Adjust comment to correct interval setup, and prefer use of v1 tag (#35)
1 parent 5dc2d2d commit 70d8add

File tree

4 files changed

+23
-16
lines changed

4 files changed

+23
-16
lines changed

‎README.md‎

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -38,11 +38,9 @@ curl -sSL https://raw.githubusercontent.com/upsidr/merge-gatekeeper/main/example
3838

3939
#### Directly copy YAML
4040

41-
The below is the copy of [`/example/merge-gatekeeper.yml`](/example/merge-gatekeeper.yml).
42-
43-
<!-- TODO: replace below using Importer once Importer supports code block wrapping
44-
== imptr: basic-yaml / begin from: ./example/definitions.yaml#[standard-setup] == -->
41+
The below is the copy of [`/example/merge-gatekeeper.yml`](/example/merge-gatekeeper.yml), with extra comments.
4542

43+
<!-- == imptr: basic-yaml / begin from: ../example/definitions.yaml#[standard-setup] wrap: yaml == -->
4644
```yaml
4745
---
4846
name: Merge Gatekeeper
@@ -58,10 +56,14 @@ jobs:
5856
runs-on: ubuntu-latest
5957
steps:
6058
- name: Run Merge Gatekeeper
61-
uses: upsidr/merge-gatekeeper@main
59+
# NOTE: v1 is updated to reflect the latest v1.x.y. Please use any tag/branch that suits your needs:
60+
# https://github.com/upsidr/merge-gatekeeper/tags
61+
# https://github.com/upsidr/merge-gatekeeper/branches
62+
uses: upsidr/merge-gatekeeper@v1
6263
with:
6364
token: ${{ secrets.GITHUB_TOKEN }}
6465
```
66+
<!-- == imptr: basic-yaml / end == -->
6567
6668
<!-- == imptr: example-usage / end == -->
6769
@@ -77,9 +79,9 @@ There are some customisation available for Merge Gatekeeper.
7779
| ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :------: |
7880
| `token` | `GITHUB_TOKEN` or Personal Access Token with `repo` scope | Yes |
7981
| `self` | The name of Merge Gatekeeper job, and defaults to `merge-gatekeeper`. This is used to check other job status, and do not check Merge Gatekeeper itself. If you updated the GitHub Action job name from `merge-gatekeeper` to something else, you would need to specify the new name with this value. | |
80-
| `interval` | Check interval to recheck the job status. Default is set to 30 (sec). | |
82+
| `interval` | Check interval to recheck the job status. Default is set to 5 (sec). | |
8183
| `timeout` | Timeout setup to give up further check. Default is set to 600 (sec). | |
82-
| `ignored` | Jobs to ignore regardless of their statuses. Defined as a comma-separated list. | |
84+
| `ignored` | Jobs to ignore regardless of their statuses. Defined as a comma-separated list. | |
8385
| `ref` | Git ref to check out. This falls back to the HEAD for given PR, but can be set to any ref. | |
8486

8587
<!-- == imptr: inputs / end == -->

‎docs/action-usage.md‎

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@
88
| ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :------: |
99
| `token` | `GITHUB_TOKEN` or Personal Access Token with `repo` scope | Yes |
1010
| `self` | The name of Merge Gatekeeper job, and defaults to `merge-gatekeeper`. This is used to check other job status, and do not check Merge Gatekeeper itself. If you updated the GitHub Action job name from `merge-gatekeeper` to something else, you would need to specify the new name with this value. | |
11-
| `interval` | Check interval to recheck the job status. Default is set to 30 (sec). | |
11+
| `interval` | Check interval to recheck the job status. Default is set to 5 (sec). | |
1212
| `timeout` | Timeout setup to give up further check. Default is set to 600 (sec). | |
13-
| `ignored` | Jobs to ignore regardless of their statuses. Defined as a comma-separated list. | |
13+
| `ignored` | Jobs to ignore regardless of their statuses. Defined as a comma-separated list. | |
1414
| `ref` | Git ref to check out. This falls back to the HEAD for given PR, but can be set to any ref. | |
1515

1616
<!-- == export: inputs / end == -->
@@ -32,11 +32,9 @@ curl -sSL https://raw.githubusercontent.com/upsidr/merge-gatekeeper/main/example
3232

3333
#### Directly copy YAML
3434

35-
The below is the copy of [`/example/merge-gatekeeper.yml`](/example/merge-gatekeeper.yml).
36-
37-
<!-- TODO: replace below using Importer once Importer supports code block wrapping
38-
== imptr: basic-yaml / begin from: ./example/definitions.yaml#[standard-setup] == -->
35+
The below is the copy of [`/example/merge-gatekeeper.yml`](/example/merge-gatekeeper.yml), with extra comments.
3936

37+
<!-- == imptr: basic-yaml / begin from: ../example/definitions.yaml#[standard-setup] wrap: yaml == -->
4038
```yaml
4139
---
4240
name: Merge Gatekeeper
@@ -52,10 +50,14 @@ jobs:
5250
runs-on: ubuntu-latest
5351
steps:
5452
- name: Run Merge Gatekeeper
55-
uses: upsidr/merge-gatekeeper@main
53+
# NOTE: v1 is updated to reflect the latest v1.x.y. Please use any tag/branch that suits your needs:
54+
# https://github.com/upsidr/merge-gatekeeper/tags
55+
# https://github.com/upsidr/merge-gatekeeper/branches
56+
uses: upsidr/merge-gatekeeper@v1
5657
with:
5758
token: ${{ secrets.GITHUB_TOKEN }}
5859
```
60+
<!-- == imptr: basic-yaml / end == -->
5961
6062
<!-- == export: simple-usage / end == -->
6163

‎example/definitions.yaml‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,10 @@ jobs:
1313
runs-on: ubuntu-latest
1414
steps:
1515
- name: Run Merge Gatekeeper
16-
uses: upsidr/merge-gatekeeper@main
16+
# NOTE: v1 is updated to reflect the latest v1.x.y. Please use any tag/branch that suits your needs:
17+
# https://github.com/upsidr/merge-gatekeeper/tags
18+
# https://github.com/upsidr/merge-gatekeeper/branches
19+
uses: upsidr/merge-gatekeeper@v1
1720
with:
1821
token: ${{ secrets.GITHUB_TOKEN }}
1922
# == export: standard-setup / end ==

‎example/merge-gatekeeper.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,6 @@ jobs:
1212
runs-on: ubuntu-latest
1313
steps:
1414
- name: Run Merge Gatekeeper
15-
uses: upsidr/merge-gatekeeper@main
15+
uses: upsidr/merge-gatekeeper@v1
1616
with:
1717
token: ${{ secrets.GITHUB_TOKEN }}

0 commit comments

Comments
 (0)