Skip to content

Commit

Permalink
feat: Timeout on action (#20)
Browse files Browse the repository at this point in the history
  • Loading branch information
kevintyj authored Jun 28, 2024
1 parent 6d7194e commit 7a22e6b
Show file tree
Hide file tree
Showing 16 changed files with 7,968 additions and 7,328 deletions.
5 changes: 5 additions & 0 deletions .changeset/rare-cars-suffer.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@kevintyj/prlint": minor
---

Add timeout and timeout input on action
2 changes: 1 addition & 1 deletion .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ jobs:
- name: 📦Setup PNPM
uses: pnpm/action-setup@v4
with:
version: 8
version: 9
- name: 🌳Setup Node
uses: actions/setup-node@v4
with:
Expand Down
1 change: 1 addition & 0 deletions .github/workflows/prlint.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,3 +16,4 @@ jobs:
uses: ./
with:
download-dependencies: node
timeout: 60
17 changes: 16 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ jobs:
with:
download-dependencies: ignore
body: false
timeout: 20000
```
## v2 release
Expand Down Expand Up @@ -138,7 +139,21 @@ Options:
- `'true'` Passes the body and appends the body in Github's default style (`\n\n`)
- `'false'` Ignore body

> Only available in v^2.0.1
> Only available in v^2.1.0

---

### `timeout`
**Optional** Change the default timeout for the action (in s). Default : `'25'`

> If your action fails without a helpful fail log, it is most likely the action
> exiting before values are resolved. It is recommended to increase the timeout
> default when using our node importer to give enough time to load your dependencies.

Options:
- `'timeout: {number}'` Any number value in s (seconds) accepted

> Only available in v^2.2.0

---

Expand Down
4 changes: 4 additions & 0 deletions action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,10 @@ inputs:
description: 'Use body text as commit body using Github style'
required: false
default: 'false'
timeout:
description: 'The maximum timeout value of the action'
required: false
default: 20000
outputs:
lint-status:
description: The status of the PR lint
Expand Down
Loading

0 comments on commit 7a22e6b

Please sign in to comment.