Files
marqdo-cli/docs/development-credentials.md
T
cflmy a3f3ecf9d0
CI / fmt + clippy + test (Linux x86_64) (push) Waiting to run
CI / schema instance validation + consumers (push) Waiting to run
CI / runtime contract (macos-latest) (push) Waiting to run
CI / runtime contract (windows-latest) (push) Waiting to run
Linux strict security lane (G-C) / strict isolation escape matrix (push) Waiting to run
ci/woodpecker/manual/performance Pipeline failed
ci/woodpecker/push/main Pipeline was successful
ci(perf): add the fixed Woodpecker G4 workflow
Move the push/PR pipeline to .woodpecker/main.yml so the repository can use
Woodpecker's multi-workflow directory. Add .woodpecker/performance.yml: manual
only, master only, on the single fixed Woodpecker agent (platform_id
woodpecker-agent-1). It builds one release binary, pins the first CPU in the
container cpuset, runs 5 warmups + 20 samples with --approved-node, and prints
the full marqdo.perf.v2 report plus a compact G4 summary for extraction.

No PR code is executed on the performance agent; the workflow is manual.
2026-11-21 19:51:09 +08:00

53 lines
1.6 KiB
Markdown

# Local development credentials
Credentials are **not committed**. They live in the git-ignored `.secrets/`
directory (or the untracked `.env.local`) so local development can use the
private Git and Woodpecker instances without rotating secrets through the
repository.
## Where to put them
`.secrets/dev.env` (ignored, mode 600) should define:
```dotenv
MARQDO_GIT_REMOTE=https://git.cflmy.cn/cflmy/marqdo-cli.git
MARQDO_GIT_USERNAME=<username>
MARQDO_GIT_TOKEN=<git access token>
MARQDO_WOODPECKER_URL=https://ci.cflmy.cn
MARQDO_WOODPECKER_TOKEN=<Woodpecker API token>
MARQDO_CI_SECRET=<optional CI secret>
```
Do not put real values in this document, tests, CI YAML or commit messages.
The repository's `.gitignore` excludes `.secrets/` and `.env.local`.
## Git push
` .secrets/git-askpass.sh ` returns the username/token for HTTPS prompts:
```bash
set -a; . ./.secrets/dev.env; set +a
GIT_ASKPASS="$PWD/.secrets/git-askpass.sh" git push origin master
```
Never embed the token in a remote URL stored in `.git/config`, shell history or
a CI file.
## Woodpecker API
```bash
set -a; . ./.secrets/dev.env; set +a
curl -fsS -H "Authorization: Bearer $MARQDO_WOODPECKER_TOKEN" \
"$MARQDO_WOODPECKER_URL/api/user/repos"
```
CI itself is defined in `.woodpecker/main.yml`; the token is only for local API
queries/triggering, not for the pipeline. Configure any privileged secrets in
the Woodpecker repository settings, never in this repository.
## What is tracked
- `.woodpecker/main.yml` — public CI pipeline definition.
- this document — names/usage only, no values.
- `.secrets/` and `.env.local` — ignored local files.