docs: add Gitea Actions workflow status checking documentation
- Add API endpoint and curl commands to check CI status - Document authentication with Authorization: token header - Add response field descriptions (status, conclusion) - Reference BWS key for GITEA_API_TOKEN
This commit is contained in:
@@ -200,3 +200,64 @@ source .env && curl -s -H "x-api-key: $DOKPLOY_API_TOKEN" \
|
||||
"https://app.flexinit.nl/api/project.one?projectId=<PROJECT_ID>" | \
|
||||
jq '.environments[0].applications[0] | {name: .name, status: .applicationStatus}'
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Gitea Actions CI/CD Status
|
||||
|
||||
### Check Workflow Status
|
||||
|
||||
The `oh-my-opencode-free` Docker image is built via Gitea Actions. To check CI status:
|
||||
|
||||
**Web UI:**
|
||||
```
|
||||
https://git.app.flexinit.nl/oussamadouhou/oh-my-opencode-free/actions
|
||||
```
|
||||
|
||||
**API (requires token):**
|
||||
```bash
|
||||
# Get GITEA_API_TOKEN from BWS (key: GITEA_API_TOKEN)
|
||||
GITEA_TOKEN="<your-token>"
|
||||
|
||||
# List recent workflow runs
|
||||
curl -s -H "Authorization: token $GITEA_TOKEN" \
|
||||
"https://git.app.flexinit.nl/api/v1/repos/oussamadouhou/oh-my-opencode-free/actions/runs?limit=5" | \
|
||||
jq '.workflow_runs[] | {id, run_number, status, conclusion, display_title, head_sha: .head_sha[0:7]}'
|
||||
|
||||
# Get specific run details
|
||||
curl -s -H "Authorization: token $GITEA_TOKEN" \
|
||||
"https://git.app.flexinit.nl/api/v1/repos/oussamadouhou/oh-my-opencode-free/actions/runs/<RUN_ID>" | jq .
|
||||
|
||||
# Get jobs for a specific run
|
||||
curl -s -H "Authorization: token $GITEA_TOKEN" \
|
||||
"https://git.app.flexinit.nl/api/v1/repos/oussamadouhou/oh-my-opencode-free/actions/runs/<RUN_ID>/jobs" | jq .
|
||||
```
|
||||
|
||||
### API Response Fields
|
||||
|
||||
| Field | Description |
|
||||
|-------|-------------|
|
||||
| `status` | `queued`, `in_progress`, `completed` |
|
||||
| `conclusion` | `success`, `failure`, `cancelled`, `skipped` (only when status=completed) |
|
||||
| `head_sha` | Commit SHA that triggered the run |
|
||||
| `run_number` | Sequential run number |
|
||||
| `display_title` | Commit message or PR title |
|
||||
|
||||
### Gitea API Authentication
|
||||
|
||||
From [Gitea docs](https://docs.gitea.com/development/api-usage):
|
||||
|
||||
```bash
|
||||
# Header format
|
||||
Authorization: token <your-api-token>
|
||||
|
||||
# Alternative: query parameter
|
||||
?token=<your-api-token>
|
||||
```
|
||||
|
||||
### BWS Token Reference
|
||||
|
||||
| Key | Purpose |
|
||||
|-----|---------|
|
||||
| `GITEA_API_TOKEN` | Gitea API access for workflow status |
|
||||
| `DOKPLOY_API_TOKEN` | Dokploy deployment API (BWS ID: `6b3618fc-ba02-49bc-bdc8-b3c9004087bc`) |
|
||||
|
||||
Reference in New Issue
Block a user