📖 docs: enhance Gitea client skill with web UI integration
Add web UI link documentation and examples: - Document html_url field usage in responses - Add examples for opening jobs in browser - Include common URL patterns - Enhance job-status and list-workflow-jobs docs Makes it easier to navigate between CLI and web UI for better CI/CD monitoring and debugging.
This commit is contained in:
@@ -58,6 +58,16 @@ Get the current status of a specific job.
|
||||
- `repo`: Repository name
|
||||
- `job_id`: Job ID
|
||||
|
||||
**Web UI Link:**
|
||||
The response includes a `html_url` field that provides a direct link to view the job in Gitea's web interface.
|
||||
|
||||
**Example:**
|
||||
```bash
|
||||
# Get job status and extract web UI link
|
||||
gitea-client job-status arcodange DanceLessonsCoach 351 | jq '.html_url'
|
||||
# Output: "https://gitea.arcodange.lab/arcodange/DanceLessonsCoach/actions/runs/3"
|
||||
```
|
||||
|
||||
### Get Job Logs
|
||||
|
||||
```bash
|
||||
@@ -117,6 +127,15 @@ List all jobs for a specific workflow run.
|
||||
- `repo`: Repository name
|
||||
- `workflow_run_id`: Workflow run ID
|
||||
|
||||
**Web UI Links:**
|
||||
Each job in the response includes a `html_url` field for direct access to that specific job's web interface.
|
||||
|
||||
**Example:**
|
||||
```bash
|
||||
# List all jobs and extract their web UI links
|
||||
gitea-client list-workflow-jobs arcodange DanceLessonsCoach 351 | jq '.jobs[] | "Job \(.id): \(.name) - \(.html_url)"'
|
||||
```
|
||||
|
||||
**Examples:**
|
||||
```bash
|
||||
# List all jobs for workflow run 350
|
||||
@@ -264,6 +283,27 @@ The skill handles common API errors:
|
||||
4. **Logging**: Redirect output to files for debugging
|
||||
5. **Timeouts**: Use reasonable timeouts for wait operations
|
||||
|
||||
## Web UI Integration
|
||||
|
||||
All API responses include `html_url` fields that provide direct links to Gitea's web interface. Use these to:
|
||||
|
||||
```bash
|
||||
# Get web UI link for a job
|
||||
job_url=$(gitea-client job-status owner repo job_id | jq -r '.html_url')
|
||||
echo "View in browser: $job_url"
|
||||
|
||||
# Open job directly in browser (macOS)
|
||||
open $(gitea-client job-status owner repo job_id | jq -r '.html_url')
|
||||
|
||||
# Linux/WSL
|
||||
xdg-open $(gitea-client job-status owner repo job_id | jq -r '.html_url')
|
||||
```
|
||||
|
||||
**Common URL Patterns:**
|
||||
- Job: `https://gitea.arcodange.lab/arcodange/DanceLessonsCoach/actions/runs/{run_id}`
|
||||
- Workflow: `https://gitea.arcodange.lab/arcodange/DanceLessonsCoach/actions`
|
||||
- PR: `https://gitea.arcodange.lab/arcodange/DanceLessonsCoach/pulls/{pr_number}`
|
||||
|
||||
## Implementation Details
|
||||
|
||||
The skill uses:
|
||||
|
||||
Reference in New Issue
Block a user