Skip to content

Commit f7d7672

Browse files
committed
📝 Add nicer readme
1 parent d7d9e6d commit f7d7672

File tree

1 file changed

+39
-2
lines changed

1 file changed

+39
-2
lines changed

README.md

Lines changed: 39 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,42 @@
11
# Action: `action-coolify-deployment`
22

3-
This action triggers one or more deployments based on `tag` and `uuid`.
3+
This GitHub Action triggers one or more deployments to Coolify based on `tag` and `uuid`. It waits until the deployment(s) reach the `finished` status.
44

5-
It waits until the deployment(s) are in the `finished` status.
5+
## Inputs
6+
7+
- `coolify-url` (optional): The Coolify API URL. Default is `https://app.coolify.io`.
8+
- `api-key` (required): The Coolify API key.
9+
- `wait` (optional): Seconds to wait for the deployment to finish. Default is `600`.
10+
- `tag` (optional): Tag name(s). Comma-separated list is also accepted.
11+
- `uuid` (optional): Resource UUID(s). Comma-separated list is also accepted.
12+
- `force` (optional): Force rebuild (without cache). Default is `false`.
13+
14+
## Outputs
15+
16+
This action does not produce any outputs.
17+
18+
## Example Usage
19+
20+
```yaml
21+
name: Deploy to Coolify
22+
23+
on:
24+
push:
25+
branches:
26+
- main
27+
28+
jobs:
29+
deploy:
30+
runs-on: ubuntu-latest
31+
steps:
32+
- name: Checkout code
33+
uses: actions/checkout@v2
34+
35+
- name: Deploy to Coolify
36+
uses: ./
37+
with:
38+
coolify-url: ${{ secrets.COOLIFY_URL }}
39+
api-key: ${{ secrets.COOLIFY_API_KEY }}
40+
wait: 600
41+
tag: "app"
42+
```

0 commit comments

Comments
 (0)