mirror of
https://gitea.com/gitea/docs.git
synced 2026-11-05 17:45:46 +00:00
docs: tighten the gt guides and the cli wiring
The workflow example had no trigger, so Gitea would reject it as written. The guides now merge the small account sections and point users at the nightly builds they describe. Comments and READMEs no longer mention the dropped reference generator or list the runner as the only hand written sidebar product, and the sidebar lookup drops a key the fallback covers. Co-Authored-By: Claude (Opus 5.5) <[email protected]>
This commit is contained in:
10 files changed
+46
-55
No files matched your search
@@ -38,20 +38,18 @@ token:
|
||||
gt auth login --host https://gitea.example.com --ssh-key ~/.ssh/id_ed25519
|
||||
```
|
||||
|
||||
## Where credentials are kept
|
||||
## Accounts
|
||||
|
||||
Tokens go to the system keyring by default. `--credential-store file` keeps them in gt's
|
||||
configuration directory instead, for machines without a keyring. `gt auth status` lists
|
||||
your accounts and `gt auth logout` removes one.
|
||||
Tokens go to the system keyring, or with `--credential-store file` to gt's configuration
|
||||
directory on machines without one. Run `gt auth login` once per instance and account.
|
||||
gt picks the instance from the repository's remote or `--host`, and the account with
|
||||
`gt auth switch` or `--user`. `gt auth status` lists your accounts and `gt auth logout`
|
||||
removes one.
|
||||
|
||||
For instances behind an access proxy, `--header` and `--client-cert` add headers and a
|
||||
client certificate.
|
||||
|
||||
## Git over HTTPS
|
||||
|
||||
`gt auth setup-git` lets `git push` and `git fetch` over HTTPS use gt's login. gt's own
|
||||
clone and checkout commands need no setup.
|
||||
|
||||
## Several instances and accounts
|
||||
|
||||
Run `gt auth login` for each instance and account. gt picks the instance from the
|
||||
repository's remote or `--host`, and the account with `gt auth switch` or `--user`.
|
||||
For instances behind an access proxy, `--header` and `--client-cert` add headers and a
|
||||
client certificate; see `gt auth login --help`.
|
||||
+6
-2
@@ -21,8 +21,12 @@ Gitea does not allow secret names that start with `GITEA_`, so store the token a
|
||||
example, `GT_TOKEN`:
|
||||
|
||||
```yaml
|
||||
on:
|
||||
push:
|
||||
branches: [main]
|
||||
|
||||
jobs:
|
||||
deploy:
|
||||
staging:
|
||||
runs-on: ubuntu-latest
|
||||
env:
|
||||
GITEA_TOKEN: ${{ secrets.GT_TOKEN }}
|
||||
@@ -33,4 +37,4 @@ jobs:
|
||||
- run: gt workflow run deploy.yml --ref main --field env=staging --no-input
|
||||
```
|
||||
|
||||
`gt run watch` and `gt pr checks --watch` wait for runs and checks and fail when they do.
|
||||
`gt run watch` and `gt pr checks --watch` wait for runs and checks and fail when one fails.
|
||||
+3
-4
@@ -10,7 +10,7 @@ with repositories, issues, pull requests, releases, Actions and the other resour
|
||||
Gitea instance, from a terminal or a script.
|
||||
|
||||
:::info Development version
|
||||
These pages describe builds from the `main` branch of gitea/cli.
|
||||
These pages describe builds from the `main` branch, published as `nightly` binaries and images.
|
||||
:::
|
||||
|
||||
gt needs Gitea 28 or later, and Git for the commands that clone, check out or push.
|
||||
@@ -34,6 +34,5 @@ gt needs Gitea 28 or later, and Git for the commands that clone, check out or pu
|
||||
|
||||
`gt doctor` checks your setup and suggests a fix for each problem it finds.
|
||||
|
||||
Every command documents itself with `--help`. `gt help environment`, `gt help formatting`
|
||||
and `gt help exit-codes` cover global flags and environment variables, JSON output, and
|
||||
exit codes.
|
||||
`gt <command> --help` lists the flags of a command, and `gt help environment` the global
|
||||
flags and environment variables.
|
||||
Reference in new issue
Block a user