mirror of
https://gitea.com/gitea/tea.git
synced 2026-10-26 11:01:25 +01:00
feat!: rebuild tea on Cobra with explicit noun/verb commands (#1126)
- **switch tea to the Cobra command tree:** `internal/app` wires the packages from parts 1–4 into explicit noun/verb commands with `--repo`, `--json` / `--jq`, `--sudo` and `--debug`; `main.go` points at it. Build, release and docs tooling (`tools/cli-docs`, Makefile, goreleaser, snap, CI) and README / CONTRIBUTING are updated. - **remove the urfave/cli command tree:** deletes `cmd/`, `modules/`, the old integration tests, contrib completion scripts and the generated `docs/CLI.md`, and drops their dependencies. This commit only deletes. ## Breaking changes This is a breaking release. It requires Gitea 28 or newer; configuration moves to separate `config.yml` and `hosts.yml` files and requires fresh authentication, and command names, aliases, flags and output formats change. `docs/migration-1.0.md` maps every old command, flag and environment variable to its replacement. ## Issues fixes #1118 fixes #1116 fixes #1115 fixes #1094 fixes #1091 fixes #1073 fixes #1052 fixes #1032 fixes #1023 fixes #966 fixes #908 fixes #833 fixes #831 fixes #817 fixes #804 fixes #779 fixes #770 fixes #737 fixes #697 fixes #726 fixes #677 fixes #672 fixes #633 fixes #632 fixes #560 fixes #556 fixes #523 fixes #516 fixes #510 fixes #504 fixes #500 fixes #482 fixes #406 fixes #403 fixes #373 fixes #351 fixes #344 fixes #326 fixes #325 fixes #323 fixes #246 fixes #240 fixes #232 fixes #197 fixes #172 fixes #141 fixes #69 fixes #1110 fixes #569 fixes #480 fixes #666 fixes #670 fixes #457 fixes #643 fixes #498 fixes #490 fixes #1069 fixes #834 fixes #602 fixes #328 fixes #417 fixes #571 fixes #1029 fixes #489 fixes #1050 fixes #162 fixes #430 fixes #1087 fixes #683 Reviewed-on: https://gitea.com/gitea/tea/pulls/1126 Reviewed-by: TheFox0x7 <95654+thefox0x7@noreply.gitea.com>
This commit is contained in:
1 parent
12e415a7a7
commit
f02245449b
456 files changed
+18892
-34015
No files matched your search
+23
-113
@@ -1,120 +1,30 @@
|
||||
# Gitea actions workflows
|
||||
# Gitea Actions workflows
|
||||
|
||||
## Workflow management with tea
|
||||
Select a repository explicitly for scripts and supply a token scoped to its instance:
|
||||
|
||||
### List workflows
|
||||
|
||||
```bash
|
||||
# List all workflows in the repository
|
||||
tea actions workflows list
|
||||
```sh
|
||||
export TEA_HOST=https://gitea.example.org
|
||||
export TEA_REPO=owner/repository
|
||||
# Supply GITEA_TOKEN through your CI secret environment.
|
||||
tea workflow list --no-input --json
|
||||
tea workflow view deploy.yml --no-input --json
|
||||
tea workflow run deploy.yml --ref main --field env=staging --field version=1.2.3 --no-input
|
||||
tea workflow disable deploy.yml --yes --no-input
|
||||
tea workflow enable deploy.yml --no-input
|
||||
```
|
||||
|
||||
### View workflow details
|
||||
Workflow dispatch requires a `workflow_dispatch` trigger in the workflow. Dispatch
|
||||
and watching are separate commands; find the run with `tea run list`, then use
|
||||
`tea run watch RUN_ID --timeout 10m --no-input`. Unsuccessful completed runs return
|
||||
a nonzero exit code.
|
||||
|
||||
```bash
|
||||
# View details of a specific workflow by ID or filename
|
||||
tea actions workflows view deploy.yml
|
||||
For an explicitly authorized merge in CI:
|
||||
|
||||
```sh
|
||||
tea pr merge 123 --repo owner/repository --method rebase --no-input
|
||||
```
|
||||
|
||||
### Dispatch (trigger) a workflow
|
||||
|
||||
```bash
|
||||
# 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
|
||||
|
||||
```bash
|
||||
# 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:
|
||||
|
||||
```bash
|
||||
# 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
|
||||
|
||||
```yaml
|
||||
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:
|
||||
|
||||
```bash
|
||||
tea actions workflows dispatch deploy.yml --ref main --input env=production --input version=2.0.0
|
||||
```
|
||||
|
||||
## Merge Pull request on approval
|
||||
|
||||
```yaml
|
||||
---
|
||||
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"
|
||||
```
|
||||
Keep credentials in the secret environment or credential store. Never write a token
|
||||
into `config.yml` or `hosts.yml`. Run `tea help <command>`, or see the command
|
||||
reference in each release's docs archive, for supported flags and the
|
||||
[README](../README.md) for fresh authentication.
|
||||
Reference in new issue
Block a user