Files
marqdo-cli/docs/development-credentials.md
T
cflmy 328f1a8db3
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
ci/woodpecker/push/woodpecker Pipeline was canceled
docs: defer stdlib extraction; add local credential and Woodpecker setup
- Add ADR-0039: keep stdlib in-repo while architecture is small; extraction is
  a future trigger-driven option, not a pending gate. Update ADR-0028,
  STATUS, architecture index, package/P2/completion evidence.
- Add .woodpecker.yml (fmt/clippy/test + release build) for ci.cflmy.cn.
- Add docs/development-credentials.md and ignore .secrets/ plus .env.local;
  real credentials stay in the ignored local file and are never committed.

Gate: fmt, clippy -D warnings, 440 tests passed.
2026-11-20 23:40:38 +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.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.yml` — public CI pipeline definition.
- this document — names/usage only, no values.
- `.secrets/` and `.env.local` — ignored local files.