mirror of https://gitea.com/gitea/tea.git synced 2026-04-25 17:53:37 +02:00

Files

Bo-Yi Wu 53e53e1067 feat(workflows): add dispatch, view, enable and disable subcommands (#952 )

## Summary

- Add `tea actions workflows dispatch` to trigger `workflow_dispatch` events with `--ref`, `--input key=value`, and `--follow` for log tailing
- Add `tea actions workflows view` to show workflow details
- Add `tea actions workflows enable` and `disable` to toggle workflow state
- Rewrite `workflows list` to use the Workflow API instead of file listing
- Remove dead `WorkflowsList` print function that used `ContentsResponse`
- Update `CLI.md` and `example-workflows.md` with usage documentation and examples

## Motivation

Enable re-triggering specific workflows from the CLI, which is essential for AI-driven PR flows where a specific workflow needs to be re-run after pushing changes.

Leverages the 5 workflow API endpoints already supported by the Go SDK (v0.24.1) from go-gitea/gitea#33545:
- `ListRepoActionWorkflows`
- `GetRepoActionWorkflow`
- `DispatchRepoActionWorkflow` (with `returnRunDetails` support)
- `EnableRepoActionWorkflow`
- `DisableRepoActionWorkflow`

## New commands

\`\`\`
tea actions workflows
├── list          (rewritten to use Workflow API)
├── view <id>     (new)
├── dispatch <id> (new)
├── enable <id>   (new)
└── disable <id>  (new)
\`\`\`

### Usage examples

\`\`\`bash
# Dispatch workflow on current branch
tea actions workflows dispatch deploy.yml

# Dispatch with specific ref and inputs
tea actions workflows dispatch deploy.yml --ref main --input env=staging --input version=1.2.3

# Dispatch and follow logs
tea actions workflows dispatch ci.yml --ref feature/my-pr --follow

# View workflow details
tea actions workflows view deploy.yml

# Enable/disable workflows
tea actions workflows enable deploy.yml
tea actions workflows disable deploy.yml --confirm
\`\`\`

## Test plan

- [x] `go build ./...` passes
- [x] `go test ./...` passes
- [x] `go vet ./...` passes
- [x] `make lint` — 0 issues
- [x] `make docs-check` — CLI.md is up to date
- [x] Manual test: `tea actions workflows list` shows workflows from API
- [x] Manual test: `tea actions workflows dispatch <workflow> --ref main` triggers a run
- [x] Manual test: `tea actions workflows view <workflow>` shows details

---------

Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com>
Reviewed-on: https://gitea.com/gitea/tea/pulls/952
Reviewed-by: Lunny Xiao <xiaolunwen@gmail.com>
Co-authored-by: Bo-Yi Wu <appleboy.tw@gmail.com>
Co-committed-by: Bo-Yi Wu <appleboy.tw@gmail.com>

2026-04-09 20:03:33 +00:00

2.9 KiB

Raw Blame History

Gitea actions workflows

Workflow management with tea

List workflows

# List all workflows in the repository
tea actions workflows list

View workflow details

# View details of a specific workflow by ID or filename
tea actions workflows view deploy.yml

Dispatch (trigger) a workflow

# Dispatch a workflow on the current branch
tea actions workflows dispatch deploy.yml

# Dispatch on a specific branch
tea actions workflows dispatch deploy.yml --ref main

# Dispatch with workflow inputs
tea actions workflows dispatch deploy.yml --ref main --input env=staging --input version=1.2.3

# Dispatch and follow log output
tea actions workflows dispatch ci.yml --ref feature/my-pr --follow

Enable / disable workflows

# Disable a workflow
tea actions workflows disable deploy.yml --confirm

# Enable a workflow
tea actions workflows enable deploy.yml

Example: Re-trigger CI from an AI-driven PR flow

Use tea actions workflows dispatch to re-run a specific workflow after pushing changes in an automated PR workflow:

# Push changes to a feature branch, then re-trigger CI
git push origin feature/auto-fix
tea actions workflows dispatch check-and-test --ref feature/auto-fix --follow

Example: Dispatch a workflow with `workflow_dispatch` trigger

name: deploy

on:
  workflow_dispatch:
    inputs:
      env:
        description: "Target environment"
        required: true
        default: "staging"
      version:
        description: "Version to deploy"
        required: true

jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v6
      - name: Deploy
        run: |
          echo "Deploying version ${{ gitea.event.inputs.version }} to ${{ gitea.event.inputs.env }}"

Trigger this workflow from the CLI:

tea actions workflows dispatch deploy.yml --ref main --input env=production --input version=2.0.0

Merge Pull request on approval

---
name: Pull request
on:
  pull_request_review:
    types: [submitted, dismissed]
jobs:
  approved:
    name: Approved
    if: gitea.event.review.type == 'pull_request_review_approved'
    container:
      image: docker.io/pysen/tea:latest
    runs-on: ubuntu-latest
    steps:
    - name: Configure Tea
      env:
        # This is a tea config.yml with (service) account token
        TEA_CREDENTIALS: ${{ secrets.TEA_CREDENTIALS }}
      run: |
        echo "$TEA_CREDENTIALS" > $HOME/.config/tea/config.yml
    - name: Rebase then fast-forward merge Git
      run: |
        tea pr merge --repo ${{ gitea.event.repository.full_name }} --style rebase ${{ gitea.event.pull_request.number }}
  dismissed:
    name: Dismissed
    if: gitea.event.review.type == 'pull_request_review_rejected'
    runs-on: ubuntu-latest
    steps:
    - run: |
        tea pr reject --repo ${{ gitea.event.repository.full_name }} ${{ gitea.event.pull_request.number }} "Dismissed"

2.9 KiB Raw Blame History