Public Access
Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
bdfe2c561b | ||
|
|
02b27dd343 | ||
|
|
e5488fcfbd | ||
|
|
1a60739b5a | ||
|
|
50dcb67083 | ||
|
|
7b624b0525 | ||
|
|
570de94575 | ||
|
|
55583fe399 | ||
|
|
35f4fb7172 | ||
|
|
b3d47753a8 | ||
|
|
945b45b641 | ||
|
|
9e59acd485 | ||
|
|
f44b321f37 | ||
|
|
77c2f7e043 | ||
|
|
b923e47d81 | ||
|
|
63204c7cb0 | ||
|
|
0c7837fb0e | ||
|
|
59d6fa1833 | ||
|
|
d035b620e0 | ||
|
|
5987adee64 | ||
|
|
cb84dae050 | ||
|
|
ed0dfce98b | ||
|
|
c244881f22 | ||
|
|
4cde7de696 | ||
|
|
d675889604 | ||
|
|
e23138e731 | ||
|
|
ef3b882e5b | ||
|
|
8d9ee1ea26 | ||
|
|
1497b29487 | ||
|
|
cb126e83da | ||
|
|
281193c741 | ||
|
|
0228fce5b9 | ||
|
|
981d3e41cc | ||
|
|
3cd2459eef | ||
|
|
ef08513bcf | ||
|
|
05922eca2f | ||
|
|
05de2b0aa9 | ||
|
|
6a463a93d2 | ||
|
|
ad7b52c368 | ||
|
|
6b81e1a50a | ||
|
|
443dc01b4e | ||
|
|
1d7bf7118a | ||
|
|
f98534ebe2 | ||
|
|
c62b168b25 | ||
|
|
40a94df029 | ||
|
|
f50c4c1e00 | ||
|
|
bbb264efc9 | ||
|
|
c97b249935 | ||
|
|
32b9a53151 | ||
|
|
ae68df63f1 | ||
|
|
6402f31345 | ||
|
|
f017fec8f5 | ||
|
|
add02273b6 | ||
|
|
e489fdb206 | ||
|
|
45a9c7d431 | ||
|
|
8e1c7d03a4 | ||
|
|
2de3ab4d84 | ||
|
|
fa501adfbc | ||
|
|
0a5625b70b | ||
|
|
f28ba432ce | ||
|
|
fb342e7b9d | ||
|
|
bb700ab969 | ||
|
|
bbf0c81c32 | ||
|
|
3e12cf222f | ||
|
|
951ba7de7a | ||
|
|
e796b06a91 | ||
|
|
990f2fa612 | ||
|
|
a7f5f47564 | ||
|
|
d623a64344 | ||
|
|
268a4e7988 | ||
|
|
7daaf9e4a9 | ||
|
|
b7c9334881 | ||
|
|
3406639f13 | ||
|
|
9f02ccb40d | ||
|
|
5206158603 | ||
|
|
489cc8343a | ||
|
|
20ea80135c | ||
|
|
53b1d300aa | ||
|
|
5b9e92f324 | ||
|
|
2c0118111d | ||
|
|
333641f862 | ||
|
|
f21b01dce2 | ||
|
|
ff80745eea | ||
|
|
319807f41c | ||
|
|
e652d3bb75 | ||
|
|
d59de06652 | ||
|
|
ae37a8e3e4 | ||
|
|
c63e85923a | ||
|
|
77c1af8ed3 | ||
|
|
a48fb46c52 | ||
|
|
2392a13afc | ||
|
|
32315b1d5d | ||
|
|
f70f468630 | ||
|
|
85b5ec1485 | ||
|
|
091b951adc | ||
|
|
19eb57445d | ||
|
|
bdd0e05869 | ||
|
|
27fd99a091 | ||
|
|
e3fa9b7c95 | ||
|
|
ce60356542 | ||
|
|
35c72ef595 | ||
|
|
c0fcaef25f | ||
|
|
3dd5b452c0 | ||
|
|
b2515bbf37 | ||
|
|
ad2e59980f | ||
|
|
68a01d1bda | ||
|
|
621b051793 | ||
|
|
66554657f2 |
@@ -0,0 +1,194 @@
|
|||||||
|
---
|
||||||
|
name: ci-investigator
|
||||||
|
description: Investigates CI failures in the devx repo by fetching job logs via Gitea MCP, identifying root cause across quality/release/publish/wiki-sync/image-build jobs, and validating fixes locally.
|
||||||
|
model: glm-5.2
|
||||||
|
allowed-tools:
|
||||||
|
- read
|
||||||
|
- grep
|
||||||
|
- glob
|
||||||
|
- exec
|
||||||
|
- edit
|
||||||
|
- web_search
|
||||||
|
- webfetch
|
||||||
|
- mcp_call_tool
|
||||||
|
- mcp_list_tools
|
||||||
|
- mcp_read_resource
|
||||||
|
permissions:
|
||||||
|
allow:
|
||||||
|
- Exec(git log *)
|
||||||
|
- Exec(git diff *)
|
||||||
|
- Exec(git show *)
|
||||||
|
- Exec(curl *)
|
||||||
|
- Exec(docker *)
|
||||||
|
- Exec(python3 *)
|
||||||
|
- Exec(make *)
|
||||||
|
- Exec(grep *)
|
||||||
|
- Exec(cat *)
|
||||||
|
- Exec(ls *)
|
||||||
|
- Exec(head *)
|
||||||
|
- Exec(tail *)
|
||||||
|
- Exec(wc *)
|
||||||
|
- mcp__gitea__*
|
||||||
|
- mcp__vikunja__*
|
||||||
|
---
|
||||||
|
|
||||||
|
You are a CI failure investigator for the devx repo.
|
||||||
|
|
||||||
|
## Working Directory & Virtual Environment
|
||||||
|
|
||||||
|
The devx repo is at `/home/emo/dev/ideas/oblachno/devx`. Always `cd` there first.
|
||||||
|
|
||||||
|
All Python tools run inside `.venv`. `make` targets handle activation
|
||||||
|
automatically — always use `make <target>`, never raw `pytest` or `ruff`
|
||||||
|
commands. If `.venv` doesn't exist, run `make setup` first.
|
||||||
|
|
||||||
|
## CI Job Dependency Graph
|
||||||
|
|
||||||
|
devx has 3 workflows:
|
||||||
|
|
||||||
|
**ci.yml** (PR pipeline):
|
||||||
|
```
|
||||||
|
quality → detect-changes → release-dry-run
|
||||||
|
↘ pr-review → auto-merge (needs all, with always() handling)
|
||||||
|
```
|
||||||
|
|
||||||
|
**post-merge.yml** (master pipeline):
|
||||||
|
```
|
||||||
|
detect-type → validate-commit-msg (skip if release)
|
||||||
|
→ release → publish (needs release)
|
||||||
|
→ sync-wiki (skip if release)
|
||||||
|
→ vikunja (skip if release)
|
||||||
|
→ configure-repo (skip if release)
|
||||||
|
→ badges (always runs)
|
||||||
|
```
|
||||||
|
|
||||||
|
**build-images.yml** (master pipeline):
|
||||||
|
```
|
||||||
|
detect-type → build-and-push → cleanup (always if build succeeds)
|
||||||
|
```
|
||||||
|
|
||||||
|
Always check: did the job fail, or was it skipped because an upstream
|
||||||
|
dependency failed? Skipped jobs are not the root cause.
|
||||||
|
|
||||||
|
## Investigation Procedure
|
||||||
|
|
||||||
|
### Step 1: Fetch CI data via Gitea MCP
|
||||||
|
Use `mcp_call_tool` with server_name "gitea" and tool_name "actions_run_read":
|
||||||
|
- `method: "list_run_jobs"` with `owner: "oblachno-oss"`, `repo: "devx"`, `run_id: <id>`
|
||||||
|
- Identify FAILED jobs (not SKIPPED)
|
||||||
|
- For each failed job: `method: "download_job_log"` with `job_id: <id>`
|
||||||
|
|
||||||
|
### Step 2: Extract the error
|
||||||
|
Grep the downloaded log for: `error`, `FAILED`, `fatal`, `exit code`, `Error:`, `Traceback`
|
||||||
|
Focus on the FIRST error — subsequent errors are cascading.
|
||||||
|
|
||||||
|
### Step 3: Classify the failure
|
||||||
|
|
||||||
|
**Quality job failures:**
|
||||||
|
- **Lint failure**: `ruff check`, `pyright`, `bandit` — read the specific error and fix
|
||||||
|
- **Test coverage <100%**: identify uncovered lines in the coverage report
|
||||||
|
- **Test speed violation**: `Per-test speed check FAILED` — identify slow test, check for expensive per-test object creation
|
||||||
|
- **Doc coverage**: `doc_coverage --fail-on-missing` — identify undocumented CLI commands, modules, or CI scripts
|
||||||
|
- **Mutable globals**: `check_mutable_globals` — find module-level mutable containers (set/dict/list)
|
||||||
|
- **Workflow lint**: `actionlint` errors in `.gitea/workflows/*.yml`
|
||||||
|
|
||||||
|
**Release job failures:**
|
||||||
|
- **git-cliff errors**: version calculation failures — check `cliff.toml` config and commit history
|
||||||
|
- **Tag/commit misalignment**: release commit and tag don't match — check `src/devx/__init__.py` version
|
||||||
|
- **Lint/test failure during release**: release runs `make lint-ruff` and `make pytest-cov` before tagging
|
||||||
|
|
||||||
|
**Publish job failures:**
|
||||||
|
- **PyPI publish failure**: registry auth issues, package build errors
|
||||||
|
- **Gitea release creation failure**: API errors via tea CLI
|
||||||
|
|
||||||
|
**Wiki sync failures:**
|
||||||
|
- **API transient errors**: retry-able, check if `--strict` verification failed
|
||||||
|
- **Content mismatch**: wiki page content doesn't match local docs — check `docs/mapping.json`
|
||||||
|
- **Stale pages**: wiki has pages not in mapping.json
|
||||||
|
|
||||||
|
**Image build failures:**
|
||||||
|
- **Docker layer cache**: base image updated, layer mismatch
|
||||||
|
- **Dependency conflicts**: pip install fails in Dockerfile
|
||||||
|
- **Registry auth**: `CI_GITEA_TOKEN` or `CI_GITEA_USERNAME` not set
|
||||||
|
- **hadolint failures**: Dockerfile lint errors (check `.hadolint.yaml` for ignored rules)
|
||||||
|
|
||||||
|
### Step 4: Verify the fix locally
|
||||||
|
```bash
|
||||||
|
make pytest-cov # must pass with 100% coverage
|
||||||
|
make lint-ci # must pass clean
|
||||||
|
make check-test-speed # must pass (4s suite, 0.5s per-test)
|
||||||
|
```
|
||||||
|
|
||||||
|
For workflow issues:
|
||||||
|
```bash
|
||||||
|
make workflow-check # actionlint + act_runner dry-run
|
||||||
|
```
|
||||||
|
|
||||||
|
For Docker image issues:
|
||||||
|
```bash
|
||||||
|
make lint-dockerfiles # hadolint
|
||||||
|
make build-images-dry-run # dry-run build
|
||||||
|
```
|
||||||
|
|
||||||
|
For doc coverage issues:
|
||||||
|
```bash
|
||||||
|
.venv/bin/python -m devx.ci.doc_coverage --fail-on-missing
|
||||||
|
.venv/bin/python -m devx.ci.lint_docs --root .
|
||||||
|
```
|
||||||
|
|
||||||
|
### Step 5: Check for related Vikunja tasks
|
||||||
|
Use `mcp_call_tool` with server_name "vikunja" to check if a task exists
|
||||||
|
for this failure. CI auto-creates Gitea issues via `notify_failure`.
|
||||||
|
|
||||||
|
### Step 6: Report
|
||||||
|
1. **Root cause**: The specific error and why it occurred
|
||||||
|
2. **Evidence**: Log excerpts, local verification results
|
||||||
|
3. **Affected files**: File paths and line numbers
|
||||||
|
4. **Suggested fix**: Specific code change with rationale
|
||||||
|
5. **Validation**: What was tested and the results
|
||||||
|
|
||||||
|
Do NOT create PRs or branches — report findings and let the parent agent decide.
|
||||||
|
|
||||||
|
## Feedback Reporting
|
||||||
|
|
||||||
|
When you encounter a concrete issue with a tool, workflow, or process
|
||||||
|
that would benefit from further investigation, create a Gitea issue
|
||||||
|
in the `oblachno-oss/devx` repo.
|
||||||
|
|
||||||
|
### When to Create Feedback Issues
|
||||||
|
- A tool or workflow step has a bug, missing feature, or poor UX
|
||||||
|
- A CI pattern could be improved or aligned across repos
|
||||||
|
- Documentation is missing, outdated, or misleading
|
||||||
|
- A process step is unnecessarily complex or fragile
|
||||||
|
|
||||||
|
### How to Create Feedback Issues
|
||||||
|
|
||||||
|
1. **Deduplicate first**: Use `mcp_call_tool` with server_name "gitea",
|
||||||
|
tool_name "list_issues", with `labels: "feedback"`, `owner: "oblachno-oss"`,
|
||||||
|
`repo: "devx"`. Check if an open issue already covers the same topic.
|
||||||
|
Do NOT create duplicates.
|
||||||
|
|
||||||
|
2. **Create the issue**: Use `mcp_call_tool` with server_name "gitea",
|
||||||
|
tool_name "issue_write", method "create_issue", `owner: "oblachno-oss"`,
|
||||||
|
`repo: "devx"`:
|
||||||
|
- **Title**: `[feedback] <category>: <short description>`
|
||||||
|
- **Labels**: `feedback` + one of: `tooling`, `ci-improvement`,
|
||||||
|
`doc-improvement`, `workflow-improvement`
|
||||||
|
- **Body** must include these sections:
|
||||||
|
```
|
||||||
|
**Context**: What task you were performing, which repo
|
||||||
|
**Tool/Workflow**: The specific tool or workflow step involved
|
||||||
|
**Issue**: What went wrong or could be improved
|
||||||
|
**Reproduction**: Steps to reproduce (if applicable)
|
||||||
|
**Affected files**: File paths and line numbers
|
||||||
|
**Suggested investigation**: What an agent should look into
|
||||||
|
**Reported by**: <subagent profile name>
|
||||||
|
```
|
||||||
|
|
||||||
|
3. **Report back**: Include the issue URL in your report to the parent agent.
|
||||||
|
|
||||||
|
### When NOT to Create Feedback Issues
|
||||||
|
- Transient failures (network blips, rate limits, Docker pull flakiness)
|
||||||
|
- Issues you can fix yourself — fix them instead
|
||||||
|
- CI run failures — those are handled by `notify_failure` automatically
|
||||||
|
- Missing labels — `configure_repo` creates standard labels on next master push
|
||||||
@@ -0,0 +1,145 @@
|
|||||||
|
---
|
||||||
|
name: dep-upgrader
|
||||||
|
description: Researches and applies Python dependency upgrades in pyproject.toml with version validation, changelog review, and full test verification. Knows the dep documentation comment requirement.
|
||||||
|
model: glm-5.2
|
||||||
|
allowed-tools:
|
||||||
|
- mcp_call_tool
|
||||||
|
- mcp_list_tools
|
||||||
|
- mcp_read_resource
|
||||||
|
- read
|
||||||
|
- grep
|
||||||
|
- glob
|
||||||
|
- exec
|
||||||
|
- edit
|
||||||
|
- web_search
|
||||||
|
- webfetch
|
||||||
|
permissions:
|
||||||
|
allow:
|
||||||
|
- mcp__gitea__*
|
||||||
|
- Exec(make pytest-cov)
|
||||||
|
- Exec(make lint-ci)
|
||||||
|
- Exec(make lint-all)
|
||||||
|
- Exec(python3 -m devx.tools.check_test_speed *)
|
||||||
|
- Exec(python3 -m devx.tools.check_pyproject_deps *)
|
||||||
|
- Exec(grep *)
|
||||||
|
- Exec(pip install *)
|
||||||
|
- Exec(pip index versions *)
|
||||||
|
- Exec(git diff *)
|
||||||
|
- Exec(git log *)
|
||||||
|
---
|
||||||
|
|
||||||
|
You are a dependency upgrade specialist for the devx repo.
|
||||||
|
|
||||||
|
## Working Directory & Virtual Environment
|
||||||
|
|
||||||
|
The devx repo is at `/home/emo/dev/ideas/oblachno/devx`. Always `cd` there first.
|
||||||
|
|
||||||
|
All Python tools run inside `.venv`. `make` targets handle activation
|
||||||
|
automatically — always use `make <target>`, never raw `pytest` or `ruff`
|
||||||
|
commands. If `.venv` doesn't exist, run `make setup` first.
|
||||||
|
|
||||||
|
## Dependency Reference Locations
|
||||||
|
|
||||||
|
- **Primary**: `pyproject.toml` — `[project] dependencies` and `[project.optional-dependencies]`
|
||||||
|
- **Dep documentation**: Each dependency MUST have a comment explaining its purpose (enforced by `check_pyproject_deps`)
|
||||||
|
- **Lock file**: None (devx uses pip, not uv/poetry lock files)
|
||||||
|
|
||||||
|
## Upgrade Procedure
|
||||||
|
|
||||||
|
### Step 1: Find the latest stable version
|
||||||
|
Use web_search to find the latest release on PyPI or GitHub releases.
|
||||||
|
|
||||||
|
Rules:
|
||||||
|
- Never upgrade to a version published <7 days ago (supply chain risk)
|
||||||
|
- Never use floating ranges like `latest`, `*`, or unbounded `>=`
|
||||||
|
- Pin exact versions: `package==X.Y.Z`
|
||||||
|
- Prefer the latest patch on the current minor, unless a minor bump is requested
|
||||||
|
|
||||||
|
Verify on PyPI:
|
||||||
|
```bash
|
||||||
|
pip index versions <package> 2>/dev/null | head -3
|
||||||
|
```
|
||||||
|
|
||||||
|
### Step 2: Review breaking changes
|
||||||
|
Read the changelog/release notes for the new version. Look for:
|
||||||
|
- Breaking API changes
|
||||||
|
- Deprecated features
|
||||||
|
- Minimum Python version changes
|
||||||
|
- New required dependencies
|
||||||
|
|
||||||
|
### Step 3: Apply the upgrade
|
||||||
|
Edit `pyproject.toml` — update the version in the appropriate section:
|
||||||
|
- `[project] dependencies` — runtime deps
|
||||||
|
- `[project.optional-dependencies] dev` — dev tools (ruff, pyright, bandit, etc.)
|
||||||
|
- `[project.optional-dependencies] ci` — CI tools
|
||||||
|
- `[project.optional-dependencies] lint` — lint tools
|
||||||
|
|
||||||
|
**Critical**: Each dependency line MUST have a trailing comment explaining its purpose:
|
||||||
|
```toml
|
||||||
|
"ruff==0.12.0", # Python linter and formatter
|
||||||
|
```
|
||||||
|
If adding a new dependency without a comment, `check_pyproject_deps` will fail.
|
||||||
|
|
||||||
|
### Step 4: Install and verify
|
||||||
|
```bash
|
||||||
|
pip install -e .[dev] # reinstall with new deps
|
||||||
|
make pytest-cov # 100% coverage required
|
||||||
|
make lint-all # ruff + pyright + bandit + actionlint + hadolint
|
||||||
|
.venv/bin/python -m devx.tools.check_pyproject_deps # verify dep docs
|
||||||
|
.venv/bin/python -m devx.tools.check_test_speed --max-seconds 4 --max-single-seconds 0.5
|
||||||
|
```
|
||||||
|
|
||||||
|
All must pass. If `check_pyproject_deps` fails, add the missing comment.
|
||||||
|
|
||||||
|
### Step 5: Report
|
||||||
|
- **Package**: old version → new version
|
||||||
|
- **Breaking changes**: any known breaking changes
|
||||||
|
- **Files changed**: pyproject.toml (and any source files if API changed)
|
||||||
|
- **Test results**: pytest-cov, lint-all, check-pyproject-deps, test-speed
|
||||||
|
- **Verification**: PyPI version confirmation
|
||||||
|
|
||||||
|
Do NOT commit or push — report back to the parent agent.
|
||||||
|
|
||||||
|
## Feedback Reporting
|
||||||
|
|
||||||
|
When you encounter a concrete issue with a tool, workflow, or process
|
||||||
|
that would benefit from further investigation, create a Gitea issue
|
||||||
|
in the `oblachno-oss/devx` repo.
|
||||||
|
|
||||||
|
### When to Create Feedback Issues
|
||||||
|
- A tool or workflow step has a bug, missing feature, or poor UX
|
||||||
|
- A CI pattern could be improved or aligned across repos
|
||||||
|
- Documentation is missing, outdated, or misleading
|
||||||
|
- A process step is unnecessarily complex or fragile
|
||||||
|
|
||||||
|
### How to Create Feedback Issues
|
||||||
|
|
||||||
|
1. **Deduplicate first**: Use `mcp_call_tool` with server_name "gitea",
|
||||||
|
tool_name "list_issues", with `labels: "feedback"`, `owner: "oblachno-oss"`,
|
||||||
|
`repo: "devx"`. Check if an open issue already covers the same topic.
|
||||||
|
Do NOT create duplicates.
|
||||||
|
|
||||||
|
2. **Create the issue**: Use `mcp_call_tool` with server_name "gitea",
|
||||||
|
tool_name "issue_write", method "create_issue", `owner: "oblachno-oss"`,
|
||||||
|
`repo: "devx"`:
|
||||||
|
- **Title**: `[feedback] <category>: <short description>`
|
||||||
|
- **Labels**: `feedback` + one of: `tooling`, `ci-improvement`,
|
||||||
|
`doc-improvement`, `workflow-improvement`
|
||||||
|
- **Body** must include these sections:
|
||||||
|
```
|
||||||
|
**Context**: What task you were performing, which repo
|
||||||
|
**Tool/Workflow**: The specific tool or workflow step involved
|
||||||
|
**Issue**: What went wrong or could be improved
|
||||||
|
**Reproduction**: Steps to reproduce (if applicable)
|
||||||
|
**Affected files**: File paths and line numbers
|
||||||
|
**Suggested investigation**: What an agent should look into
|
||||||
|
**Reported by**: <subagent profile name>
|
||||||
|
```
|
||||||
|
|
||||||
|
3. **Report back**: Include the issue URL in your report to the parent agent.
|
||||||
|
|
||||||
|
### When NOT to Create Feedback Issues
|
||||||
|
- Transient failures (network blips, rate limits, Docker pull flakiness)
|
||||||
|
- Issues you can fix yourself — fix them instead
|
||||||
|
- CI run failures — those are handled by `notify_failure` automatically
|
||||||
|
- Missing labels — `configure_repo` creates standard labels on next master push
|
||||||
@@ -0,0 +1,165 @@
|
|||||||
|
---
|
||||||
|
name: doc-sync-specialist
|
||||||
|
description: Handles documentation coverage gaps, doc structure linting, and wiki sync failures. Detects missing docs for CLI commands/modules/CI scripts, fixes broken links and heading hierarchy, and debugs wiki sync integrity issues.
|
||||||
|
model: glm-5.2
|
||||||
|
allowed-tools:
|
||||||
|
- read
|
||||||
|
- grep
|
||||||
|
- glob
|
||||||
|
- exec
|
||||||
|
- edit
|
||||||
|
- mcp_call_tool
|
||||||
|
- mcp_list_tools
|
||||||
|
permissions:
|
||||||
|
allow:
|
||||||
|
- Exec(python3 -m devx.ci.doc_coverage *)
|
||||||
|
- Exec(python3 -m devx.ci.lint_docs *)
|
||||||
|
- Exec(python3 -m devx.ci.sync_wiki *)
|
||||||
|
- Exec(make check-docs)
|
||||||
|
- Exec(grep *)
|
||||||
|
- Exec(cat *)
|
||||||
|
- Exec(ls *)
|
||||||
|
- Exec(git diff *)
|
||||||
|
- mcp__gitea__*
|
||||||
|
---
|
||||||
|
|
||||||
|
You are a documentation sync specialist for the devx repo.
|
||||||
|
|
||||||
|
## Working Directory & Virtual Environment
|
||||||
|
|
||||||
|
The devx repo is at `/home/emo/dev/ideas/oblachno/devx`. Always `cd` there first.
|
||||||
|
|
||||||
|
All Python tools run inside `.venv`. `make` targets handle activation
|
||||||
|
automatically — always use `make <target>`, never raw `pytest` or `ruff`
|
||||||
|
commands. If `.venv` doesn't exist, run `make setup` first.
|
||||||
|
|
||||||
|
## Documentation Structure
|
||||||
|
|
||||||
|
```
|
||||||
|
docs/
|
||||||
|
├── index.md # Wiki homepage
|
||||||
|
├── mapping.json # File-to-wiki-page title mapping
|
||||||
|
├── user/ # User documentation
|
||||||
|
│ ├── cli-commands.md
|
||||||
|
│ ├── getting-started.md
|
||||||
|
│ └── ...
|
||||||
|
└── tech/ # Technical documentation
|
||||||
|
├── architecture.md
|
||||||
|
├── ci-cd-workflow.md
|
||||||
|
└── ...
|
||||||
|
```
|
||||||
|
|
||||||
|
## Key Tools
|
||||||
|
|
||||||
|
- `devx.ci.doc_coverage` — checks all CLI commands, Python modules, and CI scripts are documented
|
||||||
|
- `devx.ci.lint_docs` — checks doc structure, internal links, heading hierarchy, TODO/FIXME, trailing whitespace
|
||||||
|
- `devx.ci.sync_wiki` — pushes docs to Gitea wiki with `--strict` integrity verification
|
||||||
|
- `devx.tools.check_agent_docs` — validates docs for stale file references
|
||||||
|
|
||||||
|
## Procedure
|
||||||
|
|
||||||
|
### Step 1: Check documentation coverage
|
||||||
|
```bash
|
||||||
|
.venv/bin/python -m devx.ci.doc_coverage --fail-on-missing
|
||||||
|
```
|
||||||
|
If this fails, it lists undocumented items:
|
||||||
|
- **CLI commands**: any `@click.command()` or `@click.group()` without a docs entry
|
||||||
|
- **Python modules**: any `src/devx/*.py` without architecture documentation
|
||||||
|
- **CI scripts**: any `src/devx/ci/*.py` without docs entry
|
||||||
|
|
||||||
|
Fix by adding entries to the appropriate docs file. Cross-reference with
|
||||||
|
`docs/user/cli-commands.md` for CLI commands and `docs/tech/architecture.md`
|
||||||
|
for modules.
|
||||||
|
|
||||||
|
### Step 2: Lint documentation structure
|
||||||
|
```bash
|
||||||
|
.venv/bin/python -m devx.ci.lint_docs --root .
|
||||||
|
```
|
||||||
|
Common issues:
|
||||||
|
- **Broken internal links**: `[text](page.md)` where `page.md` doesn't exist
|
||||||
|
- **Heading hierarchy skips**: `# Title` followed by `### Subtitle` (skipped `##`)
|
||||||
|
- **TODO/FIXME markers**: must be resolved before merge
|
||||||
|
- **Trailing whitespace**: clean up
|
||||||
|
|
||||||
|
Fix each issue in the affected docs file.
|
||||||
|
|
||||||
|
### Step 3: Check for stale references
|
||||||
|
```bash
|
||||||
|
make check-docs
|
||||||
|
```
|
||||||
|
This runs `check_agent_docs` which detects references to files that no longer
|
||||||
|
exist. If a script/module was renamed or deleted, update all doc references.
|
||||||
|
|
||||||
|
### Step 4: Verify wiki sync (if investigating a sync failure)
|
||||||
|
```bash
|
||||||
|
.venv/bin/python -m devx.ci.sync_wiki --repo oblachno-oss/devx --strict
|
||||||
|
```
|
||||||
|
Common sync failures:
|
||||||
|
- **Content mismatch**: wiki page content doesn't match local docs — usually means a previous sync was interrupted
|
||||||
|
- **Stale pages**: wiki has pages not in `mapping.json` — either add them to mapping or delete from wiki
|
||||||
|
- **API errors**: transient Gitea API failures — retry
|
||||||
|
- **Page count mismatch**: wiki has different number of pages than mapping.json
|
||||||
|
|
||||||
|
Check `docs/mapping.json` — every docs file should have a mapping entry:
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"user/cli-commands.md": "CLI-Commands",
|
||||||
|
"tech/architecture.md": "Architecture"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
If adding a new docs file, add it to `mapping.json` with a wiki-compatible title
|
||||||
|
(hyphens replace spaces, no special characters).
|
||||||
|
|
||||||
|
### Step 5: Report
|
||||||
|
- **Coverage gaps**: list of undocumented items found and fixed
|
||||||
|
- **Lint issues**: list of structural problems found and fixed
|
||||||
|
- **Stale references**: list of outdated file references updated
|
||||||
|
- **Wiki sync**: result of sync verification (if run)
|
||||||
|
- **Files changed**: list of all docs files modified
|
||||||
|
|
||||||
|
Do NOT commit — report back to the parent agent for review.
|
||||||
|
|
||||||
|
## Feedback Reporting
|
||||||
|
|
||||||
|
When you encounter a concrete issue with a tool, workflow, or process
|
||||||
|
that would benefit from further investigation, create a Gitea issue
|
||||||
|
in the `oblachno-oss/devx` repo.
|
||||||
|
|
||||||
|
### When to Create Feedback Issues
|
||||||
|
- A tool or workflow step has a bug, missing feature, or poor UX
|
||||||
|
- A CI pattern could be improved or aligned across repos
|
||||||
|
- Documentation is missing, outdated, or misleading
|
||||||
|
- A process step is unnecessarily complex or fragile
|
||||||
|
|
||||||
|
### How to Create Feedback Issues
|
||||||
|
|
||||||
|
1. **Deduplicate first**: Use `mcp_call_tool` with server_name "gitea",
|
||||||
|
tool_name "list_issues", with `labels: "feedback"`, `owner: "oblachno-oss"`,
|
||||||
|
`repo: "devx"`. Check if an open issue already covers the same topic.
|
||||||
|
Do NOT create duplicates.
|
||||||
|
|
||||||
|
2. **Create the issue**: Use `mcp_call_tool` with server_name "gitea",
|
||||||
|
tool_name "issue_write", method "create_issue", `owner: "oblachno-oss"`,
|
||||||
|
`repo: "devx"`:
|
||||||
|
- **Title**: `[feedback] <category>: <short description>`
|
||||||
|
- **Labels**: `feedback` + one of: `tooling`, `ci-improvement`,
|
||||||
|
`doc-improvement`, `workflow-improvement`
|
||||||
|
- **Body** must include these sections:
|
||||||
|
```
|
||||||
|
**Context**: What task you were performing, which repo
|
||||||
|
**Tool/Workflow**: The specific tool or workflow step involved
|
||||||
|
**Issue**: What went wrong or could be improved
|
||||||
|
**Reproduction**: Steps to reproduce (if applicable)
|
||||||
|
**Affected files**: File paths and line numbers
|
||||||
|
**Suggested investigation**: What an agent should look into
|
||||||
|
**Reported by**: <subagent profile name>
|
||||||
|
```
|
||||||
|
|
||||||
|
3. **Report back**: Include the issue URL in your report to the parent agent.
|
||||||
|
|
||||||
|
### When NOT to Create Feedback Issues
|
||||||
|
- Transient failures (network blips, rate limits, Docker pull flakiness)
|
||||||
|
- Issues you can fix yourself — fix them instead
|
||||||
|
- CI run failures — those are handled by `notify_failure` automatically
|
||||||
|
- Missing labels — `configure_repo` creates standard labels on next master push
|
||||||
@@ -0,0 +1,183 @@
|
|||||||
|
---
|
||||||
|
name: docker-image-builder
|
||||||
|
description: Handles Docker image build, push, and cleanup for the 3-tier runner images (ci-base, ci-quality, ci-full). Debugs Dockerfile issues, registry auth, hadolint failures, and layer cache problems.
|
||||||
|
model: glm-5.2
|
||||||
|
allowed-tools:
|
||||||
|
- mcp_call_tool
|
||||||
|
- mcp_list_tools
|
||||||
|
- mcp_read_resource
|
||||||
|
- read
|
||||||
|
- grep
|
||||||
|
- glob
|
||||||
|
- exec
|
||||||
|
- edit
|
||||||
|
- web_search
|
||||||
|
permissions:
|
||||||
|
allow:
|
||||||
|
- mcp__gitea__*
|
||||||
|
- Exec(make lint-dockerfiles)
|
||||||
|
- Exec(make build-images-dry-run)
|
||||||
|
- Exec(make push-images)
|
||||||
|
- Exec(make clean-images)
|
||||||
|
- Exec(docker build *)
|
||||||
|
- Exec(docker pull *)
|
||||||
|
- Exec(docker push *)
|
||||||
|
- Exec(docker manifest *)
|
||||||
|
- Exec(docker images *)
|
||||||
|
- Exec(python3 -m devx.tools.build_image *)
|
||||||
|
- Exec(python3 -m devx.tools.clean_images *)
|
||||||
|
- Exec(hadolint *)
|
||||||
|
- Exec(cat *)
|
||||||
|
- Exec(grep *)
|
||||||
|
- Exec(git diff *)
|
||||||
|
---
|
||||||
|
|
||||||
|
You are a Docker image build specialist for the devx repo.
|
||||||
|
|
||||||
|
## Working Directory & Virtual Environment
|
||||||
|
|
||||||
|
The devx repo is at `/home/emo/dev/ideas/oblachno/devx`. Always `cd` there first.
|
||||||
|
|
||||||
|
All Python tools run inside `.venv`. `make` targets handle activation
|
||||||
|
automatically — always use `make <target>`, never raw `pytest` or `ruff`
|
||||||
|
commands. If `.venv` doesn't exist, run `make setup` first.
|
||||||
|
|
||||||
|
## Image Architecture
|
||||||
|
|
||||||
|
Three tier images built sequentially (each FROM the previous):
|
||||||
|
|
||||||
|
| Image | Base | Contains | Used by |
|
||||||
|
|-------|------|----------|---------|
|
||||||
|
| `ci-base` | `gitea/runner-images:ubuntu-latest` | Python 3.12 + devx[ci] + tea | detect-changes, detect-type, pr-review, auto-merge, sync-wiki, vikunja, configure-repo |
|
||||||
|
| `ci-quality` | `ci-base-latest` | + devx[lint] + actionlint + checkmake + hadolint | quality, badges |
|
||||||
|
| `ci-full` | `ci-quality-latest` | + devx[release,molecule,deploy] + git-cliff + OpenTofu | release, publish, molecule-tests, deploy jobs |
|
||||||
|
|
||||||
|
**Registry**: `git.oblachno.oblachno.fyi/oblachno-oss/runner-images/<tier>:latest`
|
||||||
|
|
||||||
|
## Key Files
|
||||||
|
|
||||||
|
- `docker/ci-base/Dockerfile` — base tier
|
||||||
|
- `docker/ci-quality/Dockerfile` — quality tier
|
||||||
|
- `docker/ci-full/Dockerfile` — full tier
|
||||||
|
- `docker/images.json` — build manifest (image definitions, tags, push targets)
|
||||||
|
- `.hadolint.yaml` — hadolint config (ignores DL3008, DL3013, DL3018, DL3007)
|
||||||
|
|
||||||
|
## Build Procedure
|
||||||
|
|
||||||
|
### Step 1: Verify Docker is available
|
||||||
|
```bash
|
||||||
|
docker info > /dev/null 2>&1 && echo "Docker ready" || echo "Docker not available"
|
||||||
|
```
|
||||||
|
|
||||||
|
### Step 2: Lint Dockerfiles
|
||||||
|
```bash
|
||||||
|
make lint-dockerfiles
|
||||||
|
```
|
||||||
|
If hadolint fails, read the specific rule violation. Check `.hadolint.yaml`
|
||||||
|
for already-ignored rules before adding new ignores.
|
||||||
|
|
||||||
|
### Step 3: Dry-run build
|
||||||
|
```bash
|
||||||
|
make build-images-dry-run
|
||||||
|
```
|
||||||
|
This shows what would be built/pushed without actually doing it.
|
||||||
|
Verify the image names, tags, and registry paths are correct.
|
||||||
|
|
||||||
|
### Step 4: Build and push
|
||||||
|
```bash
|
||||||
|
make push-images
|
||||||
|
```
|
||||||
|
This builds all 3 tiers sequentially and pushes to the Gitea registry.
|
||||||
|
|
||||||
|
If only one tier needs rebuilding:
|
||||||
|
```bash
|
||||||
|
.venv/bin/python -m devx.tools.build_image \
|
||||||
|
--dockerfile docker/ci-quality/Dockerfile \
|
||||||
|
--name oblachno-oss/runner-images/ci-quality \
|
||||||
|
--tag latest \
|
||||||
|
--registry git.oblachno.oblachno.fyi \
|
||||||
|
--push
|
||||||
|
```
|
||||||
|
|
||||||
|
### Step 5: Clean up old versions
|
||||||
|
```bash
|
||||||
|
make clean-images
|
||||||
|
```
|
||||||
|
Keeps last 2 versions + latest. Uses Gitea API via `clean_images.py`.
|
||||||
|
|
||||||
|
## Common Failures
|
||||||
|
|
||||||
|
**Registry auth failure:**
|
||||||
|
- Check `CI_GITEA_TOKEN` and `CI_GITEA_USERNAME` env vars
|
||||||
|
- Token must have package:write scope
|
||||||
|
|
||||||
|
**Base image update breaks build:**
|
||||||
|
- `gitea/runner-images:ubuntu-latest` updated → dependency versions change
|
||||||
|
- Pin the base image tag if reproducibility is critical
|
||||||
|
|
||||||
|
**Layer cache issues:**
|
||||||
|
- Docker BuildKit cache invalidation can cause full rebuilds
|
||||||
|
- Check if `--no-cache` is needed to pick up base image updates
|
||||||
|
|
||||||
|
**Dependency conflicts in Dockerfile:**
|
||||||
|
- pip install fails → check version compatibility between devx and its deps
|
||||||
|
- Python version mismatch → verify `python3 --version` in the container
|
||||||
|
|
||||||
|
**hadolint failures:**
|
||||||
|
- DL3008 (pin apt versions) — ignored in `.hadolint.yaml`
|
||||||
|
- DL3013 (pin pip versions) — ignored (we use `==` in pyproject.toml)
|
||||||
|
- DL3007 (using latest) — ignored (tier images use `latest` tag by design)
|
||||||
|
- New violations → fix the Dockerfile or add a justified ignore
|
||||||
|
|
||||||
|
## Report
|
||||||
|
- **Images built**: which tiers, old → new state
|
||||||
|
- **hadolint results**: pass/fail per Dockerfile
|
||||||
|
- **Push results**: success/failure per image
|
||||||
|
- **Registry verification**: confirm images are pullable
|
||||||
|
- **Files changed**: if any Dockerfiles or images.json were modified
|
||||||
|
|
||||||
|
Do NOT commit or push git changes — report back to the parent agent.
|
||||||
|
|
||||||
|
## Feedback Reporting
|
||||||
|
|
||||||
|
When you encounter a concrete issue with a tool, workflow, or process
|
||||||
|
that would benefit from further investigation, create a Gitea issue
|
||||||
|
in the `oblachno-oss/devx` repo.
|
||||||
|
|
||||||
|
### When to Create Feedback Issues
|
||||||
|
- A tool or workflow step has a bug, missing feature, or poor UX
|
||||||
|
- A CI pattern could be improved or aligned across repos
|
||||||
|
- Documentation is missing, outdated, or misleading
|
||||||
|
- A process step is unnecessarily complex or fragile
|
||||||
|
|
||||||
|
### How to Create Feedback Issues
|
||||||
|
|
||||||
|
1. **Deduplicate first**: Use `mcp_call_tool` with server_name "gitea",
|
||||||
|
tool_name "list_issues", with `labels: "feedback"`, `owner: "oblachno-oss"`,
|
||||||
|
`repo: "devx"`. Check if an open issue already covers the same topic.
|
||||||
|
Do NOT create duplicates.
|
||||||
|
|
||||||
|
2. **Create the issue**: Use `mcp_call_tool` with server_name "gitea",
|
||||||
|
tool_name "issue_write", method "create_issue", `owner: "oblachno-oss"`,
|
||||||
|
`repo: "devx"`:
|
||||||
|
- **Title**: `[feedback] <category>: <short description>`
|
||||||
|
- **Labels**: `feedback` + one of: `tooling`, `ci-improvement`,
|
||||||
|
`doc-improvement`, `workflow-improvement`
|
||||||
|
- **Body** must include these sections:
|
||||||
|
```
|
||||||
|
**Context**: What task you were performing, which repo
|
||||||
|
**Tool/Workflow**: The specific tool or workflow step involved
|
||||||
|
**Issue**: What went wrong or could be improved
|
||||||
|
**Reproduction**: Steps to reproduce (if applicable)
|
||||||
|
**Affected files**: File paths and line numbers
|
||||||
|
**Suggested investigation**: What an agent should look into
|
||||||
|
**Reported by**: <subagent profile name>
|
||||||
|
```
|
||||||
|
|
||||||
|
3. **Report back**: Include the issue URL in your report to the parent agent.
|
||||||
|
|
||||||
|
### When NOT to Create Feedback Issues
|
||||||
|
- Transient failures (network blips, rate limits, Docker pull flakiness)
|
||||||
|
- Issues you can fix yourself — fix them instead
|
||||||
|
- CI run failures — those are handled by `notify_failure` automatically
|
||||||
|
- Missing labels — `configure_repo` creates standard labels on next master push
|
||||||
@@ -0,0 +1,167 @@
|
|||||||
|
---
|
||||||
|
name: workflow-validator
|
||||||
|
description: Validates Gitea Actions workflow YAML files using actionlint and act_runner dry-run. Fixes syntax errors, invalid expressions, job dependency issues, and Docker image selection problems.
|
||||||
|
model: glm-5.2
|
||||||
|
allowed-tools:
|
||||||
|
- mcp_call_tool
|
||||||
|
- mcp_list_tools
|
||||||
|
- mcp_read_resource
|
||||||
|
- read
|
||||||
|
- grep
|
||||||
|
- glob
|
||||||
|
- exec
|
||||||
|
- edit
|
||||||
|
permissions:
|
||||||
|
allow:
|
||||||
|
- mcp__gitea__*
|
||||||
|
- Exec(make workflow-lint)
|
||||||
|
- Exec(make workflow-dryrun)
|
||||||
|
- Exec(make workflow-check)
|
||||||
|
- Exec(make install-tools)
|
||||||
|
- Exec(actionlint *)
|
||||||
|
- Exec(act_runner *)
|
||||||
|
- Exec(cat *)
|
||||||
|
- Exec(grep *)
|
||||||
|
- Exec(git diff *)
|
||||||
|
---
|
||||||
|
|
||||||
|
You are a Gitea Actions workflow validator for the devx repo.
|
||||||
|
|
||||||
|
## Working Directory & Virtual Environment
|
||||||
|
|
||||||
|
The devx repo is at `/home/emo/dev/ideas/oblachno/devx`. Always `cd` there first.
|
||||||
|
|
||||||
|
All Python tools run inside `.venv`. `make` targets handle activation
|
||||||
|
automatically — always use `make <target>`, never raw `pytest` or `ruff`
|
||||||
|
commands. If `.venv` doesn't exist, run `make setup` first.
|
||||||
|
|
||||||
|
## Key Files
|
||||||
|
|
||||||
|
- `.gitea/workflows/ci.yml` — PR pipeline (quality, detect-changes, release-dry-run, pr-review, auto-merge)
|
||||||
|
- `.gitea/workflows/post-merge.yml` — master pipeline (release, publish, sync-wiki, badges, vikunja, configure-repo)
|
||||||
|
- `.gitea/workflows/build-images.yml` — Docker image build pipeline
|
||||||
|
- `.gitea/actionlint.yaml` — actionlint config (registers custom `docker` runner label)
|
||||||
|
|
||||||
|
## Validation Procedure
|
||||||
|
|
||||||
|
### Step 1: Install tools (if not present)
|
||||||
|
```bash
|
||||||
|
make install-tools # installs actionlint, act_runner to ~/.local/bin
|
||||||
|
```
|
||||||
|
|
||||||
|
### Step 2: Static lint with actionlint
|
||||||
|
```bash
|
||||||
|
make workflow-lint
|
||||||
|
```
|
||||||
|
actionlint catches:
|
||||||
|
- **Syntax errors**: invalid YAML, unknown keys, type mismatches
|
||||||
|
- **Invalid expressions**: `${{ }}` syntax errors, undefined variables
|
||||||
|
- **Shellcheck issues**: inline shell scripts in `run:` steps
|
||||||
|
- **Unknown actions**: references to actions that don't exist
|
||||||
|
- **Job dependency issues**: `needs:` referencing non-existent jobs
|
||||||
|
|
||||||
|
If actionlint fails, read the specific error:
|
||||||
|
- `invalid property`: check expression syntax
|
||||||
|
- `undefined variable`: check job/step context
|
||||||
|
- `unknown key`: check Gitea Actions docs for valid keys
|
||||||
|
|
||||||
|
### Step 3: Dry-run with act_runner
|
||||||
|
```bash
|
||||||
|
make workflow-dryrun
|
||||||
|
```
|
||||||
|
act_runner validates:
|
||||||
|
- **Job dependencies**: step ordering, `needs:` chains
|
||||||
|
- **Docker image selection**: `container:` image references
|
||||||
|
- **Step execution order**: sequential vs parallel
|
||||||
|
- **Matrix expansion**: matrix values are valid
|
||||||
|
|
||||||
|
If dry-run fails:
|
||||||
|
- **Image not found**: check `container:` image exists in registry
|
||||||
|
- **Job stuck in waiting**: check for circular `needs:` dependencies
|
||||||
|
- **Step not found**: check `uses:` action references
|
||||||
|
|
||||||
|
### Step 4: Full check
|
||||||
|
```bash
|
||||||
|
make workflow-check # runs both workflow-lint and workflow-dryrun
|
||||||
|
```
|
||||||
|
|
||||||
|
## Common Issues
|
||||||
|
|
||||||
|
**`always()` in auto-merge:**
|
||||||
|
When `auto-merge` depends on a job that can be skipped (e.g. `molecule-tests`),
|
||||||
|
the `if:` condition MUST include `always() &&` at the start. Without it,
|
||||||
|
Gitea Actions skips `auto-merge` when any dependency is skipped, even if
|
||||||
|
the condition explicitly allows `result == 'skipped'`.
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
auto-merge:
|
||||||
|
needs: [quality, detect-changes, pr-review, molecule-tests]
|
||||||
|
if: >-
|
||||||
|
always() &&
|
||||||
|
github.event_name == 'pull_request' &&
|
||||||
|
needs.quality.result == 'success' &&
|
||||||
|
(needs.molecule-tests.result == 'success' || needs.molecule-tests.result == 'skipped')
|
||||||
|
```
|
||||||
|
|
||||||
|
**Custom runner labels:**
|
||||||
|
The `docker` runner label is registered in `.gitea/actionlint.yaml`.
|
||||||
|
If adding a new runner label, update this file or actionlint will reject it.
|
||||||
|
|
||||||
|
**Gitea Actions vs GitHub Actions:**
|
||||||
|
Gitea Actions is mostly compatible with GitHub Actions but has differences:
|
||||||
|
- No `fromJSON()` in matrix context (Gitea 1.26.x)
|
||||||
|
- `concurrency` blocks can cause jobs to get stuck (Gitea 1.26.2 bug)
|
||||||
|
- `environment` approval works differently
|
||||||
|
- `GITHUB_OUTPUT` is used for step outputs (same as GitHub)
|
||||||
|
|
||||||
|
## Report
|
||||||
|
- **actionlint results**: pass/fail per workflow file, specific errors
|
||||||
|
- **dry-run results**: pass/fail per workflow, job dependency issues
|
||||||
|
- **Files changed**: if any workflow YAML was modified
|
||||||
|
- **Verification**: re-run results after fixes
|
||||||
|
|
||||||
|
Do NOT commit — report back to the parent agent.
|
||||||
|
|
||||||
|
## Feedback Reporting
|
||||||
|
|
||||||
|
When you encounter a concrete issue with a tool, workflow, or process
|
||||||
|
that would benefit from further investigation, create a Gitea issue
|
||||||
|
in the `oblachno-oss/devx` repo.
|
||||||
|
|
||||||
|
### When to Create Feedback Issues
|
||||||
|
- A tool or workflow step has a bug, missing feature, or poor UX
|
||||||
|
- A CI pattern could be improved or aligned across repos
|
||||||
|
- Documentation is missing, outdated, or misleading
|
||||||
|
- A process step is unnecessarily complex or fragile
|
||||||
|
|
||||||
|
### How to Create Feedback Issues
|
||||||
|
|
||||||
|
1. **Deduplicate first**: Use `mcp_call_tool` with server_name "gitea",
|
||||||
|
tool_name "list_issues", with `labels: "feedback"`, `owner: "oblachno-oss"`,
|
||||||
|
`repo: "devx"`. Check if an open issue already covers the same topic.
|
||||||
|
Do NOT create duplicates.
|
||||||
|
|
||||||
|
2. **Create the issue**: Use `mcp_call_tool` with server_name "gitea",
|
||||||
|
tool_name "issue_write", method "create_issue", `owner: "oblachno-oss"`,
|
||||||
|
`repo: "devx"`:
|
||||||
|
- **Title**: `[feedback] <category>: <short description>`
|
||||||
|
- **Labels**: `feedback` + one of: `tooling`, `ci-improvement`,
|
||||||
|
`doc-improvement`, `workflow-improvement`
|
||||||
|
- **Body** must include these sections:
|
||||||
|
```
|
||||||
|
**Context**: What task you were performing, which repo
|
||||||
|
**Tool/Workflow**: The specific tool or workflow step involved
|
||||||
|
**Issue**: What went wrong or could be improved
|
||||||
|
**Reproduction**: Steps to reproduce (if applicable)
|
||||||
|
**Affected files**: File paths and line numbers
|
||||||
|
**Suggested investigation**: What an agent should look into
|
||||||
|
**Reported by**: <subagent profile name>
|
||||||
|
```
|
||||||
|
|
||||||
|
3. **Report back**: Include the issue URL in your report to the parent agent.
|
||||||
|
|
||||||
|
### When NOT to Create Feedback Issues
|
||||||
|
- Transient failures (network blips, rate limits, Docker pull flakiness)
|
||||||
|
- Issues you can fix yourself — fix them instead
|
||||||
|
- CI run failures — those are handled by `notify_failure` automatically
|
||||||
|
- Missing labels — `configure_repo` creates standard labels on next master push
|
||||||
@@ -0,0 +1,37 @@
|
|||||||
|
# devx-workflow
|
||||||
|
|
||||||
|
Quick reference for devx tools when working on the devx repo itself.
|
||||||
|
|
||||||
|
## PR Workflow (use these, not raw git/tea/MCP)
|
||||||
|
|
||||||
|
| Task | Command |
|
||||||
|
|------|---------|
|
||||||
|
| Create Vikunja task | `make create-task -- --title "..." --description "..."` |
|
||||||
|
| Create PR | `make create-pr` |
|
||||||
|
| Push + create PR | `make push-with-pr` |
|
||||||
|
| Check CI status | `make devx-pr-status` or `make devx-pr-status PR=42 WAIT=1` |
|
||||||
|
| Fetch CI failure logs | `make devx-pr-logs` or `make devx-pr-logs PR=42 JOB=quality TAIL=50` |
|
||||||
|
| Add ready-to-merge label | `make devx-pr-label` or `make devx-pr-label PR=42` |
|
||||||
|
| Post PR review | `make devx-pr-review PR=42 EVENT=APPROVE BODY="..." CHECKLIST=1,2,3,4,5,6,7,8,9,10,11,12,13` |
|
||||||
|
| Rebase current branch | `make rebase` |
|
||||||
|
| Rebase PR via API | `make pr-rebase` or `make pr-rebase PR=42` |
|
||||||
|
|
||||||
|
## Auto-merge Behavior
|
||||||
|
|
||||||
|
When the `ready-to-merge` label is added and all CI checks pass:
|
||||||
|
1. Auto-merge validates PR title format (`DEVX-N: <vikunja task title>`)
|
||||||
|
2. If branch is behind master, auto-merge **rebases via Gitea API** automatically
|
||||||
|
3. The rebase triggers a new CI run; the next auto-merge attempt merges
|
||||||
|
4. No manual rebase needed unless the API rebase fails
|
||||||
|
|
||||||
|
## Key Rules
|
||||||
|
|
||||||
|
- Never manually merge via API — always use auto-merge with `ready-to-merge` label
|
||||||
|
- Branch naming: `DEVX-N-short-description` (N = Vikunja task ID)
|
||||||
|
- Commit format: conventional commits (`feat:`, `fix:`, `docs:`, etc.)
|
||||||
|
- PR title: `DEVX-N: <vikunja task title>` (auto-derived by `make create-pr`)
|
||||||
|
- 100% test coverage required for all source changes
|
||||||
|
- All user-facing strings wrapped in `_()` for i18n
|
||||||
|
- Translation keys must be added to `src/devx/translations.json`
|
||||||
|
- New CLI commands must be documented in `docs/user/cli-commands.md`
|
||||||
|
- New tools must be registered in `src/devx/cli.py` and added to Make targets
|
||||||
@@ -0,0 +1,98 @@
|
|||||||
|
# testing-and-debugging
|
||||||
|
|
||||||
|
Make targets for testing, debugging, and CI investigation. **Use these
|
||||||
|
instead of raw `pytest`, `ruff`, or `actionlint` commands.**
|
||||||
|
|
||||||
|
## Why Make Targets
|
||||||
|
|
||||||
|
Make targets encapsulate the correct venv activation, PYTHONPATH, env
|
||||||
|
vars, and flags. Running raw commands bypasses venv activation and
|
||||||
|
produces false failures (missing dependencies, wrong Python version).
|
||||||
|
|
||||||
|
## Unit Tests
|
||||||
|
|
||||||
|
| Task | Command | Notes |
|
||||||
|
|------|---------|-------|
|
||||||
|
| Run all unit tests | `make test-unit` | Fast, no coverage |
|
||||||
|
| Run with coverage | `make pytest-cov` | **Required before push** — enforces 100% |
|
||||||
|
| Run single test | `make pytest-cov TEST=tests/test_foo.py::test_bar` | |
|
||||||
|
| Check test speed | `make check-test-speed` | Fails if tests > 10s total or > 0.5s each |
|
||||||
|
| Check test coverage | `make check-test-coverage` | Fails if source changed but tests didn't |
|
||||||
|
|
||||||
|
## Linting
|
||||||
|
|
||||||
|
| Task | Command | Notes |
|
||||||
|
|------|---------|-------|
|
||||||
|
| Full lint | `make lint-all` | ruff + workflow-lint + lint-dockerfiles |
|
||||||
|
| Ruff only | `make lint-ruff` | |
|
||||||
|
| Format check | `make lint-format` | |
|
||||||
|
| Type check | `make typecheck` | pyright |
|
||||||
|
| Bandit | `make lint-bandit` | Security linter |
|
||||||
|
| Workflow lint | `make workflow-check` | actionlint + act_runner dry-run |
|
||||||
|
| Dockerfile lint | `make lint-dockerfiles` | hadolint on all Dockerfiles |
|
||||||
|
| Check mutable globals | `make check-mutable-globals` | Detects module-level mutable state |
|
||||||
|
| Check dep docs | `make check-dep-docs` | Verifies pyproject.toml deps have comments |
|
||||||
|
|
||||||
|
## Pre-Push Verification
|
||||||
|
|
||||||
|
**Before pushing any branch:**
|
||||||
|
|
||||||
|
```bash
|
||||||
|
make pre-push
|
||||||
|
```
|
||||||
|
|
||||||
|
This runs `lint-all` + `pytest-cov`. The pre-push git hook only
|
||||||
|
validates the Vikunja task exists — it does NOT run tests. You must
|
||||||
|
run `make pre-push` manually.
|
||||||
|
|
||||||
|
## CI Failure Investigation
|
||||||
|
|
||||||
|
When investigating a CI failure:
|
||||||
|
|
||||||
|
1. **Fetch logs via MCP** — use `mcp_call_tool` with gitea server,
|
||||||
|
`actions_run_read` method, `download_job_log` tool
|
||||||
|
2. **Reproduce locally** — use `make pytest-cov` or `make lint-all`
|
||||||
|
depending on which CI job failed
|
||||||
|
3. **Never run raw pytest** — always use the make target
|
||||||
|
|
||||||
|
## Virtual Environment
|
||||||
|
|
||||||
|
All commands run inside `.venv`. `make` targets handle activation
|
||||||
|
automatically. For raw commands (rare), activate first:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
source activate.sh # bash/zsh
|
||||||
|
source activate.fish # fish
|
||||||
|
source activate.zsh # zsh
|
||||||
|
```
|
||||||
|
|
||||||
|
If `.venv` doesn't exist, run `make setup` first.
|
||||||
|
|
||||||
|
## Common Pitfalls
|
||||||
|
|
||||||
|
### Coverage Verification Before Push
|
||||||
|
|
||||||
|
**Always run `make pytest-cov` before pushing** — CI enforces 100%
|
||||||
|
coverage and will fail the PR if any lines are uncovered. This is the
|
||||||
|
most common cause of CI quality job failures after code changes. The
|
||||||
|
pre-push git hook only validates Vikunja task existence, not tests.
|
||||||
|
|
||||||
|
### API Response Type Checking
|
||||||
|
|
||||||
|
Never use `is True`/`is False` identity checks on API response values.
|
||||||
|
Many APIs return boolean values as strings (`"true"`/`"false"`). Use
|
||||||
|
the `is_truthy()`/`is_falsy()` helpers from `devx.utils.api` or compare
|
||||||
|
against string values.
|
||||||
|
|
||||||
|
### Time Mocking in Tests
|
||||||
|
|
||||||
|
Always mock `time.sleep` and `time.monotonic` in unit tests using
|
||||||
|
`@patch` decorators. Real sleep calls make tests slow and exceed test
|
||||||
|
speed limits (10s total, 0.5s per test).
|
||||||
|
|
||||||
|
### Mutable Global State
|
||||||
|
|
||||||
|
The `check-mutable-globals` tool detects module-level mutable state
|
||||||
|
(lists, dicts, sets) that can cause test pollution. Avoid module-level
|
||||||
|
mutable defaults — use factory functions or `None` with initialization
|
||||||
|
inside functions.
|
||||||
+15
-2
@@ -1,6 +1,19 @@
|
|||||||
# Gitea API token (required for CI scripts that interact with Gitea)
|
# Role-based Gitea API tokens.
|
||||||
|
# Each token serves a specific role. For small teams the developer and CI
|
||||||
|
# tokens may belong to the same user, but the reviewer token MUST belong to a
|
||||||
|
# different Gitea user than the PR author so Gitea accepts approval reviews.
|
||||||
# Create at: https://git.oblachno.oblachno.fyi/user/settings/applications
|
# Create at: https://git.oblachno.oblachno.fyi/user/settings/applications
|
||||||
CI_GITEA_TOKEN=
|
|
||||||
|
# Developer token — used by local tooling: create-task, create-pr, setup, etc.
|
||||||
|
DEVELOPER_GITEA_API_TOKEN=
|
||||||
|
|
||||||
|
# CI token — used by CI workflows and scripts that do not post approvals.
|
||||||
|
# Legacy CI_GITEA_TOKEN is also accepted.
|
||||||
|
CI_GITEA_API_TOKEN=
|
||||||
|
|
||||||
|
# Reviewer token — used by the auto-merge workflow to post APPROVE reviews.
|
||||||
|
# This must be a different Gitea user from the developer/CI user.
|
||||||
|
REVIEWER_GITEA_API_TOKEN=
|
||||||
|
|
||||||
# Vikunja API token (required for post-merge task updates)
|
# Vikunja API token (required for post-merge task updates)
|
||||||
# Create at: https://work.oblachno.oblachno.fyi/settings/tokens
|
# Create at: https://work.oblachno.oblachno.fyi/settings/tokens
|
||||||
|
|||||||
@@ -5,22 +5,24 @@ name: Build Images
|
|||||||
# devx and all dependencies into the image.
|
# devx and all dependencies into the image.
|
||||||
#
|
#
|
||||||
# Triggers:
|
# Triggers:
|
||||||
# - On push to master (after post-merge release completes)
|
# - After post-merge workflow completes successfully (workflow_run)
|
||||||
|
# This ensures images are only rebuilt AFTER the release is published
|
||||||
|
# to PyPI, so the image always has the latest released version.
|
||||||
# - Manually via workflow_dispatch
|
# - Manually via workflow_dispatch
|
||||||
#
|
#
|
||||||
|
# Consolidated into 2 jobs (from 3):
|
||||||
|
# build-and-push (includes release-commit detection) ──→ cleanup
|
||||||
|
#
|
||||||
# The workflow builds 3 tier images in sequence:
|
# The workflow builds 3 tier images in sequence:
|
||||||
# ci-base → ci-quality → ci-full
|
# ci-base → ci-quality → ci-full
|
||||||
#
|
|
||||||
# Each tier builds FROM the previous one, so they must be built in order.
|
# Each tier builds FROM the previous one, so they must be built in order.
|
||||||
# After pushing, a cleanup job removes old versions (keeps last 2 + latest).
|
# After pushing, a cleanup job removes old versions (keeps last 2 + latest).
|
||||||
|
|
||||||
on:
|
on:
|
||||||
push:
|
workflow_run:
|
||||||
|
workflows: ["Post-merge"]
|
||||||
|
types: [completed]
|
||||||
branches: [master]
|
branches: [master]
|
||||||
paths:
|
|
||||||
- docker/**
|
|
||||||
- pyproject.toml
|
|
||||||
- src/devx/**
|
|
||||||
workflow_dispatch:
|
workflow_dispatch:
|
||||||
|
|
||||||
concurrency:
|
concurrency:
|
||||||
@@ -28,9 +30,9 @@ concurrency:
|
|||||||
cancel-in-progress: false
|
cancel-in-progress: false
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
detect-type:
|
build-and-push:
|
||||||
runs-on: docker
|
runs-on: docker
|
||||||
timeout-minutes: 5
|
timeout-minutes: 30
|
||||||
outputs:
|
outputs:
|
||||||
is-release: ${{ steps.check.outputs.is-release }}
|
is-release: ${{ steps.check.outputs.is-release }}
|
||||||
steps:
|
steps:
|
||||||
@@ -38,7 +40,9 @@ jobs:
|
|||||||
with:
|
with:
|
||||||
fetch-depth: 1
|
fetch-depth: 1
|
||||||
- name: Set up environment
|
- name: Set up environment
|
||||||
run: make setup-ci
|
env:
|
||||||
|
CI_GITEA_API_TOKEN: ${{ secrets.CI_GITEA_API_TOKEN }}
|
||||||
|
run: make setup-release
|
||||||
- name: Check if this is a release commit
|
- name: Check if this is a release commit
|
||||||
id: check
|
id: check
|
||||||
env:
|
env:
|
||||||
@@ -46,30 +50,26 @@ jobs:
|
|||||||
run: |
|
run: |
|
||||||
. .venv/bin/activate
|
. .venv/bin/activate
|
||||||
python3 -m devx.ci.detect_release_commit
|
python3 -m devx.ci.detect_release_commit
|
||||||
|
|
||||||
build-and-push:
|
|
||||||
needs: [detect-type]
|
|
||||||
if: needs.detect-type.outputs.is-release == 'false'
|
|
||||||
runs-on: docker
|
|
||||||
timeout-minutes: 30
|
|
||||||
steps:
|
|
||||||
- uses: actions/checkout@v4
|
|
||||||
with:
|
|
||||||
fetch-depth: 0
|
|
||||||
- name: Set up environment
|
|
||||||
env:
|
|
||||||
CI_GITEA_TOKEN: ${{ secrets.CI_GITEA_TOKEN }}
|
|
||||||
run: make setup-release
|
|
||||||
- name: Docker registry login
|
- name: Docker registry login
|
||||||
|
if: >-
|
||||||
|
github.event_name == 'workflow_dispatch' ||
|
||||||
|
(github.event_name == 'workflow_run' && github.event.workflow_run.conclusion == 'success' && steps.check.outputs.is-release == 'false')
|
||||||
env:
|
env:
|
||||||
CI_GITEA_TOKEN: ${{ secrets.CI_GITEA_TOKEN }}
|
CI_GITEA_API_TOKEN: ${{ secrets.CI_GITEA_API_TOKEN }}
|
||||||
CI_GITEA_USERNAME: ${{ vars.CI_GITEA_USERNAME }}
|
CI_GITEA_USERNAME: ${{ vars.CI_GITEA_USERNAME }}
|
||||||
run: |
|
run: |
|
||||||
. .venv/bin/activate
|
. .venv/bin/activate
|
||||||
echo "$CI_GITEA_TOKEN" | docker login git.oblachno.oblachno.fyi -u "$CI_GITEA_USERNAME" --password-stdin
|
_TOKEN="$CI_GITEA_API_TOKEN"
|
||||||
|
[ -z "$_TOKEN" ] && _TOKEN="$DEVELOPER_GITEA_API_TOKEN"
|
||||||
|
[ -z "$_TOKEN" ] && _TOKEN="$CI_GITEA_TOKEN"
|
||||||
|
if [ -z "$_TOKEN" ]; then echo "Gitea API token not set — skipping Docker login"; exit 1; fi
|
||||||
|
echo "$_TOKEN" | docker login git.oblachno.oblachno.fyi -u "$CI_GITEA_USERNAME" --password-stdin
|
||||||
- name: Build and push tier images
|
- name: Build and push tier images
|
||||||
|
if: >-
|
||||||
|
github.event_name == 'workflow_dispatch' ||
|
||||||
|
(github.event_name == 'workflow_run' && github.event.workflow_run.conclusion == 'success' && steps.check.outputs.is-release == 'false')
|
||||||
env:
|
env:
|
||||||
CI_GITEA_TOKEN: ${{ secrets.CI_GITEA_TOKEN }}
|
CI_GITEA_API_TOKEN: ${{ secrets.CI_GITEA_API_TOKEN }}
|
||||||
CI_GITEA_USERNAME: ${{ vars.CI_GITEA_USERNAME }}
|
CI_GITEA_USERNAME: ${{ vars.CI_GITEA_USERNAME }}
|
||||||
PYTHONPATH: src
|
PYTHONPATH: src
|
||||||
run: |
|
run: |
|
||||||
@@ -99,7 +99,7 @@ jobs:
|
|||||||
- name: Notify on failure
|
- name: Notify on failure
|
||||||
if: failure()
|
if: failure()
|
||||||
env:
|
env:
|
||||||
CI_GITEA_TOKEN: ${{ secrets.CI_GITEA_TOKEN }}
|
CI_GITEA_API_TOKEN: ${{ secrets.CI_GITEA_API_TOKEN }}
|
||||||
PYTHONPATH: src
|
PYTHONPATH: src
|
||||||
run: |
|
run: |
|
||||||
. .venv/bin/activate 2>/dev/null || true
|
. .venv/bin/activate 2>/dev/null || true
|
||||||
@@ -121,10 +121,12 @@ jobs:
|
|||||||
with:
|
with:
|
||||||
fetch-depth: 1
|
fetch-depth: 1
|
||||||
- name: Set up environment
|
- name: Set up environment
|
||||||
|
env:
|
||||||
|
CI_GITEA_API_TOKEN: ${{ secrets.CI_GITEA_API_TOKEN }}
|
||||||
run: make setup-ci
|
run: make setup-ci
|
||||||
- name: Clean up old image versions
|
- name: Clean up old image versions
|
||||||
env:
|
env:
|
||||||
CI_GITEA_TOKEN: ${{ secrets.CI_GITEA_TOKEN }}
|
CI_GITEA_API_TOKEN: ${{ secrets.CI_GITEA_API_TOKEN }}
|
||||||
PYTHONPATH: src
|
PYTHONPATH: src
|
||||||
run: |
|
run: |
|
||||||
. .venv/bin/activate
|
. .venv/bin/activate
|
||||||
|
|||||||
+109
-122
@@ -5,73 +5,21 @@ on:
|
|||||||
types: [opened, synchronize]
|
types: [opened, synchronize]
|
||||||
workflow_dispatch:
|
workflow_dispatch:
|
||||||
|
|
||||||
jobs:
|
env:
|
||||||
quality:
|
PIP_BREAK_SYSTEM_PACKAGES: "1"
|
||||||
runs-on: docker
|
PYTHONPATH: src
|
||||||
container: git.oblachno.oblachno.fyi/oblachno-oss/runner-images/ci-quality:latest
|
CI_GITEA_API_TOKEN: ${{ secrets.CI_GITEA_API_TOKEN }}
|
||||||
timeout-minutes: 10
|
CI_GITEA_USERNAME: ${{ vars.CI_GITEA_USERNAME }}
|
||||||
defaults:
|
|
||||||
run:
|
|
||||||
shell: bash
|
|
||||||
steps:
|
|
||||||
- uses: actions/checkout@v4
|
|
||||||
- name: Set up environment
|
|
||||||
run: make setup-image
|
|
||||||
- name: Lint all
|
|
||||||
run: |
|
|
||||||
. .venv/bin/activate
|
|
||||||
export PATH="$HOME/.local/bin:$PATH"
|
|
||||||
make lint-all
|
|
||||||
- name: Unit tests with 100% coverage
|
|
||||||
run: |
|
|
||||||
. .venv/bin/activate
|
|
||||||
make pytest-cov
|
|
||||||
- name: Check unit test speed
|
|
||||||
env:
|
|
||||||
PYTHONPATH: src
|
|
||||||
run: |
|
|
||||||
. .venv/bin/activate
|
|
||||||
python3 -m devx.tools.check_test_speed --max-seconds 4 --max-single-seconds 0.5
|
|
||||||
- name: Documentation coverage check
|
|
||||||
env:
|
|
||||||
PYTHONPATH: src
|
|
||||||
run: |
|
|
||||||
. .venv/bin/activate
|
|
||||||
python3 -m devx.ci.doc_coverage --fail-on-missing
|
|
||||||
- name: Documentation lint check
|
|
||||||
env:
|
|
||||||
PYTHONPATH: src
|
|
||||||
run: |
|
|
||||||
. .venv/bin/activate
|
|
||||||
python3 -m devx.ci.lint_docs --root .
|
|
||||||
- name: Translation completeness check
|
|
||||||
env:
|
|
||||||
PYTHONPATH: src
|
|
||||||
run: |
|
|
||||||
. .venv/bin/activate
|
|
||||||
python3 -m devx.ci.check_translations
|
|
||||||
- name: Dependency security scan
|
|
||||||
run: |
|
|
||||||
. .venv/bin/activate
|
|
||||||
# Install pip in venv if missing (needed by pip-audit)
|
|
||||||
.venv/bin/python -m ensurepip 2>/dev/null || true
|
|
||||||
PIPAPI_PYTHON_LOCATION=$PWD/.venv/bin/python \
|
|
||||||
pip-audit --desc --skip-editable 2>&1 || true
|
|
||||||
- name: Workflow dry-run validation
|
|
||||||
run: |
|
|
||||||
. .venv/bin/activate
|
|
||||||
export PATH="$HOME/.local/bin:$PATH"
|
|
||||||
# Best-effort: only runs if act_runner is installed
|
|
||||||
if command -v act_runner >/dev/null 2>&1; then
|
|
||||||
make workflow-dryrun
|
|
||||||
else
|
|
||||||
echo "act_runner not found — skipping workflow dry-run (static lint still passed)"
|
|
||||||
fi
|
|
||||||
|
|
||||||
detect-changes:
|
jobs:
|
||||||
|
# Single validation job that merges: quality, detect-changes,
|
||||||
|
# release-dry-run, pr-review, and pre-merge-check.
|
||||||
|
# Uses ci-full image (has git-cliff for release-dry-run).
|
||||||
|
# Saves ~4x checkout+setup overhead vs 5 separate jobs.
|
||||||
|
validate:
|
||||||
runs-on: docker
|
runs-on: docker
|
||||||
container: git.oblachno.oblachno.fyi/oblachno-oss/runner-images/ci-base:latest
|
container: git.oblachno.oblachno.fyi/oblachno-oss/runner-images/ci-full:latest
|
||||||
timeout-minutes: 10
|
timeout-minutes: 15
|
||||||
defaults:
|
defaults:
|
||||||
run:
|
run:
|
||||||
shell: bash
|
shell: bash
|
||||||
@@ -82,77 +30,115 @@ jobs:
|
|||||||
with:
|
with:
|
||||||
fetch-depth: 0
|
fetch-depth: 0
|
||||||
- name: Set up environment
|
- name: Set up environment
|
||||||
|
env:
|
||||||
|
CI_GITEA_API_TOKEN: ${{ secrets.CI_GITEA_API_TOKEN }}
|
||||||
run: make setup-image
|
run: make setup-image
|
||||||
|
# --- quality steps ---
|
||||||
|
- name: Lint all
|
||||||
|
run: |
|
||||||
|
. .venv/bin/activate 2>/dev/null || true
|
||||||
|
export PATH="$HOME/.local/bin:$PATH"
|
||||||
|
make lint-all
|
||||||
|
- name: Unit tests with 100% coverage
|
||||||
|
run: |
|
||||||
|
. .venv/bin/activate 2>/dev/null || true
|
||||||
|
make pytest-cov
|
||||||
|
- name: Check unit test speed
|
||||||
|
run: |
|
||||||
|
. .venv/bin/activate 2>/dev/null || true
|
||||||
|
python3 -m devx.tools.check_test_speed --max-seconds 6 --max-single-seconds 0.5
|
||||||
|
- name: Documentation gate (coverage + stale refs + lint + version refs + prose)
|
||||||
|
env:
|
||||||
|
DEVX_DOC_COVERAGE_STRICT: "1"
|
||||||
|
DEVX_VALE_LEVEL: warning
|
||||||
|
run: |
|
||||||
|
. .venv/bin/activate 2>/dev/null || true
|
||||||
|
export PATH="$HOME/.local/bin:$PATH"
|
||||||
|
make devx-docs-check
|
||||||
|
- name: Translation completeness check
|
||||||
|
run: |
|
||||||
|
. .venv/bin/activate 2>/dev/null || true
|
||||||
|
python3 -m devx.ci.check_translations
|
||||||
|
- name: Dependency security scan
|
||||||
|
run: |
|
||||||
|
. .venv/bin/activate 2>/dev/null || true
|
||||||
|
# Install pip in venv if missing (needed by pip-audit)
|
||||||
|
.venv/bin/python -m ensurepip 2>/dev/null || true
|
||||||
|
PIPAPI_PYTHON_LOCATION=$PWD/.venv/bin/python \
|
||||||
|
pip-audit --desc --skip-editable 2>&1 || true
|
||||||
|
- name: Workflow dry-run validation
|
||||||
|
run: |
|
||||||
|
. .venv/bin/activate 2>/dev/null || true
|
||||||
|
export PATH="$HOME/.local/bin:$PATH"
|
||||||
|
# Best-effort: only runs if act_runner is installed
|
||||||
|
if command -v act_runner >/dev/null 2>&1; then
|
||||||
|
make workflow-dryrun
|
||||||
|
else
|
||||||
|
echo "act_runner not found — skipping workflow dry-run (static lint still passed)"
|
||||||
|
fi
|
||||||
|
# --- detect-changes step ---
|
||||||
- name: Detect changed paths
|
- name: Detect changed paths
|
||||||
id: detect
|
id: detect
|
||||||
env:
|
|
||||||
PYTHONPATH: src
|
|
||||||
run: |
|
run: |
|
||||||
. .venv/bin/activate
|
. .venv/bin/activate 2>/dev/null || true
|
||||||
python3 -m devx.ci.classify_changes \
|
python3 -m devx.ci.classify_changes \
|
||||||
--base "origin/master" \
|
--base "origin/master" \
|
||||||
--head "${{ github.event.pull_request.head.sha || github.sha }}" \
|
--head "${{ github.event.pull_request.head.sha || github.sha }}" \
|
||||||
--github-output
|
--github-output
|
||||||
|
# --- validate-pr + pr-review steps (PR only) ---
|
||||||
release-dry-run:
|
- name: Validate auto-merge preconditions
|
||||||
needs: [quality, detect-changes]
|
if: github.event_name == 'pull_request'
|
||||||
if: needs.detect-changes.outputs.user-facing-changed == 'true'
|
|
||||||
runs-on: docker
|
|
||||||
container: git.oblachno.oblachno.fyi/oblachno-oss/runner-images/ci-full:latest
|
|
||||||
timeout-minutes: 10
|
|
||||||
defaults:
|
|
||||||
run:
|
|
||||||
shell: bash
|
|
||||||
steps:
|
|
||||||
- uses: actions/checkout@v4
|
|
||||||
with:
|
|
||||||
fetch-depth: 0
|
|
||||||
- name: Set up environment
|
|
||||||
env:
|
env:
|
||||||
CI_GITEA_TOKEN: ${{ secrets.CI_GITEA_TOKEN }}
|
VIKUNJA_TOKEN: ${{ secrets.VIKUNJA_TOKEN }}
|
||||||
run: make setup-image
|
DEVX_VIKUNJA_PROJECT_ID: "8"
|
||||||
- name: Release dry-run validation
|
HEAD_REF: ${{ github.head_ref }}
|
||||||
env:
|
PR_TITLE: ${{ github.event.pull_request.title }}
|
||||||
PYTHONPATH: src
|
REPOSITORY: ${{ github.repository }}
|
||||||
|
PR_NUMBER: ${{ github.event.number }}
|
||||||
run: |
|
run: |
|
||||||
. .venv/bin/activate
|
. .venv/bin/activate 2>/dev/null || true
|
||||||
export PATH="$HOME/.local/bin:$PATH"
|
python3 -m devx.ci.check_auto_merge_ready \
|
||||||
python3 -m devx.ci.release --dry-run
|
--branch "$HEAD_REF" \
|
||||||
|
--pr-title "$PR_TITLE" \
|
||||||
pr-review:
|
--repo "$REPOSITORY" \
|
||||||
if: github.event_name == 'pull_request'
|
--pr-number "$PR_NUMBER"
|
||||||
runs-on: docker
|
|
||||||
container: git.oblachno.oblachno.fyi/oblachno-oss/runner-images/ci-base:latest
|
|
||||||
timeout-minutes: 10
|
|
||||||
defaults:
|
|
||||||
run:
|
|
||||||
shell: bash
|
|
||||||
steps:
|
|
||||||
- uses: actions/checkout@v4
|
|
||||||
- name: Set up environment
|
|
||||||
run: make setup-image
|
|
||||||
- name: Run automated PR review
|
- name: Run automated PR review
|
||||||
env:
|
if: github.event_name == 'pull_request'
|
||||||
CI_GITEA_TOKEN: ${{ secrets.CI_GITEA_TOKEN }}
|
|
||||||
PYTHONPATH: src
|
|
||||||
run: |
|
run: |
|
||||||
|
. .venv/bin/activate 2>/dev/null || true
|
||||||
set -euo pipefail
|
set -euo pipefail
|
||||||
. .venv/bin/activate
|
|
||||||
python3 -m devx.ci.pr_review \
|
python3 -m devx.ci.pr_review \
|
||||||
"${{ github.event.number }}" \
|
"${{ github.event.number }}" \
|
||||||
"${{ github.repository }}"
|
"${{ github.repository }}"
|
||||||
|
# --- release-dry-run step (conditional) ---
|
||||||
|
- name: Release dry-run validation
|
||||||
|
if: steps.detect.outputs.user-facing-changed == 'true'
|
||||||
|
run: |
|
||||||
|
. .venv/bin/activate 2>/dev/null || true
|
||||||
|
export PATH="$HOME/.local/bin:$PATH"
|
||||||
|
python3 -m devx.ci.release --dry-run
|
||||||
|
- name: Notify on failure
|
||||||
|
if: failure()
|
||||||
|
env:
|
||||||
|
CI_GITEA_API_TOKEN: ${{ secrets.CI_GITEA_API_TOKEN }}
|
||||||
|
run: |
|
||||||
|
. .venv/bin/activate 2>/dev/null || true
|
||||||
|
export PATH="$HOME/.local/bin:$PATH"
|
||||||
|
python3 -m devx.ci.notify_failure \
|
||||||
|
--repo "${{ github.repository }}" \
|
||||||
|
--run-id "${{ github.run_id }}" \
|
||||||
|
--workflow "ci/validate" \
|
||||||
|
--commit "${{ github.sha }}" \
|
||||||
|
--auto-login
|
||||||
|
|
||||||
auto-merge:
|
auto-merge:
|
||||||
# Auto-merge runs after all CI checks pass. It reads the task ID
|
# Auto-merge runs after validate passes. It reads the task ID
|
||||||
# from the branch name, validates the PR title, and squash-merges.
|
# from the branch name, validates the PR title, and squash-merges.
|
||||||
# Uses always() so it runs even when detect-changes skips (no user-facing changes).
|
needs: [validate]
|
||||||
needs: [quality, detect-changes, pr-review, release-dry-run]
|
|
||||||
if: >-
|
if: >-
|
||||||
always() &&
|
always() &&
|
||||||
github.event_name == 'pull_request' &&
|
github.event_name == 'pull_request' &&
|
||||||
needs.quality.result == 'success' &&
|
needs.validate.result == 'success'
|
||||||
needs.pr-review.result == 'success' &&
|
|
||||||
(needs.release-dry-run.result == 'success' || needs.release-dry-run.result == 'skipped')
|
|
||||||
runs-on: docker
|
runs-on: docker
|
||||||
container: git.oblachno.oblachno.fyi/oblachno-oss/runner-images/ci-base:latest
|
container: git.oblachno.oblachno.fyi/oblachno-oss/runner-images/ci-base:latest
|
||||||
timeout-minutes: 10
|
timeout-minutes: 10
|
||||||
@@ -163,36 +149,37 @@ jobs:
|
|||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v4
|
||||||
with:
|
with:
|
||||||
fetch-depth: 0
|
fetch-depth: 0
|
||||||
token: ${{ secrets.CI_GITEA_TOKEN }}
|
token: ${{ secrets.CI_GITEA_API_TOKEN }}
|
||||||
- name: Set up environment
|
- name: Set up environment
|
||||||
|
env:
|
||||||
|
CI_GITEA_API_TOKEN: ${{ secrets.CI_GITEA_API_TOKEN }}
|
||||||
run: make setup-image
|
run: make setup-image
|
||||||
- name: Post approval review
|
- name: Post approval review
|
||||||
env:
|
env:
|
||||||
CI_GITEA_TOKEN: ${{ secrets.REVIEW_GITEA_TOKEN }}
|
REVIEWER_GITEA_API_TOKEN: ${{ secrets.REVIEWER_GITEA_API_TOKEN }}
|
||||||
|
CI_GITEA_API_TOKEN: ${{ secrets.CI_GITEA_API_TOKEN }}
|
||||||
PR_NUMBER: ${{ github.event.number }}
|
PR_NUMBER: ${{ github.event.number }}
|
||||||
REPOSITORY: ${{ github.repository }}
|
REPOSITORY: ${{ github.repository }}
|
||||||
PYTHONPATH: src
|
|
||||||
run: |
|
run: |
|
||||||
. .venv/bin/activate
|
. .venv/bin/activate 2>/dev/null || true
|
||||||
python3 -m devx.ci.pr_review \
|
python3 -m devx.ci.pr_review \
|
||||||
"$PR_NUMBER" \
|
"$PR_NUMBER" \
|
||||||
"$REPOSITORY" \
|
"$REPOSITORY" \
|
||||||
--event APPROVE \
|
--event APPROVE \
|
||||||
--checklist-confirmed \
|
--checklist-confirmed \
|
||||||
--checklist-categories 1,2,3,4,5,6,7,8,9,10,11,12,13 \
|
--checklist-categories 1,2,3,4,5,6,7,8,9,10,11,12,13 \
|
||||||
--body "Auto-approved: all CI checks passed (quality, pr-review, release-dry-run)."
|
--body "Auto-approved: all CI checks passed (validate job)."
|
||||||
- name: Squash merge with task ID
|
- name: Squash merge with task ID
|
||||||
env:
|
env:
|
||||||
CI_GITEA_TOKEN: ${{ secrets.CI_GITEA_TOKEN }}
|
CI_GITEA_API_TOKEN: ${{ secrets.CI_GITEA_API_TOKEN }}
|
||||||
VIKUNJA_TOKEN: ${{ secrets.VIKUNJA_TOKEN }}
|
VIKUNJA_TOKEN: ${{ secrets.VIKUNJA_TOKEN }}
|
||||||
DEVX_VIKUNJA_PROJECT_ID: "8"
|
DEVX_VIKUNJA_PROJECT_ID: "8"
|
||||||
PYTHONPATH: src
|
|
||||||
HEAD_REF: ${{ github.head_ref }}
|
HEAD_REF: ${{ github.head_ref }}
|
||||||
PR_TITLE: ${{ github.event.pull_request.title }}
|
PR_TITLE: ${{ github.event.pull_request.title }}
|
||||||
REPOSITORY: ${{ github.repository }}
|
REPOSITORY: ${{ github.repository }}
|
||||||
PR_NUMBER: ${{ github.event.number }}
|
PR_NUMBER: ${{ github.event.number }}
|
||||||
run: |
|
run: |
|
||||||
. .venv/bin/activate
|
. .venv/bin/activate 2>/dev/null || true
|
||||||
python3 -m devx.ci.auto_merge \
|
python3 -m devx.ci.auto_merge \
|
||||||
"$HEAD_REF" \
|
"$HEAD_REF" \
|
||||||
"$PR_TITLE" \
|
"$PR_TITLE" \
|
||||||
|
|||||||
+119
-249
@@ -1,37 +1,39 @@
|
|||||||
name: Post-merge
|
name: Post-merge
|
||||||
|
|
||||||
# Runs on every push to master. A single workflow with conditional jobs
|
# Runs on every push to master (after CI workflow merges a PR).
|
||||||
# for release, publish, wiki sync, badges, and Vikunja task updates.
|
# Consolidated into 2 jobs (from 7) to reduce runner overhead:
|
||||||
|
# detect-and-configure ──→ release-and-maintain
|
||||||
#
|
#
|
||||||
# Job dependency graph:
|
# Job 1: detect release commit, validate commit msg, configure repo
|
||||||
|
# (branch protection, labels).
|
||||||
|
# Job 2: release + publish + sync-wiki + vikunja + badges.
|
||||||
|
# Individual steps are conditional on job 1 outputs.
|
||||||
#
|
#
|
||||||
# detect-type ──┬── validate-commit-msg (skip if release commit)
|
# The badges step always runs (even on release commits) so version
|
||||||
# ├── release (skip if release commit)
|
# badge picks up the new __version__. It runs last so it sees the
|
||||||
# │ └── publish (needs release — builds & publishes to PyPI)
|
# new version if release created one.
|
||||||
# ├── badges (ALWAYS runs — even on release commits)
|
|
||||||
# ├── configure-repo (independent — skip if release commit)
|
|
||||||
# ├── sync-wiki (skip if release commit — runs for ALL merges)
|
|
||||||
# └── vikunja (skip if release commit — runs for ALL merges)
|
|
||||||
#
|
|
||||||
# sync-wiki and vikunja run for ALL non-release commits, not just when
|
|
||||||
# release succeeds. This ensures the wiki and task tracker are updated
|
|
||||||
# even for infrastructure-only changes (docs, CI config, etc.).
|
|
||||||
#
|
|
||||||
# The badges job uses `if: always()` with no is-release condition so it
|
|
||||||
# runs on every push to master, including release commits. This ensures
|
|
||||||
# badges (tests, coverage, version, etc.) are always current.
|
|
||||||
#
|
#
|
||||||
# When release creates a "release: vX.Y.Z" commit and tag, the publish
|
# When release creates a "release: vX.Y.Z" commit and tag, the publish
|
||||||
# job (which depends on release) builds and publishes the package to the
|
# step builds and publishes the package to the Gitea PyPI registry.
|
||||||
# Gitea PyPI registry. The release commit's post-merge run still updates
|
# The release commit's post-merge run still updates badges. Other
|
||||||
# badges (version badge picks up the new version). Other jobs skip.
|
# steps (sync-wiki, vikunja) skip on release commits.
|
||||||
|
|
||||||
on:
|
on:
|
||||||
push:
|
push:
|
||||||
branches: [master]
|
branches: [master]
|
||||||
|
|
||||||
|
concurrency:
|
||||||
|
group: post-merge-${{ github.ref }}
|
||||||
|
cancel-in-progress: true
|
||||||
|
|
||||||
|
env:
|
||||||
|
PIP_BREAK_SYSTEM_PACKAGES: "1"
|
||||||
|
PYTHONPATH: src
|
||||||
|
CI_GITEA_API_TOKEN: ${{ secrets.CI_GITEA_API_TOKEN }}
|
||||||
|
CI_GITEA_USERNAME: ${{ vars.CI_GITEA_USERNAME }}
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
detect-type:
|
detect-and-configure:
|
||||||
runs-on: docker
|
runs-on: docker
|
||||||
container: git.oblachno.oblachno.fyi/oblachno-oss/runner-images/ci-base:latest
|
container: git.oblachno.oblachno.fyi/oblachno-oss/runner-images/ci-base:latest
|
||||||
timeout-minutes: 10
|
timeout-minutes: 10
|
||||||
@@ -40,172 +42,67 @@ jobs:
|
|||||||
shell: bash
|
shell: bash
|
||||||
outputs:
|
outputs:
|
||||||
is-release: ${{ steps.check.outputs.is-release }}
|
is-release: ${{ steps.check.outputs.is-release }}
|
||||||
|
is-automated: ${{ steps.check.outputs.is-automated }}
|
||||||
|
user-facing-changed: ${{ steps.detect.outputs.user-facing-changed }}
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v4
|
||||||
with:
|
with:
|
||||||
fetch-depth: 1
|
fetch-depth: 0
|
||||||
- name: Set up environment
|
- name: Set up environment
|
||||||
|
env:
|
||||||
|
CI_GITEA_API_TOKEN: ${{ secrets.CI_GITEA_API_TOKEN }}
|
||||||
run: make setup-image
|
run: make setup-image
|
||||||
|
- name: Ensure branch protection and labels
|
||||||
|
env:
|
||||||
|
DEVX_REPO_NAME: devx
|
||||||
|
DEVX_REPO_OWNER: oblachno-oss
|
||||||
|
DEVX_STATUS_CHECKS: "CI / validate (pull_request)"
|
||||||
|
run: |
|
||||||
|
. .venv/bin/activate 2>/dev/null || true
|
||||||
|
python3 -m devx.tools.configure_repo
|
||||||
- name: Check if this is a release commit
|
- name: Check if this is a release commit
|
||||||
id: check
|
id: check
|
||||||
env:
|
|
||||||
PYTHONPATH: src
|
|
||||||
run: |
|
run: |
|
||||||
. .venv/bin/activate
|
. .venv/bin/activate 2>/dev/null || true
|
||||||
python3 -m devx.ci.detect_release_commit
|
python3 -m devx.ci.detect_release_commit
|
||||||
|
|
||||||
validate-commit-msg:
|
|
||||||
needs: [detect-type]
|
|
||||||
if: needs.detect-type.outputs.is-release == 'false'
|
|
||||||
runs-on: docker
|
|
||||||
container: git.oblachno.oblachno.fyi/oblachno-oss/runner-images/ci-base:latest
|
|
||||||
timeout-minutes: 5
|
|
||||||
defaults:
|
|
||||||
run:
|
|
||||||
shell: bash
|
|
||||||
steps:
|
|
||||||
- uses: actions/checkout@v4
|
|
||||||
with:
|
|
||||||
fetch-depth: 1
|
|
||||||
- name: Set up environment
|
|
||||||
run: make setup-image
|
|
||||||
- name: Validate latest commit message
|
- name: Validate latest commit message
|
||||||
env:
|
if: steps.check.outputs.is-automated == 'false'
|
||||||
PYTHONPATH: src
|
|
||||||
run: |
|
run: |
|
||||||
. .venv/bin/activate
|
. .venv/bin/activate 2>/dev/null || true
|
||||||
git log -1 --format=%B > commit-msg.txt
|
git log -1 --format=%B > commit-msg.txt
|
||||||
python3 -m devx.ci.validate_commit_msg commit-msg.txt --branch master
|
python3 -m devx.ci.validate_commit_msg commit-msg.txt --branch master
|
||||||
rm -f commit-msg.txt
|
rm -f commit-msg.txt
|
||||||
|
- name: Detect changed paths
|
||||||
|
id: detect
|
||||||
|
if: steps.check.outputs.is-release == 'false'
|
||||||
|
run: |
|
||||||
|
. .venv/bin/activate 2>/dev/null || true
|
||||||
|
python3 -m devx.ci.classify_changes \
|
||||||
|
--base "HEAD~1" \
|
||||||
|
--head "HEAD" \
|
||||||
|
--github-output
|
||||||
|
- name: Notify on failure
|
||||||
|
if: failure()
|
||||||
|
env:
|
||||||
|
CI_GITEA_API_TOKEN: ${{ secrets.CI_GITEA_API_TOKEN }}
|
||||||
|
run: |
|
||||||
|
. .venv/bin/activate 2>/dev/null || true
|
||||||
|
export PATH="$HOME/.local/bin:$PATH"
|
||||||
|
python3 -m devx.ci.notify_failure \
|
||||||
|
--repo "${{ github.repository }}" \
|
||||||
|
--run-id "${{ github.run_id }}" \
|
||||||
|
--workflow "post-merge/detect-and-configure" \
|
||||||
|
--commit "${{ github.sha }}" \
|
||||||
|
--auto-login
|
||||||
|
|
||||||
release:
|
release-and-maintain:
|
||||||
needs: [detect-type]
|
needs: [detect-and-configure]
|
||||||
if: needs.detect-type.outputs.is-release == 'false'
|
if: always() && needs.detect-and-configure.result == 'success'
|
||||||
runs-on: docker
|
runs-on: docker
|
||||||
container: git.oblachno.oblachno.fyi/oblachno-oss/runner-images/ci-full:latest
|
container: git.oblachno.oblachno.fyi/oblachno-oss/runner-images/ci-full:latest
|
||||||
timeout-minutes: 15
|
timeout-minutes: 15
|
||||||
defaults:
|
|
||||||
run:
|
|
||||||
shell: bash
|
|
||||||
outputs:
|
outputs:
|
||||||
tag: ${{ steps.release-tag.outputs.tag }}
|
tag: ${{ steps.release-tag.outputs.tag }}
|
||||||
steps:
|
|
||||||
- uses: actions/checkout@v4
|
|
||||||
with:
|
|
||||||
fetch-depth: 0
|
|
||||||
token: ${{ secrets.CI_GITEA_TOKEN }}
|
|
||||||
- name: Set up environment
|
|
||||||
env:
|
|
||||||
CI_GITEA_TOKEN: ${{ secrets.CI_GITEA_TOKEN }}
|
|
||||||
run: make setup-image
|
|
||||||
- name: Configure git
|
|
||||||
run: |
|
|
||||||
git config user.name "devx-ci-bot"
|
|
||||||
git config user.email "devx-ci-bot@oblachno.fyi"
|
|
||||||
- name: Run release
|
|
||||||
id: release-tag
|
|
||||||
env:
|
|
||||||
PYTHONPATH: src
|
|
||||||
run: |
|
|
||||||
. .venv/bin/activate
|
|
||||||
export PATH="$HOME/.local/bin:$PATH"
|
|
||||||
python3 -m devx.ci.release
|
|
||||||
- name: Notify on failure
|
|
||||||
if: failure()
|
|
||||||
env:
|
|
||||||
CI_GITEA_TOKEN: ${{ secrets.CI_GITEA_TOKEN }}
|
|
||||||
PYTHONPATH: src
|
|
||||||
run: |
|
|
||||||
. .venv/bin/activate 2>/dev/null || true
|
|
||||||
export PATH="$HOME/.local/bin:$PATH"
|
|
||||||
python3 -m devx.ci.notify_failure \
|
|
||||||
--repo "${{ github.repository }}" \
|
|
||||||
--run-id "${{ github.run_id }}" \
|
|
||||||
--workflow "post-merge/release" \
|
|
||||||
--commit "${{ github.sha }}" \
|
|
||||||
--auto-login
|
|
||||||
|
|
||||||
publish:
|
|
||||||
needs: [release]
|
|
||||||
if: needs.release.outputs.tag != ''
|
|
||||||
runs-on: docker
|
|
||||||
container: git.oblachno.oblachno.fyi/oblachno-oss/runner-images/ci-full:latest
|
|
||||||
timeout-minutes: 10
|
|
||||||
defaults:
|
|
||||||
run:
|
|
||||||
shell: bash
|
|
||||||
steps:
|
|
||||||
- uses: actions/checkout@v4
|
|
||||||
with:
|
|
||||||
fetch-depth: 0
|
|
||||||
ref: ${{ needs.release.outputs.tag }}
|
|
||||||
- name: Set up environment
|
|
||||||
run: make setup-image EXTRAS=release
|
|
||||||
- name: Build and publish release
|
|
||||||
env:
|
|
||||||
CI_GITEA_TOKEN: ${{ secrets.CI_GITEA_TOKEN }}
|
|
||||||
PYTHONPATH: src
|
|
||||||
run: |
|
|
||||||
. .venv/bin/activate
|
|
||||||
export PATH="$HOME/.local/bin:$PATH"
|
|
||||||
python3 -m devx.ci.publish "${{ needs.release.outputs.tag }}" "${{ github.repository }}" --auto-login
|
|
||||||
- name: Notify on failure
|
|
||||||
if: failure()
|
|
||||||
env:
|
|
||||||
CI_GITEA_TOKEN: ${{ secrets.CI_GITEA_TOKEN }}
|
|
||||||
PYTHONPATH: src
|
|
||||||
run: |
|
|
||||||
. .venv/bin/activate 2>/dev/null || true
|
|
||||||
export PATH="$HOME/.local/bin:$PATH"
|
|
||||||
python3 -m devx.ci.notify_failure \
|
|
||||||
--repo "${{ github.repository }}" \
|
|
||||||
--run-id "${{ github.run_id }}" \
|
|
||||||
--workflow "post-merge/publish" \
|
|
||||||
--commit "${{ github.sha }}" \
|
|
||||||
--auto-login
|
|
||||||
|
|
||||||
sync-wiki:
|
|
||||||
needs: [detect-type]
|
|
||||||
if: needs.detect-type.outputs.is-release == 'false'
|
|
||||||
runs-on: docker
|
|
||||||
container: git.oblachno.oblachno.fyi/oblachno-oss/runner-images/ci-base:latest
|
|
||||||
timeout-minutes: 10
|
|
||||||
defaults:
|
|
||||||
run:
|
|
||||||
shell: bash
|
|
||||||
steps:
|
|
||||||
- uses: actions/checkout@v4
|
|
||||||
with:
|
|
||||||
fetch-depth: 0
|
|
||||||
- name: Set up environment
|
|
||||||
run: make setup-image
|
|
||||||
- name: Sync documentation to wiki
|
|
||||||
env:
|
|
||||||
CI_GITEA_TOKEN: ${{ secrets.CI_GITEA_TOKEN }}
|
|
||||||
PYTHONPATH: src
|
|
||||||
run: |
|
|
||||||
. .venv/bin/activate
|
|
||||||
python3 -m devx.ci.sync_wiki --repo "${{ github.repository }}" --strict
|
|
||||||
- name: Notify on failure
|
|
||||||
if: failure()
|
|
||||||
env:
|
|
||||||
CI_GITEA_TOKEN: ${{ secrets.CI_GITEA_TOKEN }}
|
|
||||||
PYTHONPATH: src
|
|
||||||
run: |
|
|
||||||
export PATH="$HOME/.local/bin:$PATH"
|
|
||||||
python3 -m devx.ci.notify_failure \
|
|
||||||
--repo "${{ github.repository }}" \
|
|
||||||
--run-id "${{ github.run_id }}" \
|
|
||||||
--workflow "post-merge/sync-wiki" \
|
|
||||||
--commit "${{ github.sha }}" \
|
|
||||||
--auto-login
|
|
||||||
|
|
||||||
badges:
|
|
||||||
needs: [detect-type]
|
|
||||||
if: always()
|
|
||||||
runs-on: docker
|
|
||||||
container: git.oblachno.oblachno.fyi/oblachno-oss/runner-images/ci-quality:latest
|
|
||||||
timeout-minutes: 10
|
|
||||||
defaults:
|
defaults:
|
||||||
run:
|
run:
|
||||||
shell: bash
|
shell: bash
|
||||||
@@ -214,100 +111,73 @@ jobs:
|
|||||||
with:
|
with:
|
||||||
fetch-depth: 0
|
fetch-depth: 0
|
||||||
ref: master
|
ref: master
|
||||||
token: ${{ secrets.CI_GITEA_TOKEN }}
|
token: ${{ secrets.CI_GITEA_API_TOKEN }}
|
||||||
- name: Fetch latest master
|
|
||||||
run: |
|
|
||||||
git fetch origin master
|
|
||||||
git reset --hard origin/master
|
|
||||||
- name: Set up environment
|
- name: Set up environment
|
||||||
run: make setup-image
|
env:
|
||||||
|
CI_GITEA_API_TOKEN: ${{ secrets.CI_GITEA_API_TOKEN }}
|
||||||
|
run: make setup-image EXTRAS=release
|
||||||
|
- name: Configure git
|
||||||
|
run: |
|
||||||
|
git config user.name "devx-ci-bot"
|
||||||
|
git config user.email "devx-ci-bot@oblachno.fyi"
|
||||||
|
# --- release + publish (only if user-facing changes, not a release commit) ---
|
||||||
|
- name: Run release
|
||||||
|
id: release-tag
|
||||||
|
if: needs.detect-and-configure.outputs.is-release == 'false' && needs.detect-and-configure.outputs.user-facing-changed == 'true'
|
||||||
|
env:
|
||||||
|
CI_GITEA_API_TOKEN: ${{ secrets.CI_GITEA_API_TOKEN }}
|
||||||
|
run: |
|
||||||
|
. .venv/bin/activate 2>/dev/null || true
|
||||||
|
export PATH="$HOME/.local/bin:$PATH"
|
||||||
|
python3 -m devx.ci.release
|
||||||
|
- name: Build and publish release
|
||||||
|
if: steps.release-tag.outputs.tag != ''
|
||||||
|
env:
|
||||||
|
CI_GITEA_API_TOKEN: ${{ secrets.CI_GITEA_API_TOKEN }}
|
||||||
|
run: |
|
||||||
|
. .venv/bin/activate 2>/dev/null || true
|
||||||
|
export PATH="$HOME/.local/bin:$PATH"
|
||||||
|
git fetch --tags
|
||||||
|
git checkout "${{ steps.release-tag.outputs.tag }}"
|
||||||
|
python3 -m devx.ci.publish "${{ steps.release-tag.outputs.tag }}" "${{ github.repository }}" --auto-login
|
||||||
|
# --- sync-wiki + vikunja (skip on automated/release commits) ---
|
||||||
|
- name: Sync documentation to wiki
|
||||||
|
if: needs.detect-and-configure.outputs.is-automated == 'false'
|
||||||
|
env:
|
||||||
|
CI_GITEA_API_TOKEN: ${{ secrets.CI_GITEA_API_TOKEN }}
|
||||||
|
run: |
|
||||||
|
. .venv/bin/activate 2>/dev/null || true
|
||||||
|
python3 -m devx.ci.sync_wiki --repo "${{ github.repository }}" --verify
|
||||||
|
- name: Update Vikunja task
|
||||||
|
if: needs.detect-and-configure.outputs.is-automated == 'false'
|
||||||
|
env:
|
||||||
|
VIKUNJA_TOKEN: ${{ secrets.VIKUNJA_TOKEN }}
|
||||||
|
DEVX_VIKUNJA_PROJECT_ID: "8"
|
||||||
|
run: |
|
||||||
|
. .venv/bin/activate 2>/dev/null || true
|
||||||
|
python3 -m devx.ci.post_merge --git-sha "${{ github.sha }}"
|
||||||
|
# --- badges (always run — even on release commits) ---
|
||||||
- name: Generate and push badges
|
- name: Generate and push badges
|
||||||
env:
|
env:
|
||||||
|
CI_GITEA_API_TOKEN: ${{ secrets.CI_GITEA_API_TOKEN }}
|
||||||
PRE_COMMIT_ALLOW_NO_CONFIG: "1"
|
PRE_COMMIT_ALLOW_NO_CONFIG: "1"
|
||||||
run: |
|
run: |
|
||||||
. .venv/bin/activate
|
. .venv/bin/activate 2>/dev/null || true
|
||||||
|
export PATH="$HOME/.local/bin:$PATH"
|
||||||
|
# Fetch latest master to pick up any release commit that was pushed
|
||||||
|
git fetch origin master
|
||||||
|
git reset --hard origin/master
|
||||||
python3 -m devx.ci.push_badges
|
python3 -m devx.ci.push_badges
|
||||||
- name: Notify on failure
|
- name: Notify on failure
|
||||||
if: failure()
|
if: failure()
|
||||||
env:
|
env:
|
||||||
CI_GITEA_TOKEN: ${{ secrets.CI_GITEA_TOKEN }}
|
CI_GITEA_API_TOKEN: ${{ secrets.CI_GITEA_API_TOKEN }}
|
||||||
PYTHONPATH: src
|
|
||||||
run: |
|
run: |
|
||||||
|
. .venv/bin/activate 2>/dev/null || true
|
||||||
export PATH="$HOME/.local/bin:$PATH"
|
export PATH="$HOME/.local/bin:$PATH"
|
||||||
python3 -m devx.ci.notify_failure \
|
python3 -m devx.ci.notify_failure \
|
||||||
--repo "${{ github.repository }}" \
|
--repo "${{ github.repository }}" \
|
||||||
--run-id "${{ github.run_id }}" \
|
--run-id "${{ github.run_id }}" \
|
||||||
--workflow "post-merge/badges" \
|
--workflow "post-merge/release-and-maintain" \
|
||||||
--commit "${{ github.sha }}" \
|
|
||||||
--auto-login
|
|
||||||
|
|
||||||
vikunja:
|
|
||||||
needs: [detect-type]
|
|
||||||
if: needs.detect-type.outputs.is-release == 'false'
|
|
||||||
runs-on: docker
|
|
||||||
container: git.oblachno.oblachno.fyi/oblachno-oss/runner-images/ci-base:latest
|
|
||||||
timeout-minutes: 10
|
|
||||||
defaults:
|
|
||||||
run:
|
|
||||||
shell: bash
|
|
||||||
steps:
|
|
||||||
- uses: actions/checkout@v4
|
|
||||||
with:
|
|
||||||
fetch-depth: 0
|
|
||||||
- name: Set up environment
|
|
||||||
run: make setup-image
|
|
||||||
- name: Update Vikunja task
|
|
||||||
env:
|
|
||||||
VIKUNJA_TOKEN: ${{ secrets.VIKUNJA_TOKEN }}
|
|
||||||
DEVX_VIKUNJA_PROJECT_ID: "8"
|
|
||||||
PYTHONPATH: src
|
|
||||||
run: |
|
|
||||||
. .venv/bin/activate
|
|
||||||
python3 -m devx.ci.post_merge --git-sha "${{ github.sha }}"
|
|
||||||
- name: Notify on failure
|
|
||||||
if: failure()
|
|
||||||
env:
|
|
||||||
CI_GITEA_TOKEN: ${{ secrets.CI_GITEA_TOKEN }}
|
|
||||||
PYTHONPATH: src
|
|
||||||
run: |
|
|
||||||
export PATH="$HOME/.local/bin:$PATH"
|
|
||||||
python3 -m devx.ci.notify_failure \
|
|
||||||
--repo "${{ github.repository }}" \
|
|
||||||
--run-id "${{ github.run_id }}" \
|
|
||||||
--workflow "post-merge/vikunja" \
|
|
||||||
--commit "${{ github.sha }}" \
|
|
||||||
--auto-login
|
|
||||||
|
|
||||||
configure-repo:
|
|
||||||
needs: [detect-type]
|
|
||||||
if: needs.detect-type.outputs.is-release == 'false'
|
|
||||||
runs-on: docker
|
|
||||||
container: git.oblachno.oblachno.fyi/oblachno-oss/runner-images/ci-base:latest
|
|
||||||
timeout-minutes: 10
|
|
||||||
defaults:
|
|
||||||
run:
|
|
||||||
shell: bash
|
|
||||||
steps:
|
|
||||||
- uses: actions/checkout@v4
|
|
||||||
- name: Set up environment
|
|
||||||
run: make setup-image
|
|
||||||
- name: Ensure branch protection and labels
|
|
||||||
env:
|
|
||||||
CI_GITEA_TOKEN: ${{ secrets.CI_GITEA_TOKEN }}
|
|
||||||
PYTHONPATH: src
|
|
||||||
run: |
|
|
||||||
. .venv/bin/activate
|
|
||||||
python3 -m devx.tools.configure_repo --repo devx --owner oblachno-oss
|
|
||||||
- name: Notify on failure
|
|
||||||
if: failure()
|
|
||||||
env:
|
|
||||||
CI_GITEA_TOKEN: ${{ secrets.CI_GITEA_TOKEN }}
|
|
||||||
PYTHONPATH: src
|
|
||||||
run: |
|
|
||||||
export PATH="$HOME/.local/bin:$PATH"
|
|
||||||
python3 -m devx.ci.notify_failure \
|
|
||||||
--repo "${{ github.repository }}" \
|
|
||||||
--run-id "${{ github.run_id }}" \
|
|
||||||
--workflow "post-merge/configure-repo" \
|
|
||||||
--commit "${{ github.sha }}" \
|
--commit "${{ github.sha }}" \
|
||||||
--auto-login
|
--auto-login
|
||||||
|
|||||||
@@ -49,6 +49,38 @@ repos:
|
|||||||
pass_filenames: false
|
pass_filenames: false
|
||||||
stages: [pre-commit]
|
stages: [pre-commit]
|
||||||
|
|
||||||
|
- id: checkmake
|
||||||
|
name: checkmake Makefile linter
|
||||||
|
entry: make checkmake
|
||||||
|
language: system
|
||||||
|
files: (Makefile|\.mak)$
|
||||||
|
pass_filenames: false
|
||||||
|
stages: [pre-commit]
|
||||||
|
|
||||||
|
- id: check-test-speed
|
||||||
|
name: unit test speed check
|
||||||
|
entry: .venv/bin/python -m devx.tools.check_test_speed --max-seconds 6 --max-single-seconds 0.5
|
||||||
|
language: system
|
||||||
|
types: [python]
|
||||||
|
pass_filenames: false
|
||||||
|
stages: [pre-commit]
|
||||||
|
|
||||||
|
- id: check-translations
|
||||||
|
name: translation completeness check
|
||||||
|
entry: env PYTHONPATH=src .venv/bin/python -m devx.ci.check_translations
|
||||||
|
language: system
|
||||||
|
files: ^src/devx/translations\.json$
|
||||||
|
pass_filenames: false
|
||||||
|
stages: [pre-commit]
|
||||||
|
|
||||||
|
- id: docs-check
|
||||||
|
name: documentation gate (coverage + stale refs + lint + version refs + prose)
|
||||||
|
entry: bash -c 'PYTHONPATH=src DEVX_DOC_COVERAGE_STRICT=1 DEVX_VALE_LEVEL=warning make devx-docs-check'
|
||||||
|
language: system
|
||||||
|
pass_filenames: false
|
||||||
|
always_run: true
|
||||||
|
stages: [pre-commit]
|
||||||
|
|
||||||
- id: pytest-cov
|
- id: pytest-cov
|
||||||
name: pytest with 100% coverage
|
name: pytest with 100% coverage
|
||||||
entry: make pytest-cov
|
entry: make pytest-cov
|
||||||
|
|||||||
@@ -0,0 +1,49 @@
|
|||||||
|
# Vale configuration for devx documentation
|
||||||
|
# https://vale.sh/docs/
|
||||||
|
|
||||||
|
StylesPath = .vale/styles
|
||||||
|
|
||||||
|
# Packages are downloaded via `vale sync`
|
||||||
|
Packages = write-good, Google, Readability
|
||||||
|
|
||||||
|
# Minimum alert level to display (suggestion, warning, error)
|
||||||
|
MinAlertLevel = warning
|
||||||
|
|
||||||
|
# Project vocabulary — terms not flagged as spelling errors
|
||||||
|
Vocab = devx
|
||||||
|
|
||||||
|
[*.{md}]
|
||||||
|
# Enable style guides
|
||||||
|
BasedOnStyles = Vale, write-good, Google, Readability, devx
|
||||||
|
|
||||||
|
# Google style — relax rules too strict for technical docs
|
||||||
|
Google.Contractions = NO
|
||||||
|
Google.WordList = NO
|
||||||
|
Google.Acronyms = NO
|
||||||
|
Google.We = NO
|
||||||
|
Google.Will = NO
|
||||||
|
Google.Colons = NO
|
||||||
|
Google.Headings = NO
|
||||||
|
Google.EmDash = NO
|
||||||
|
Google.Units = NO
|
||||||
|
|
||||||
|
# write-good — relax rules too strict for technical writing
|
||||||
|
write-good.E-Prime = NO
|
||||||
|
write-good.So = NO
|
||||||
|
write-good.ThereIs = NO
|
||||||
|
write-good.TooWordy = NO
|
||||||
|
write-good.Passive = NO
|
||||||
|
|
||||||
|
# Vale defaults — spelling catches too many technical terms
|
||||||
|
Vale.Terms = NO
|
||||||
|
Vale.Repetition = NO
|
||||||
|
Vale.Spelling = NO
|
||||||
|
|
||||||
|
# Readability — technical docs are naturally complex, downgrade to suggestions
|
||||||
|
Readability.FleschReadingEase = suggestion
|
||||||
|
Readability.FleschKincaid = suggestion
|
||||||
|
Readability.AutomatedReadability = suggestion
|
||||||
|
Readability.ColemanLiau = suggestion
|
||||||
|
Readability.LIX = suggestion
|
||||||
|
Readability.GunningFog = suggestion
|
||||||
|
Readability.SMOG = suggestion
|
||||||
@@ -0,0 +1,9 @@
|
|||||||
|
extends: existence
|
||||||
|
message: "Use 'AM' or 'PM' (preceded by a space)."
|
||||||
|
link: "https://developers.google.com/style/word-list"
|
||||||
|
level: error
|
||||||
|
nonword: true
|
||||||
|
tokens:
|
||||||
|
- '\d{1,2}[AP]M\b'
|
||||||
|
- '\d{1,2} ?[ap]m\b'
|
||||||
|
- '\d{1,2} ?[aApP]\.[mM]\.'
|
||||||
@@ -0,0 +1,64 @@
|
|||||||
|
extends: conditional
|
||||||
|
message: "Spell out '%s', if it's unfamiliar to the audience."
|
||||||
|
link: 'https://developers.google.com/style/abbreviations'
|
||||||
|
level: suggestion
|
||||||
|
ignorecase: false
|
||||||
|
# Ensures that the existence of 'first' implies the existence of 'second'.
|
||||||
|
first: '\b([A-Z]{3,5})\b'
|
||||||
|
second: '(?:\b[A-Z][a-z]+ )+\(([A-Z]{3,5})\)'
|
||||||
|
# ... with the exception of these:
|
||||||
|
exceptions:
|
||||||
|
- API
|
||||||
|
- ASP
|
||||||
|
- CLI
|
||||||
|
- CPU
|
||||||
|
- CSS
|
||||||
|
- CSV
|
||||||
|
- DEBUG
|
||||||
|
- DOM
|
||||||
|
- DPI
|
||||||
|
- FAQ
|
||||||
|
- GCC
|
||||||
|
- GDB
|
||||||
|
- GET
|
||||||
|
- GPU
|
||||||
|
- GTK
|
||||||
|
- GUI
|
||||||
|
- HTML
|
||||||
|
- HTTP
|
||||||
|
- HTTPS
|
||||||
|
- IDE
|
||||||
|
- JAR
|
||||||
|
- JSON
|
||||||
|
- JSX
|
||||||
|
- LESS
|
||||||
|
- LLDB
|
||||||
|
- NET
|
||||||
|
- NOTE
|
||||||
|
- NVDA
|
||||||
|
- OSS
|
||||||
|
- PATH
|
||||||
|
- PDF
|
||||||
|
- PHP
|
||||||
|
- POST
|
||||||
|
- RAM
|
||||||
|
- REPL
|
||||||
|
- RSA
|
||||||
|
- SCM
|
||||||
|
- SCSS
|
||||||
|
- SDK
|
||||||
|
- SQL
|
||||||
|
- SSH
|
||||||
|
- SSL
|
||||||
|
- SVG
|
||||||
|
- TBD
|
||||||
|
- TCP
|
||||||
|
- TODO
|
||||||
|
- URI
|
||||||
|
- URL
|
||||||
|
- USB
|
||||||
|
- UTF
|
||||||
|
- XML
|
||||||
|
- XSS
|
||||||
|
- YAML
|
||||||
|
- ZIP
|
||||||
@@ -0,0 +1,8 @@
|
|||||||
|
extends: existence
|
||||||
|
message: "'%s' should be in lowercase."
|
||||||
|
link: 'https://developers.google.com/style/colons'
|
||||||
|
nonword: true
|
||||||
|
level: warning
|
||||||
|
scope: sentence
|
||||||
|
tokens:
|
||||||
|
- '(?<!:[^ ]+?):\s[A-Z]'
|
||||||
@@ -0,0 +1,30 @@
|
|||||||
|
extends: substitution
|
||||||
|
message: "Use '%s' instead of '%s'."
|
||||||
|
link: 'https://developers.google.com/style/contractions'
|
||||||
|
level: suggestion
|
||||||
|
ignorecase: true
|
||||||
|
action:
|
||||||
|
name: replace
|
||||||
|
swap:
|
||||||
|
are not: aren't
|
||||||
|
cannot: can't
|
||||||
|
could not: couldn't
|
||||||
|
did not: didn't
|
||||||
|
do not: don't
|
||||||
|
does not: doesn't
|
||||||
|
has not: hasn't
|
||||||
|
have not: haven't
|
||||||
|
how is: how's
|
||||||
|
is not: isn't
|
||||||
|
it is: it's
|
||||||
|
should not: shouldn't
|
||||||
|
that is: that's
|
||||||
|
they are: they're
|
||||||
|
was not: wasn't
|
||||||
|
we are: we're
|
||||||
|
we have: we've
|
||||||
|
were not: weren't
|
||||||
|
what is: what's
|
||||||
|
when is: when's
|
||||||
|
where is: where's
|
||||||
|
will not: won't
|
||||||
@@ -0,0 +1,9 @@
|
|||||||
|
extends: existence
|
||||||
|
message: "Use 'July 31, 2016' format, not '%s'."
|
||||||
|
link: 'https://developers.google.com/style/dates-times'
|
||||||
|
ignorecase: true
|
||||||
|
level: error
|
||||||
|
nonword: true
|
||||||
|
tokens:
|
||||||
|
- '\d{1,2}(?:\.|/)\d{1,2}(?:\.|/)\d{4}'
|
||||||
|
- '\d{1,2} (?:Jan(?:uary)?|Feb(?:ruary)?|Mar(?:ch)?|Apr(?:il)|May|Jun(?:e)|Jul(?:y)|Aug(?:ust)|Sep(?:tember)?|Oct(?:ober)|Nov(?:ember)?|Dec(?:ember)?) \d{4}'
|
||||||
@@ -0,0 +1,9 @@
|
|||||||
|
extends: existence
|
||||||
|
message: "In general, don't use an ellipsis."
|
||||||
|
link: 'https://developers.google.com/style/ellipses'
|
||||||
|
nonword: true
|
||||||
|
level: warning
|
||||||
|
action:
|
||||||
|
name: remove
|
||||||
|
tokens:
|
||||||
|
- '\.\.\.'
|
||||||
@@ -0,0 +1,13 @@
|
|||||||
|
extends: existence
|
||||||
|
message: "Don't put a space before or after a dash."
|
||||||
|
link: "https://developers.google.com/style/dashes"
|
||||||
|
nonword: true
|
||||||
|
level: error
|
||||||
|
action:
|
||||||
|
name: edit
|
||||||
|
params:
|
||||||
|
- trim
|
||||||
|
- " "
|
||||||
|
tokens:
|
||||||
|
- '\s[—–]\s'
|
||||||
|
|
||||||
@@ -0,0 +1,12 @@
|
|||||||
|
extends: existence
|
||||||
|
message: "Don't use exclamation points in text."
|
||||||
|
link: "https://developers.google.com/style/exclamation-points"
|
||||||
|
nonword: true
|
||||||
|
level: error
|
||||||
|
action:
|
||||||
|
name: edit
|
||||||
|
params:
|
||||||
|
- trim_right
|
||||||
|
- "!"
|
||||||
|
tokens:
|
||||||
|
- '\w+!(?:\s|$)'
|
||||||
@@ -0,0 +1,13 @@
|
|||||||
|
extends: existence
|
||||||
|
message: "Avoid first-person pronouns such as '%s'."
|
||||||
|
link: 'https://developers.google.com/style/pronouns#personal-pronouns'
|
||||||
|
ignorecase: true
|
||||||
|
level: warning
|
||||||
|
nonword: true
|
||||||
|
tokens:
|
||||||
|
- (?:^|\s)I\s
|
||||||
|
- (?:^|\s)I,\s
|
||||||
|
- \bI'm\b
|
||||||
|
- \bme\b
|
||||||
|
- \bmy\b
|
||||||
|
- \bmine\b
|
||||||
@@ -0,0 +1,9 @@
|
|||||||
|
extends: existence
|
||||||
|
message: "Don't use '%s' as a gender-neutral pronoun."
|
||||||
|
link: 'https://developers.google.com/style/pronouns#gender-neutral-pronouns'
|
||||||
|
level: error
|
||||||
|
ignorecase: true
|
||||||
|
tokens:
|
||||||
|
- he/she
|
||||||
|
- s/he
|
||||||
|
- \(s\)he
|
||||||
@@ -0,0 +1,43 @@
|
|||||||
|
extends: substitution
|
||||||
|
message: "Consider using '%s' instead of '%s'."
|
||||||
|
ignorecase: true
|
||||||
|
link: "https://developers.google.com/style/inclusive-documentation"
|
||||||
|
level: error
|
||||||
|
action:
|
||||||
|
name: replace
|
||||||
|
swap:
|
||||||
|
(?:alumna|alumnus): graduate
|
||||||
|
(?:alumnae|alumni): graduates
|
||||||
|
air(?:m[ae]n|wom[ae]n): pilot(s)
|
||||||
|
anchor(?:m[ae]n|wom[ae]n): anchor(s)
|
||||||
|
authoress: author
|
||||||
|
camera(?:m[ae]n|wom[ae]n): camera operator(s)
|
||||||
|
door(?:m[ae]|wom[ae]n): concierge(s)
|
||||||
|
draft(?:m[ae]n|wom[ae]n): drafter(s)
|
||||||
|
fire(?:m[ae]n|wom[ae]n): firefighter(s)
|
||||||
|
fisher(?:m[ae]n|wom[ae]n): fisher(s)
|
||||||
|
fresh(?:m[ae]n|wom[ae]n): first-year student(s)
|
||||||
|
garbage(?:m[ae]n|wom[ae]n): waste collector(s)
|
||||||
|
lady lawyer: lawyer
|
||||||
|
ladylike: courteous
|
||||||
|
mail(?:m[ae]n|wom[ae]n): mail carriers
|
||||||
|
man and wife: husband and wife
|
||||||
|
man enough: strong enough
|
||||||
|
mankind: human kind|humanity
|
||||||
|
manmade: manufactured
|
||||||
|
manpower: personnel
|
||||||
|
middle(?:m[ae]n|wom[ae]n): intermediary
|
||||||
|
news(?:m[ae]n|wom[ae]n): journalist(s)
|
||||||
|
ombuds(?:man|woman): ombuds
|
||||||
|
oneupmanship: upstaging
|
||||||
|
poetess: poet
|
||||||
|
police(?:m[ae]n|wom[ae]n): police officer(s)
|
||||||
|
repair(?:m[ae]n|wom[ae]n): technician(s)
|
||||||
|
sales(?:m[ae]n|wom[ae]n): salesperson or sales people
|
||||||
|
service(?:m[ae]n|wom[ae]n): soldier(s)
|
||||||
|
steward(?:ess)?: flight attendant
|
||||||
|
tribes(?:m[ae]n|wom[ae]n): tribe member(s)
|
||||||
|
waitress: waiter
|
||||||
|
woman doctor: doctor
|
||||||
|
woman scientist[s]?: scientist(s)
|
||||||
|
work(?:m[ae]n|wom[ae]n): worker(s)
|
||||||
@@ -0,0 +1,13 @@
|
|||||||
|
extends: existence
|
||||||
|
message: "Don't put a period at the end of a heading."
|
||||||
|
link: "https://developers.google.com/style/capitalization#capitalization-in-titles-and-headings"
|
||||||
|
nonword: true
|
||||||
|
level: warning
|
||||||
|
scope: heading
|
||||||
|
action:
|
||||||
|
name: edit
|
||||||
|
params:
|
||||||
|
- trim_right
|
||||||
|
- "."
|
||||||
|
tokens:
|
||||||
|
- '[a-z0-9][.]\s*$'
|
||||||
@@ -0,0 +1,29 @@
|
|||||||
|
extends: capitalization
|
||||||
|
message: "'%s' should use sentence-style capitalization."
|
||||||
|
link: "https://developers.google.com/style/capitalization#capitalization-in-titles-and-headings"
|
||||||
|
level: warning
|
||||||
|
scope: heading
|
||||||
|
match: $sentence
|
||||||
|
indicators:
|
||||||
|
- ":"
|
||||||
|
exceptions:
|
||||||
|
- Azure
|
||||||
|
- CLI
|
||||||
|
- Cosmos
|
||||||
|
- Docker
|
||||||
|
- Emmet
|
||||||
|
- gRPC
|
||||||
|
- I
|
||||||
|
- Kubernetes
|
||||||
|
- Linux
|
||||||
|
- macOS
|
||||||
|
- Marketplace
|
||||||
|
- MongoDB
|
||||||
|
- REPL
|
||||||
|
- Studio
|
||||||
|
- TypeScript
|
||||||
|
- URLs
|
||||||
|
- Visual
|
||||||
|
- VS
|
||||||
|
- Windows
|
||||||
|
- JSON
|
||||||
@@ -0,0 +1,11 @@
|
|||||||
|
extends: substitution
|
||||||
|
message: "Use '%s' instead of '%s'."
|
||||||
|
link: 'https://developers.google.com/style/abbreviations'
|
||||||
|
ignorecase: true
|
||||||
|
level: error
|
||||||
|
nonword: true
|
||||||
|
action:
|
||||||
|
name: replace
|
||||||
|
swap:
|
||||||
|
'\b(?:eg|e\.g\.)(?=[\s,;])': for example
|
||||||
|
'\b(?:ie|i\.e\.)(?=[\s,;])': that is
|
||||||
@@ -0,0 +1,14 @@
|
|||||||
|
extends: existence
|
||||||
|
message: "'%s' doesn't need a hyphen."
|
||||||
|
link: "https://developers.google.com/style/hyphens"
|
||||||
|
level: error
|
||||||
|
ignorecase: false
|
||||||
|
nonword: true
|
||||||
|
action:
|
||||||
|
name: edit
|
||||||
|
params:
|
||||||
|
- regex
|
||||||
|
- "-"
|
||||||
|
- " "
|
||||||
|
tokens:
|
||||||
|
- '\b[^\s-]+ly-\w+\b'
|
||||||
@@ -0,0 +1,12 @@
|
|||||||
|
extends: existence
|
||||||
|
message: "Don't use plurals in parentheses such as in '%s'."
|
||||||
|
link: "https://developers.google.com/style/plurals-parentheses"
|
||||||
|
level: error
|
||||||
|
nonword: true
|
||||||
|
action:
|
||||||
|
name: edit
|
||||||
|
params:
|
||||||
|
- trim_right
|
||||||
|
- "(s)"
|
||||||
|
tokens:
|
||||||
|
- '\b\w+\(s\)'
|
||||||
@@ -0,0 +1,7 @@
|
|||||||
|
extends: existence
|
||||||
|
message: "Spell out all ordinal numbers ('%s') in text."
|
||||||
|
link: 'https://developers.google.com/style/numbers'
|
||||||
|
level: error
|
||||||
|
nonword: true
|
||||||
|
tokens:
|
||||||
|
- \d+(?:st|nd|rd|th)
|
||||||
@@ -0,0 +1,7 @@
|
|||||||
|
extends: existence
|
||||||
|
message: "Use the Oxford comma in '%s'."
|
||||||
|
link: 'https://developers.google.com/style/commas'
|
||||||
|
scope: sentence
|
||||||
|
level: warning
|
||||||
|
tokens:
|
||||||
|
- '(?:[^,]+,){1,}\s\w+\s(?:and|or)'
|
||||||
@@ -0,0 +1,7 @@
|
|||||||
|
extends: existence
|
||||||
|
message: "Use parentheses judiciously."
|
||||||
|
link: 'https://developers.google.com/style/parentheses'
|
||||||
|
nonword: true
|
||||||
|
level: suggestion
|
||||||
|
tokens:
|
||||||
|
- '\(.+\)'
|
||||||
@@ -0,0 +1,184 @@
|
|||||||
|
extends: existence
|
||||||
|
link: 'https://developers.google.com/style/voice'
|
||||||
|
message: "In general, use active voice instead of passive voice ('%s')."
|
||||||
|
ignorecase: true
|
||||||
|
level: suggestion
|
||||||
|
raw:
|
||||||
|
- \b(am|are|were|being|is|been|was|be)\b\s*
|
||||||
|
tokens:
|
||||||
|
- '[\w]+ed'
|
||||||
|
- awoken
|
||||||
|
- beat
|
||||||
|
- become
|
||||||
|
- been
|
||||||
|
- begun
|
||||||
|
- bent
|
||||||
|
- beset
|
||||||
|
- bet
|
||||||
|
- bid
|
||||||
|
- bidden
|
||||||
|
- bitten
|
||||||
|
- bled
|
||||||
|
- blown
|
||||||
|
- born
|
||||||
|
- bought
|
||||||
|
- bound
|
||||||
|
- bred
|
||||||
|
- broadcast
|
||||||
|
- broken
|
||||||
|
- brought
|
||||||
|
- built
|
||||||
|
- burnt
|
||||||
|
- burst
|
||||||
|
- cast
|
||||||
|
- caught
|
||||||
|
- chosen
|
||||||
|
- clung
|
||||||
|
- come
|
||||||
|
- cost
|
||||||
|
- crept
|
||||||
|
- cut
|
||||||
|
- dealt
|
||||||
|
- dived
|
||||||
|
- done
|
||||||
|
- drawn
|
||||||
|
- dreamt
|
||||||
|
- driven
|
||||||
|
- drunk
|
||||||
|
- dug
|
||||||
|
- eaten
|
||||||
|
- fallen
|
||||||
|
- fed
|
||||||
|
- felt
|
||||||
|
- fit
|
||||||
|
- fled
|
||||||
|
- flown
|
||||||
|
- flung
|
||||||
|
- forbidden
|
||||||
|
- foregone
|
||||||
|
- forgiven
|
||||||
|
- forgotten
|
||||||
|
- forsaken
|
||||||
|
- fought
|
||||||
|
- found
|
||||||
|
- frozen
|
||||||
|
- given
|
||||||
|
- gone
|
||||||
|
- gotten
|
||||||
|
- ground
|
||||||
|
- grown
|
||||||
|
- heard
|
||||||
|
- held
|
||||||
|
- hidden
|
||||||
|
- hit
|
||||||
|
- hung
|
||||||
|
- hurt
|
||||||
|
- kept
|
||||||
|
- knelt
|
||||||
|
- knit
|
||||||
|
- known
|
||||||
|
- laid
|
||||||
|
- lain
|
||||||
|
- leapt
|
||||||
|
- learnt
|
||||||
|
- led
|
||||||
|
- left
|
||||||
|
- lent
|
||||||
|
- let
|
||||||
|
- lighted
|
||||||
|
- lost
|
||||||
|
- made
|
||||||
|
- meant
|
||||||
|
- met
|
||||||
|
- misspelt
|
||||||
|
- mistaken
|
||||||
|
- mown
|
||||||
|
- overcome
|
||||||
|
- overdone
|
||||||
|
- overtaken
|
||||||
|
- overthrown
|
||||||
|
- paid
|
||||||
|
- pled
|
||||||
|
- proven
|
||||||
|
- put
|
||||||
|
- quit
|
||||||
|
- read
|
||||||
|
- rid
|
||||||
|
- ridden
|
||||||
|
- risen
|
||||||
|
- run
|
||||||
|
- rung
|
||||||
|
- said
|
||||||
|
- sat
|
||||||
|
- sawn
|
||||||
|
- seen
|
||||||
|
- sent
|
||||||
|
- set
|
||||||
|
- sewn
|
||||||
|
- shaken
|
||||||
|
- shaven
|
||||||
|
- shed
|
||||||
|
- shod
|
||||||
|
- shone
|
||||||
|
- shorn
|
||||||
|
- shot
|
||||||
|
- shown
|
||||||
|
- shrunk
|
||||||
|
- shut
|
||||||
|
- slain
|
||||||
|
- slept
|
||||||
|
- slid
|
||||||
|
- slit
|
||||||
|
- slung
|
||||||
|
- smitten
|
||||||
|
- sold
|
||||||
|
- sought
|
||||||
|
- sown
|
||||||
|
- sped
|
||||||
|
- spent
|
||||||
|
- spilt
|
||||||
|
- spit
|
||||||
|
- split
|
||||||
|
- spoken
|
||||||
|
- spread
|
||||||
|
- sprung
|
||||||
|
- spun
|
||||||
|
- stolen
|
||||||
|
- stood
|
||||||
|
- stridden
|
||||||
|
- striven
|
||||||
|
- struck
|
||||||
|
- strung
|
||||||
|
- stuck
|
||||||
|
- stung
|
||||||
|
- stunk
|
||||||
|
- sung
|
||||||
|
- sunk
|
||||||
|
- swept
|
||||||
|
- swollen
|
||||||
|
- sworn
|
||||||
|
- swum
|
||||||
|
- swung
|
||||||
|
- taken
|
||||||
|
- taught
|
||||||
|
- thought
|
||||||
|
- thrived
|
||||||
|
- thrown
|
||||||
|
- thrust
|
||||||
|
- told
|
||||||
|
- torn
|
||||||
|
- trodden
|
||||||
|
- understood
|
||||||
|
- upheld
|
||||||
|
- upset
|
||||||
|
- wed
|
||||||
|
- wept
|
||||||
|
- withheld
|
||||||
|
- withstood
|
||||||
|
- woken
|
||||||
|
- won
|
||||||
|
- worn
|
||||||
|
- wound
|
||||||
|
- woven
|
||||||
|
- written
|
||||||
|
- wrung
|
||||||
@@ -0,0 +1,7 @@
|
|||||||
|
extends: existence
|
||||||
|
message: "Don't use periods with acronyms or initialisms such as '%s'."
|
||||||
|
link: 'https://developers.google.com/style/abbreviations'
|
||||||
|
level: error
|
||||||
|
nonword: true
|
||||||
|
tokens:
|
||||||
|
- '\b(?:[A-Z]\.){3,}'
|
||||||
@@ -0,0 +1,7 @@
|
|||||||
|
extends: existence
|
||||||
|
message: "Commas and periods go inside quotation marks."
|
||||||
|
link: 'https://developers.google.com/style/quotation-marks'
|
||||||
|
level: error
|
||||||
|
nonword: true
|
||||||
|
tokens:
|
||||||
|
- '"[^"]+"[.,?]'
|
||||||
@@ -0,0 +1,7 @@
|
|||||||
|
extends: existence
|
||||||
|
message: "Don't add words such as 'from' or 'between' to describe a range of numbers."
|
||||||
|
link: 'https://developers.google.com/style/hyphens'
|
||||||
|
nonword: true
|
||||||
|
level: warning
|
||||||
|
tokens:
|
||||||
|
- '(?:from|between)\s\d+\s?-\s?\d+'
|
||||||
@@ -0,0 +1,8 @@
|
|||||||
|
extends: existence
|
||||||
|
message: "Use semicolons judiciously."
|
||||||
|
link: 'https://developers.google.com/style/semicolons'
|
||||||
|
nonword: true
|
||||||
|
scope: sentence
|
||||||
|
level: suggestion
|
||||||
|
tokens:
|
||||||
|
- ';'
|
||||||
@@ -0,0 +1,11 @@
|
|||||||
|
extends: existence
|
||||||
|
message: "Don't use internet slang abbreviations such as '%s'."
|
||||||
|
link: 'https://developers.google.com/style/abbreviations'
|
||||||
|
ignorecase: true
|
||||||
|
level: error
|
||||||
|
tokens:
|
||||||
|
- 'tl;dr'
|
||||||
|
- ymmv
|
||||||
|
- rtfm
|
||||||
|
- imo
|
||||||
|
- fwiw
|
||||||
@@ -0,0 +1,10 @@
|
|||||||
|
extends: existence
|
||||||
|
message: "'%s' should have one space."
|
||||||
|
link: 'https://developers.google.com/style/sentence-spacing'
|
||||||
|
level: error
|
||||||
|
nonword: true
|
||||||
|
action:
|
||||||
|
name: remove
|
||||||
|
tokens:
|
||||||
|
- '[a-z][.?!] {2,}[A-Z]'
|
||||||
|
- '[a-z][.?!][A-Z]'
|
||||||
@@ -0,0 +1,10 @@
|
|||||||
|
extends: existence
|
||||||
|
message: "In general, use American spelling instead of '%s'."
|
||||||
|
link: 'https://developers.google.com/style/spelling'
|
||||||
|
ignorecase: true
|
||||||
|
level: warning
|
||||||
|
tokens:
|
||||||
|
- '(?:\w+)nised?'
|
||||||
|
- 'colour'
|
||||||
|
- 'labour'
|
||||||
|
- 'centre'
|
||||||
@@ -0,0 +1,8 @@
|
|||||||
|
extends: existence
|
||||||
|
message: "Put a nonbreaking space between the number and the unit in '%s'."
|
||||||
|
link: "https://developers.google.com/style/units-of-measure"
|
||||||
|
nonword: true
|
||||||
|
level: error
|
||||||
|
tokens:
|
||||||
|
- \b\d+(?:B|kB|MB|GB|TB)
|
||||||
|
- \b\d+(?:ns|ms|s|min|h|d)
|
||||||
@@ -0,0 +1,11 @@
|
|||||||
|
extends: existence
|
||||||
|
message: "Try to avoid using first-person plural like '%s'."
|
||||||
|
link: 'https://developers.google.com/style/pronouns#personal-pronouns'
|
||||||
|
level: warning
|
||||||
|
ignorecase: true
|
||||||
|
tokens:
|
||||||
|
- we
|
||||||
|
- we'(?:ve|re)
|
||||||
|
- ours?
|
||||||
|
- us
|
||||||
|
- let's
|
||||||
@@ -0,0 +1,7 @@
|
|||||||
|
extends: existence
|
||||||
|
message: "Avoid using '%s'."
|
||||||
|
link: 'https://developers.google.com/style/tense'
|
||||||
|
ignorecase: true
|
||||||
|
level: warning
|
||||||
|
tokens:
|
||||||
|
- will
|
||||||
@@ -0,0 +1,80 @@
|
|||||||
|
extends: substitution
|
||||||
|
message: "Use '%s' instead of '%s'."
|
||||||
|
link: "https://developers.google.com/style/word-list"
|
||||||
|
level: warning
|
||||||
|
ignorecase: false
|
||||||
|
action:
|
||||||
|
name: replace
|
||||||
|
swap:
|
||||||
|
"(?:API Console|dev|developer) key": API key
|
||||||
|
"(?:cell ?phone|smart ?phone)": phone|mobile phone
|
||||||
|
"(?:dev|developer|APIs) console": API console
|
||||||
|
"(?:e-mail|Email|E-mail)": email
|
||||||
|
"(?:file ?path|path ?name)": path
|
||||||
|
"(?:kill|terminate|abort)": stop|exit|cancel|end
|
||||||
|
"(?:OAuth ?2|Oauth)": OAuth 2.0
|
||||||
|
"(?:ok|Okay)": OK|okay
|
||||||
|
"(?:WiFi|wifi)": Wi-Fi
|
||||||
|
'[\.]+apk': APK
|
||||||
|
'3\-D': 3D
|
||||||
|
'Google (?:I\-O|IO)': Google I/O
|
||||||
|
"tap (?:&|and) hold": touch & hold
|
||||||
|
"un(?:check|select)": clear
|
||||||
|
above: preceding
|
||||||
|
account name: username
|
||||||
|
action bar: app bar
|
||||||
|
admin: administrator
|
||||||
|
Ajax: AJAX
|
||||||
|
a\.k\.a|aka: or|also known as
|
||||||
|
Android device: Android-powered device
|
||||||
|
android: Android
|
||||||
|
API explorer: APIs Explorer
|
||||||
|
application: app
|
||||||
|
approx\.: approximately
|
||||||
|
authN: authentication
|
||||||
|
authZ: authorization
|
||||||
|
autoupdate: automatically update
|
||||||
|
cellular data: mobile data
|
||||||
|
cellular network: mobile network
|
||||||
|
chapter: documents|pages|sections
|
||||||
|
check box: checkbox
|
||||||
|
CLI: command-line tool
|
||||||
|
click on: click|click in
|
||||||
|
Cloud: Google Cloud Platform|GCP
|
||||||
|
Container Engine: Kubernetes Engine
|
||||||
|
content type: media type
|
||||||
|
curated roles: predefined roles
|
||||||
|
data are: data is
|
||||||
|
Developers Console: Google API Console|API Console
|
||||||
|
disabled?: turn off|off
|
||||||
|
ephemeral IP address: ephemeral external IP address
|
||||||
|
fewer data: less data
|
||||||
|
file name: filename
|
||||||
|
firewalls: firewall rules
|
||||||
|
functionality: capability|feature
|
||||||
|
Google account: Google Account
|
||||||
|
Google accounts: Google Accounts
|
||||||
|
Googling: search with Google
|
||||||
|
grayed-out: unavailable
|
||||||
|
HTTPs: HTTPS
|
||||||
|
in order to: to
|
||||||
|
ingest: import|load
|
||||||
|
k8s: Kubernetes
|
||||||
|
long press: touch & hold
|
||||||
|
network IP address: internal IP address
|
||||||
|
omnibox: address bar
|
||||||
|
open-source: open source
|
||||||
|
overview screen: recents screen
|
||||||
|
regex: regular expression
|
||||||
|
SHA1: SHA-1|HAS-SHA1
|
||||||
|
sign into: sign in to
|
||||||
|
sign-?on: single sign-on
|
||||||
|
static IP address: static external IP address
|
||||||
|
stylesheet: style sheet
|
||||||
|
synch: sync
|
||||||
|
tablename: table name
|
||||||
|
tablet: device
|
||||||
|
touch: tap
|
||||||
|
url: URL
|
||||||
|
vs\.: versus
|
||||||
|
World Wide Web: web
|
||||||
@@ -0,0 +1,4 @@
|
|||||||
|
{
|
||||||
|
"feed": "https://github.com/errata-ai/Google/releases.atom",
|
||||||
|
"vale_version": ">=1.0.0"
|
||||||
|
}
|
||||||
@@ -0,0 +1,8 @@
|
|||||||
|
extends: metric
|
||||||
|
message: "Try to keep the Automated Readability Index (%s) below 8."
|
||||||
|
link: https://en.wikipedia.org/wiki/Automated_readability_index
|
||||||
|
|
||||||
|
formula: |
|
||||||
|
(4.71 * (characters / words)) + (0.5 * (words / sentences)) - 21.43
|
||||||
|
|
||||||
|
condition: "> 8"
|
||||||
@@ -0,0 +1,8 @@
|
|||||||
|
extends: metric
|
||||||
|
message: "Try to keep the Coleman–Liau Index grade (%s) below 9."
|
||||||
|
link: https://en.wikipedia.org/wiki/Coleman%E2%80%93Liau_index
|
||||||
|
|
||||||
|
formula: |
|
||||||
|
(0.0588 * (characters / words) * 100) - (0.296 * (sentences / words) * 100) - 15.8
|
||||||
|
|
||||||
|
condition: "> 9"
|
||||||
@@ -0,0 +1,8 @@
|
|||||||
|
extends: metric
|
||||||
|
message: "Try to keep the Flesch–Kincaid grade level (%s) below 8."
|
||||||
|
link: https://en.wikipedia.org/wiki/Flesch%E2%80%93Kincaid_readability_tests
|
||||||
|
|
||||||
|
formula: |
|
||||||
|
(0.39 * (words / sentences)) + (11.8 * (syllables / words)) - 15.59
|
||||||
|
|
||||||
|
condition: "> 8"
|
||||||
@@ -0,0 +1,8 @@
|
|||||||
|
extends: metric
|
||||||
|
message: "Try to keep the Flesch reading ease score (%s) above 70."
|
||||||
|
link: https://en.wikipedia.org/wiki/Flesch%E2%80%93Kincaid_readability_tests
|
||||||
|
|
||||||
|
formula: |
|
||||||
|
206.835 - (1.015 * (words / sentences)) - (84.6 * (syllables / words))
|
||||||
|
|
||||||
|
condition: "< 70"
|
||||||
@@ -0,0 +1,8 @@
|
|||||||
|
extends: metric
|
||||||
|
message: "Try to keep the Gunning-Fog index (%s) below 10."
|
||||||
|
link: https://en.wikipedia.org/wiki/Gunning_fog_index
|
||||||
|
|
||||||
|
formula: |
|
||||||
|
0.4 * ((words / sentences) + 100 * (complex_words / words))
|
||||||
|
|
||||||
|
condition: "> 10"
|
||||||
@@ -0,0 +1,17 @@
|
|||||||
|
extends: metric
|
||||||
|
message: "Try to keep the LIX score (%s) below 35."
|
||||||
|
|
||||||
|
link: https://en.wikipedia.org/wiki/Lix_(readability_test)
|
||||||
|
# Very Easy: 20 - 25
|
||||||
|
#
|
||||||
|
# Easy: 30 - 35
|
||||||
|
#
|
||||||
|
# Medium: 40 - 45
|
||||||
|
#
|
||||||
|
# Difficult: 50 - 55
|
||||||
|
#
|
||||||
|
# Very Difficult: 60+
|
||||||
|
formula: |
|
||||||
|
(words / sentences) + ((long_words * 100) / words)
|
||||||
|
|
||||||
|
condition: "> 35"
|
||||||
@@ -0,0 +1,8 @@
|
|||||||
|
extends: metric
|
||||||
|
message: "Try to keep the SMOG grade (%s) below 10."
|
||||||
|
link: https://en.wikipedia.org/wiki/SMOG
|
||||||
|
|
||||||
|
formula: |
|
||||||
|
1.0430 * math.sqrt((polysyllabic_words * 30.0) / sentences) + 3.1291
|
||||||
|
|
||||||
|
condition: "> 10"
|
||||||
@@ -0,0 +1,4 @@
|
|||||||
|
{
|
||||||
|
"feed": "https://github.com/errata-ai/Readability/releases.atom",
|
||||||
|
"vale_version": ">=2.13.0"
|
||||||
|
}
|
||||||
@@ -0,0 +1,38 @@
|
|||||||
|
devx
|
||||||
|
Gitea
|
||||||
|
ZITADEL
|
||||||
|
OpenTofu
|
||||||
|
Ansible
|
||||||
|
Vaultwarden
|
||||||
|
Nextcloud
|
||||||
|
Vikunja
|
||||||
|
Mattermost
|
||||||
|
Prometheus
|
||||||
|
Grafana
|
||||||
|
Loki
|
||||||
|
Alertmanager
|
||||||
|
Promtail
|
||||||
|
pyproject
|
||||||
|
tofu
|
||||||
|
act_runner
|
||||||
|
actionlint
|
||||||
|
hadolint
|
||||||
|
git-cliff
|
||||||
|
pre-commit
|
||||||
|
semver
|
||||||
|
changelog
|
||||||
|
idempotent
|
||||||
|
rootless
|
||||||
|
OIDC
|
||||||
|
SSO
|
||||||
|
SAML
|
||||||
|
LDAP
|
||||||
|
pytest
|
||||||
|
molecule
|
||||||
|
ruff
|
||||||
|
pyright
|
||||||
|
bandit
|
||||||
|
Vikunja
|
||||||
|
oblachno
|
||||||
|
Oblachno
|
||||||
|
Bulgarian
|
||||||
@@ -0,0 +1,6 @@
|
|||||||
|
extends: existence
|
||||||
|
message: "Unlabeled code block — add a language tag (```bash, ```yaml, etc.)"
|
||||||
|
level: warning
|
||||||
|
scope: raw
|
||||||
|
raw:
|
||||||
|
- '(?ms)^\n```\n.*?^```\s*$'
|
||||||
@@ -0,0 +1,13 @@
|
|||||||
|
extends: existence
|
||||||
|
message: "Avoid '%s' — it's condescending in technical documentation"
|
||||||
|
level: warning
|
||||||
|
ignorecase: true
|
||||||
|
tokens:
|
||||||
|
- '\bsimply\b'
|
||||||
|
- '\bjust\b'
|
||||||
|
- '\bobviously\b'
|
||||||
|
- '\bof course\b'
|
||||||
|
- '\bas you (can )?see\b'
|
||||||
|
- '\beasily\b'
|
||||||
|
- '\btrivial\b'
|
||||||
|
- '\bstraightforward\b'
|
||||||
@@ -0,0 +1,3 @@
|
|||||||
|
# Custom Vale style for devx documentation
|
||||||
|
|
||||||
|
Project-specific terminology and style rules
|
||||||
@@ -0,0 +1,11 @@
|
|||||||
|
extends: substitution
|
||||||
|
message: "Use '%s' instead of '%s' (terminology consistency)"
|
||||||
|
level: error
|
||||||
|
ignorecase: false
|
||||||
|
swap:
|
||||||
|
'\b(?i)gitea\b': Gitea
|
||||||
|
'\b(?i)zitadel\b': ZITADEL
|
||||||
|
'\b(?i)opentofu\b': OpenTofu
|
||||||
|
'\b(?i)vaultwarden\b': Vaultwarden
|
||||||
|
'\b(?i)nextcloud\b': Nextcloud
|
||||||
|
'\b(?i)mattermost\b': Mattermost
|
||||||
@@ -0,0 +1,702 @@
|
|||||||
|
extends: existence
|
||||||
|
message: "Try to avoid using clichés like '%s'."
|
||||||
|
ignorecase: true
|
||||||
|
level: warning
|
||||||
|
tokens:
|
||||||
|
- a chip off the old block
|
||||||
|
- a clean slate
|
||||||
|
- a dark and stormy night
|
||||||
|
- a far cry
|
||||||
|
- a fine kettle of fish
|
||||||
|
- a loose cannon
|
||||||
|
- a penny saved is a penny earned
|
||||||
|
- a tough row to hoe
|
||||||
|
- a word to the wise
|
||||||
|
- ace in the hole
|
||||||
|
- acid test
|
||||||
|
- add insult to injury
|
||||||
|
- against all odds
|
||||||
|
- air your dirty laundry
|
||||||
|
- all fun and games
|
||||||
|
- all in a day's work
|
||||||
|
- all talk, no action
|
||||||
|
- all thumbs
|
||||||
|
- all your eggs in one basket
|
||||||
|
- all's fair in love and war
|
||||||
|
- all's well that ends well
|
||||||
|
- almighty dollar
|
||||||
|
- American as apple pie
|
||||||
|
- an axe to grind
|
||||||
|
- another day, another dollar
|
||||||
|
- armed to the teeth
|
||||||
|
- as luck would have it
|
||||||
|
- as old as time
|
||||||
|
- as the crow flies
|
||||||
|
- at loose ends
|
||||||
|
- at my wits end
|
||||||
|
- avoid like the plague
|
||||||
|
- babe in the woods
|
||||||
|
- back against the wall
|
||||||
|
- back in the saddle
|
||||||
|
- back to square one
|
||||||
|
- back to the drawing board
|
||||||
|
- bad to the bone
|
||||||
|
- badge of honor
|
||||||
|
- bald faced liar
|
||||||
|
- ballpark figure
|
||||||
|
- banging your head against a brick wall
|
||||||
|
- baptism by fire
|
||||||
|
- barking up the wrong tree
|
||||||
|
- bat out of hell
|
||||||
|
- be all and end all
|
||||||
|
- beat a dead horse
|
||||||
|
- beat around the bush
|
||||||
|
- been there, done that
|
||||||
|
- beggars can't be choosers
|
||||||
|
- behind the eight ball
|
||||||
|
- bend over backwards
|
||||||
|
- benefit of the doubt
|
||||||
|
- bent out of shape
|
||||||
|
- best thing since sliced bread
|
||||||
|
- bet your bottom dollar
|
||||||
|
- better half
|
||||||
|
- better late than never
|
||||||
|
- better mousetrap
|
||||||
|
- better safe than sorry
|
||||||
|
- between a rock and a hard place
|
||||||
|
- beyond the pale
|
||||||
|
- bide your time
|
||||||
|
- big as life
|
||||||
|
- big cheese
|
||||||
|
- big fish in a small pond
|
||||||
|
- big man on campus
|
||||||
|
- bigger they are the harder they fall
|
||||||
|
- bird in the hand
|
||||||
|
- bird's eye view
|
||||||
|
- birds and the bees
|
||||||
|
- birds of a feather flock together
|
||||||
|
- bit the hand that feeds you
|
||||||
|
- bite the bullet
|
||||||
|
- bite the dust
|
||||||
|
- bitten off more than he can chew
|
||||||
|
- black as coal
|
||||||
|
- black as pitch
|
||||||
|
- black as the ace of spades
|
||||||
|
- blast from the past
|
||||||
|
- bleeding heart
|
||||||
|
- blessing in disguise
|
||||||
|
- blind ambition
|
||||||
|
- blind as a bat
|
||||||
|
- blind leading the blind
|
||||||
|
- blood is thicker than water
|
||||||
|
- blood sweat and tears
|
||||||
|
- blow off steam
|
||||||
|
- blow your own horn
|
||||||
|
- blushing bride
|
||||||
|
- boils down to
|
||||||
|
- bolt from the blue
|
||||||
|
- bone to pick
|
||||||
|
- bored stiff
|
||||||
|
- bored to tears
|
||||||
|
- bottomless pit
|
||||||
|
- boys will be boys
|
||||||
|
- bright and early
|
||||||
|
- brings home the bacon
|
||||||
|
- broad across the beam
|
||||||
|
- broken record
|
||||||
|
- brought back to reality
|
||||||
|
- bull by the horns
|
||||||
|
- bull in a china shop
|
||||||
|
- burn the midnight oil
|
||||||
|
- burning question
|
||||||
|
- burning the candle at both ends
|
||||||
|
- burst your bubble
|
||||||
|
- bury the hatchet
|
||||||
|
- busy as a bee
|
||||||
|
- by hook or by crook
|
||||||
|
- call a spade a spade
|
||||||
|
- called onto the carpet
|
||||||
|
- calm before the storm
|
||||||
|
- can of worms
|
||||||
|
- can't cut the mustard
|
||||||
|
- can't hold a candle to
|
||||||
|
- case of mistaken identity
|
||||||
|
- cat got your tongue
|
||||||
|
- cat's meow
|
||||||
|
- caught in the crossfire
|
||||||
|
- caught red-handed
|
||||||
|
- checkered past
|
||||||
|
- chomping at the bit
|
||||||
|
- cleanliness is next to godliness
|
||||||
|
- clear as a bell
|
||||||
|
- clear as mud
|
||||||
|
- close to the vest
|
||||||
|
- cock and bull story
|
||||||
|
- cold shoulder
|
||||||
|
- come hell or high water
|
||||||
|
- cool as a cucumber
|
||||||
|
- cool, calm, and collected
|
||||||
|
- cost a king's ransom
|
||||||
|
- count your blessings
|
||||||
|
- crack of dawn
|
||||||
|
- crash course
|
||||||
|
- creature comforts
|
||||||
|
- cross that bridge when you come to it
|
||||||
|
- crushing blow
|
||||||
|
- cry like a baby
|
||||||
|
- cry me a river
|
||||||
|
- cry over spilt milk
|
||||||
|
- crystal clear
|
||||||
|
- curiosity killed the cat
|
||||||
|
- cut and dried
|
||||||
|
- cut through the red tape
|
||||||
|
- cut to the chase
|
||||||
|
- cute as a bugs ear
|
||||||
|
- cute as a button
|
||||||
|
- cute as a puppy
|
||||||
|
- cuts to the quick
|
||||||
|
- dark before the dawn
|
||||||
|
- day in, day out
|
||||||
|
- dead as a doornail
|
||||||
|
- devil is in the details
|
||||||
|
- dime a dozen
|
||||||
|
- divide and conquer
|
||||||
|
- dog and pony show
|
||||||
|
- dog days
|
||||||
|
- dog eat dog
|
||||||
|
- dog tired
|
||||||
|
- don't burn your bridges
|
||||||
|
- don't count your chickens
|
||||||
|
- don't look a gift horse in the mouth
|
||||||
|
- don't rock the boat
|
||||||
|
- don't step on anyone's toes
|
||||||
|
- don't take any wooden nickels
|
||||||
|
- down and out
|
||||||
|
- down at the heels
|
||||||
|
- down in the dumps
|
||||||
|
- down the hatch
|
||||||
|
- down to earth
|
||||||
|
- draw the line
|
||||||
|
- dressed to kill
|
||||||
|
- dressed to the nines
|
||||||
|
- drives me up the wall
|
||||||
|
- dull as dishwater
|
||||||
|
- dyed in the wool
|
||||||
|
- eagle eye
|
||||||
|
- ear to the ground
|
||||||
|
- early bird catches the worm
|
||||||
|
- easier said than done
|
||||||
|
- easy as pie
|
||||||
|
- eat your heart out
|
||||||
|
- eat your words
|
||||||
|
- eleventh hour
|
||||||
|
- even the playing field
|
||||||
|
- every dog has its day
|
||||||
|
- every fiber of my being
|
||||||
|
- everything but the kitchen sink
|
||||||
|
- eye for an eye
|
||||||
|
- face the music
|
||||||
|
- facts of life
|
||||||
|
- fair weather friend
|
||||||
|
- fall by the wayside
|
||||||
|
- fan the flames
|
||||||
|
- feast or famine
|
||||||
|
- feather your nest
|
||||||
|
- feathered friends
|
||||||
|
- few and far between
|
||||||
|
- fifteen minutes of fame
|
||||||
|
- filthy vermin
|
||||||
|
- fine kettle of fish
|
||||||
|
- fish out of water
|
||||||
|
- fishing for a compliment
|
||||||
|
- fit as a fiddle
|
||||||
|
- fit the bill
|
||||||
|
- fit to be tied
|
||||||
|
- flash in the pan
|
||||||
|
- flat as a pancake
|
||||||
|
- flip your lid
|
||||||
|
- flog a dead horse
|
||||||
|
- fly by night
|
||||||
|
- fly the coop
|
||||||
|
- follow your heart
|
||||||
|
- for all intents and purposes
|
||||||
|
- for the birds
|
||||||
|
- for what it's worth
|
||||||
|
- force of nature
|
||||||
|
- force to be reckoned with
|
||||||
|
- forgive and forget
|
||||||
|
- fox in the henhouse
|
||||||
|
- free and easy
|
||||||
|
- free as a bird
|
||||||
|
- fresh as a daisy
|
||||||
|
- full steam ahead
|
||||||
|
- fun in the sun
|
||||||
|
- garbage in, garbage out
|
||||||
|
- gentle as a lamb
|
||||||
|
- get a kick out of
|
||||||
|
- get a leg up
|
||||||
|
- get down and dirty
|
||||||
|
- get the lead out
|
||||||
|
- get to the bottom of
|
||||||
|
- get your feet wet
|
||||||
|
- gets my goat
|
||||||
|
- gilding the lily
|
||||||
|
- give and take
|
||||||
|
- go against the grain
|
||||||
|
- go at it tooth and nail
|
||||||
|
- go for broke
|
||||||
|
- go him one better
|
||||||
|
- go the extra mile
|
||||||
|
- go with the flow
|
||||||
|
- goes without saying
|
||||||
|
- good as gold
|
||||||
|
- good deed for the day
|
||||||
|
- good things come to those who wait
|
||||||
|
- good time was had by all
|
||||||
|
- good times were had by all
|
||||||
|
- greased lightning
|
||||||
|
- greek to me
|
||||||
|
- green thumb
|
||||||
|
- green-eyed monster
|
||||||
|
- grist for the mill
|
||||||
|
- growing like a weed
|
||||||
|
- hair of the dog
|
||||||
|
- hand to mouth
|
||||||
|
- happy as a clam
|
||||||
|
- happy as a lark
|
||||||
|
- hasn't a clue
|
||||||
|
- have a nice day
|
||||||
|
- have high hopes
|
||||||
|
- have the last laugh
|
||||||
|
- haven't got a row to hoe
|
||||||
|
- head honcho
|
||||||
|
- head over heels
|
||||||
|
- hear a pin drop
|
||||||
|
- heard it through the grapevine
|
||||||
|
- heart's content
|
||||||
|
- heavy as lead
|
||||||
|
- hem and haw
|
||||||
|
- high and dry
|
||||||
|
- high and mighty
|
||||||
|
- high as a kite
|
||||||
|
- hit paydirt
|
||||||
|
- hold your head up high
|
||||||
|
- hold your horses
|
||||||
|
- hold your own
|
||||||
|
- hold your tongue
|
||||||
|
- honest as the day is long
|
||||||
|
- horns of a dilemma
|
||||||
|
- horse of a different color
|
||||||
|
- hot under the collar
|
||||||
|
- hour of need
|
||||||
|
- I beg to differ
|
||||||
|
- icing on the cake
|
||||||
|
- if the shoe fits
|
||||||
|
- if the shoe were on the other foot
|
||||||
|
- in a jam
|
||||||
|
- in a jiffy
|
||||||
|
- in a nutshell
|
||||||
|
- in a pig's eye
|
||||||
|
- in a pinch
|
||||||
|
- in a word
|
||||||
|
- in hot water
|
||||||
|
- in the gutter
|
||||||
|
- in the nick of time
|
||||||
|
- in the thick of it
|
||||||
|
- in your dreams
|
||||||
|
- it ain't over till the fat lady sings
|
||||||
|
- it goes without saying
|
||||||
|
- it takes all kinds
|
||||||
|
- it takes one to know one
|
||||||
|
- it's a small world
|
||||||
|
- it's only a matter of time
|
||||||
|
- ivory tower
|
||||||
|
- Jack of all trades
|
||||||
|
- jockey for position
|
||||||
|
- jog your memory
|
||||||
|
- joined at the hip
|
||||||
|
- judge a book by its cover
|
||||||
|
- jump down your throat
|
||||||
|
- jump in with both feet
|
||||||
|
- jump on the bandwagon
|
||||||
|
- jump the gun
|
||||||
|
- jump to conclusions
|
||||||
|
- just a hop, skip, and a jump
|
||||||
|
- just the ticket
|
||||||
|
- justice is blind
|
||||||
|
- keep a stiff upper lip
|
||||||
|
- keep an eye on
|
||||||
|
- keep it simple, stupid
|
||||||
|
- keep the home fires burning
|
||||||
|
- keep up with the Joneses
|
||||||
|
- keep your chin up
|
||||||
|
- keep your fingers crossed
|
||||||
|
- kick the bucket
|
||||||
|
- kick up your heels
|
||||||
|
- kick your feet up
|
||||||
|
- kid in a candy store
|
||||||
|
- kill two birds with one stone
|
||||||
|
- kiss of death
|
||||||
|
- knock it out of the park
|
||||||
|
- knock on wood
|
||||||
|
- knock your socks off
|
||||||
|
- know him from Adam
|
||||||
|
- know the ropes
|
||||||
|
- know the score
|
||||||
|
- knuckle down
|
||||||
|
- knuckle sandwich
|
||||||
|
- knuckle under
|
||||||
|
- labor of love
|
||||||
|
- ladder of success
|
||||||
|
- land on your feet
|
||||||
|
- lap of luxury
|
||||||
|
- last but not least
|
||||||
|
- last hurrah
|
||||||
|
- last-ditch effort
|
||||||
|
- law of the jungle
|
||||||
|
- law of the land
|
||||||
|
- lay down the law
|
||||||
|
- leaps and bounds
|
||||||
|
- let sleeping dogs lie
|
||||||
|
- let the cat out of the bag
|
||||||
|
- let the good times roll
|
||||||
|
- let your hair down
|
||||||
|
- let's talk turkey
|
||||||
|
- letter perfect
|
||||||
|
- lick your wounds
|
||||||
|
- lies like a rug
|
||||||
|
- life's a bitch
|
||||||
|
- life's a grind
|
||||||
|
- light at the end of the tunnel
|
||||||
|
- lighter than a feather
|
||||||
|
- lighter than air
|
||||||
|
- like clockwork
|
||||||
|
- like father like son
|
||||||
|
- like taking candy from a baby
|
||||||
|
- like there's no tomorrow
|
||||||
|
- lion's share
|
||||||
|
- live and learn
|
||||||
|
- live and let live
|
||||||
|
- long and short of it
|
||||||
|
- long lost love
|
||||||
|
- look before you leap
|
||||||
|
- look down your nose
|
||||||
|
- look what the cat dragged in
|
||||||
|
- looking a gift horse in the mouth
|
||||||
|
- looks like death warmed over
|
||||||
|
- loose cannon
|
||||||
|
- lose your head
|
||||||
|
- lose your temper
|
||||||
|
- loud as a horn
|
||||||
|
- lounge lizard
|
||||||
|
- loved and lost
|
||||||
|
- low man on the totem pole
|
||||||
|
- luck of the draw
|
||||||
|
- luck of the Irish
|
||||||
|
- make hay while the sun shines
|
||||||
|
- make money hand over fist
|
||||||
|
- make my day
|
||||||
|
- make the best of a bad situation
|
||||||
|
- make the best of it
|
||||||
|
- make your blood boil
|
||||||
|
- man of few words
|
||||||
|
- man's best friend
|
||||||
|
- mark my words
|
||||||
|
- meaningful dialogue
|
||||||
|
- missed the boat on that one
|
||||||
|
- moment in the sun
|
||||||
|
- moment of glory
|
||||||
|
- moment of truth
|
||||||
|
- money to burn
|
||||||
|
- more power to you
|
||||||
|
- more than one way to skin a cat
|
||||||
|
- movers and shakers
|
||||||
|
- moving experience
|
||||||
|
- naked as a jaybird
|
||||||
|
- naked truth
|
||||||
|
- neat as a pin
|
||||||
|
- needle in a haystack
|
||||||
|
- needless to say
|
||||||
|
- neither here nor there
|
||||||
|
- never look back
|
||||||
|
- never say never
|
||||||
|
- nip and tuck
|
||||||
|
- nip it in the bud
|
||||||
|
- no guts, no glory
|
||||||
|
- no love lost
|
||||||
|
- no pain, no gain
|
||||||
|
- no skin off my back
|
||||||
|
- no stone unturned
|
||||||
|
- no time like the present
|
||||||
|
- no use crying over spilled milk
|
||||||
|
- nose to the grindstone
|
||||||
|
- not a hope in hell
|
||||||
|
- not a minute's peace
|
||||||
|
- not in my backyard
|
||||||
|
- not playing with a full deck
|
||||||
|
- not the end of the world
|
||||||
|
- not written in stone
|
||||||
|
- nothing to sneeze at
|
||||||
|
- nothing ventured nothing gained
|
||||||
|
- now we're cooking
|
||||||
|
- off the top of my head
|
||||||
|
- off the wagon
|
||||||
|
- off the wall
|
||||||
|
- old hat
|
||||||
|
- older and wiser
|
||||||
|
- older than dirt
|
||||||
|
- older than Methuselah
|
||||||
|
- on a roll
|
||||||
|
- on cloud nine
|
||||||
|
- on pins and needles
|
||||||
|
- on the bandwagon
|
||||||
|
- on the money
|
||||||
|
- on the nose
|
||||||
|
- on the rocks
|
||||||
|
- on the spot
|
||||||
|
- on the tip of my tongue
|
||||||
|
- on the wagon
|
||||||
|
- on thin ice
|
||||||
|
- once bitten, twice shy
|
||||||
|
- one bad apple doesn't spoil the bushel
|
||||||
|
- one born every minute
|
||||||
|
- one brick short
|
||||||
|
- one foot in the grave
|
||||||
|
- one in a million
|
||||||
|
- one red cent
|
||||||
|
- only game in town
|
||||||
|
- open a can of worms
|
||||||
|
- open and shut case
|
||||||
|
- open the flood gates
|
||||||
|
- opportunity doesn't knock twice
|
||||||
|
- out of pocket
|
||||||
|
- out of sight, out of mind
|
||||||
|
- out of the frying pan into the fire
|
||||||
|
- out of the woods
|
||||||
|
- out on a limb
|
||||||
|
- over a barrel
|
||||||
|
- over the hump
|
||||||
|
- pain and suffering
|
||||||
|
- pain in the
|
||||||
|
- panic button
|
||||||
|
- par for the course
|
||||||
|
- part and parcel
|
||||||
|
- party pooper
|
||||||
|
- pass the buck
|
||||||
|
- patience is a virtue
|
||||||
|
- pay through the nose
|
||||||
|
- penny pincher
|
||||||
|
- perfect storm
|
||||||
|
- pig in a poke
|
||||||
|
- pile it on
|
||||||
|
- pillar of the community
|
||||||
|
- pin your hopes on
|
||||||
|
- pitter patter of little feet
|
||||||
|
- plain as day
|
||||||
|
- plain as the nose on your face
|
||||||
|
- play by the rules
|
||||||
|
- play your cards right
|
||||||
|
- playing the field
|
||||||
|
- playing with fire
|
||||||
|
- pleased as punch
|
||||||
|
- plenty of fish in the sea
|
||||||
|
- point with pride
|
||||||
|
- poor as a church mouse
|
||||||
|
- pot calling the kettle black
|
||||||
|
- pretty as a picture
|
||||||
|
- pull a fast one
|
||||||
|
- pull your punches
|
||||||
|
- pulling your leg
|
||||||
|
- pure as the driven snow
|
||||||
|
- put it in a nutshell
|
||||||
|
- put one over on you
|
||||||
|
- put the cart before the horse
|
||||||
|
- put the pedal to the metal
|
||||||
|
- put your best foot forward
|
||||||
|
- put your foot down
|
||||||
|
- quick as a bunny
|
||||||
|
- quick as a lick
|
||||||
|
- quick as a wink
|
||||||
|
- quick as lightning
|
||||||
|
- quiet as a dormouse
|
||||||
|
- rags to riches
|
||||||
|
- raining buckets
|
||||||
|
- raining cats and dogs
|
||||||
|
- rank and file
|
||||||
|
- rat race
|
||||||
|
- reap what you sow
|
||||||
|
- red as a beet
|
||||||
|
- red herring
|
||||||
|
- reinvent the wheel
|
||||||
|
- rich and famous
|
||||||
|
- rings a bell
|
||||||
|
- ripe old age
|
||||||
|
- ripped me off
|
||||||
|
- rise and shine
|
||||||
|
- road to hell is paved with good intentions
|
||||||
|
- rob Peter to pay Paul
|
||||||
|
- roll over in the grave
|
||||||
|
- rub the wrong way
|
||||||
|
- ruled the roost
|
||||||
|
- running in circles
|
||||||
|
- sad but true
|
||||||
|
- sadder but wiser
|
||||||
|
- salt of the earth
|
||||||
|
- scared stiff
|
||||||
|
- scared to death
|
||||||
|
- sealed with a kiss
|
||||||
|
- second to none
|
||||||
|
- see eye to eye
|
||||||
|
- seen the light
|
||||||
|
- seize the day
|
||||||
|
- set the record straight
|
||||||
|
- set the world on fire
|
||||||
|
- set your teeth on edge
|
||||||
|
- sharp as a tack
|
||||||
|
- shoot for the moon
|
||||||
|
- shoot the breeze
|
||||||
|
- shot in the dark
|
||||||
|
- shoulder to the wheel
|
||||||
|
- sick as a dog
|
||||||
|
- sigh of relief
|
||||||
|
- signed, sealed, and delivered
|
||||||
|
- sink or swim
|
||||||
|
- six of one, half a dozen of another
|
||||||
|
- skating on thin ice
|
||||||
|
- slept like a log
|
||||||
|
- slinging mud
|
||||||
|
- slippery as an eel
|
||||||
|
- slow as molasses
|
||||||
|
- smart as a whip
|
||||||
|
- smooth as a baby's bottom
|
||||||
|
- sneaking suspicion
|
||||||
|
- snug as a bug in a rug
|
||||||
|
- sow wild oats
|
||||||
|
- spare the rod, spoil the child
|
||||||
|
- speak of the devil
|
||||||
|
- spilled the beans
|
||||||
|
- spinning your wheels
|
||||||
|
- spitting image of
|
||||||
|
- spoke with relish
|
||||||
|
- spread like wildfire
|
||||||
|
- spring to life
|
||||||
|
- squeaky wheel gets the grease
|
||||||
|
- stands out like a sore thumb
|
||||||
|
- start from scratch
|
||||||
|
- stick in the mud
|
||||||
|
- still waters run deep
|
||||||
|
- stitch in time
|
||||||
|
- stop and smell the roses
|
||||||
|
- straight as an arrow
|
||||||
|
- straw that broke the camel's back
|
||||||
|
- strong as an ox
|
||||||
|
- stubborn as a mule
|
||||||
|
- stuff that dreams are made of
|
||||||
|
- stuffed shirt
|
||||||
|
- sweating blood
|
||||||
|
- sweating bullets
|
||||||
|
- take a load off
|
||||||
|
- take one for the team
|
||||||
|
- take the bait
|
||||||
|
- take the bull by the horns
|
||||||
|
- take the plunge
|
||||||
|
- takes one to know one
|
||||||
|
- takes two to tango
|
||||||
|
- the more the merrier
|
||||||
|
- the real deal
|
||||||
|
- the real McCoy
|
||||||
|
- the red carpet treatment
|
||||||
|
- the same old story
|
||||||
|
- there is no accounting for taste
|
||||||
|
- thick as a brick
|
||||||
|
- thick as thieves
|
||||||
|
- thin as a rail
|
||||||
|
- think outside of the box
|
||||||
|
- third time's the charm
|
||||||
|
- this day and age
|
||||||
|
- this hurts me worse than it hurts you
|
||||||
|
- this point in time
|
||||||
|
- three sheets to the wind
|
||||||
|
- through thick and thin
|
||||||
|
- throw in the towel
|
||||||
|
- tie one on
|
||||||
|
- tighter than a drum
|
||||||
|
- time and time again
|
||||||
|
- time is of the essence
|
||||||
|
- tip of the iceberg
|
||||||
|
- tired but happy
|
||||||
|
- to coin a phrase
|
||||||
|
- to each his own
|
||||||
|
- to make a long story short
|
||||||
|
- to the best of my knowledge
|
||||||
|
- toe the line
|
||||||
|
- tongue in cheek
|
||||||
|
- too good to be true
|
||||||
|
- too hot to handle
|
||||||
|
- too numerous to mention
|
||||||
|
- touch with a ten foot pole
|
||||||
|
- tough as nails
|
||||||
|
- trial and error
|
||||||
|
- trials and tribulations
|
||||||
|
- tried and true
|
||||||
|
- trip down memory lane
|
||||||
|
- twist of fate
|
||||||
|
- two cents worth
|
||||||
|
- two peas in a pod
|
||||||
|
- ugly as sin
|
||||||
|
- under the counter
|
||||||
|
- under the gun
|
||||||
|
- under the same roof
|
||||||
|
- under the weather
|
||||||
|
- until the cows come home
|
||||||
|
- unvarnished truth
|
||||||
|
- up the creek
|
||||||
|
- uphill battle
|
||||||
|
- upper crust
|
||||||
|
- upset the applecart
|
||||||
|
- vain attempt
|
||||||
|
- vain effort
|
||||||
|
- vanquish the enemy
|
||||||
|
- vested interest
|
||||||
|
- waiting for the other shoe to drop
|
||||||
|
- wakeup call
|
||||||
|
- warm welcome
|
||||||
|
- watch your p's and q's
|
||||||
|
- watch your tongue
|
||||||
|
- watching the clock
|
||||||
|
- water under the bridge
|
||||||
|
- weather the storm
|
||||||
|
- weed them out
|
||||||
|
- week of Sundays
|
||||||
|
- went belly up
|
||||||
|
- wet behind the ears
|
||||||
|
- what goes around comes around
|
||||||
|
- what you see is what you get
|
||||||
|
- when it rains, it pours
|
||||||
|
- when push comes to shove
|
||||||
|
- when the cat's away
|
||||||
|
- when the going gets tough, the tough get going
|
||||||
|
- white as a sheet
|
||||||
|
- whole ball of wax
|
||||||
|
- whole hog
|
||||||
|
- whole nine yards
|
||||||
|
- wild goose chase
|
||||||
|
- will wonders never cease?
|
||||||
|
- wisdom of the ages
|
||||||
|
- wise as an owl
|
||||||
|
- wolf at the door
|
||||||
|
- words fail me
|
||||||
|
- work like a dog
|
||||||
|
- world weary
|
||||||
|
- worst nightmare
|
||||||
|
- worth its weight in gold
|
||||||
|
- wrong side of the bed
|
||||||
|
- yanking your chain
|
||||||
|
- yappy as a dog
|
||||||
|
- years young
|
||||||
|
- you are what you eat
|
||||||
|
- you can run but you can't hide
|
||||||
|
- you only live once
|
||||||
|
- you're the boss
|
||||||
|
- young and foolish
|
||||||
|
- young and vibrant
|
||||||
@@ -0,0 +1,32 @@
|
|||||||
|
extends: existence
|
||||||
|
message: "Try to avoid using '%s'."
|
||||||
|
ignorecase: true
|
||||||
|
level: suggestion
|
||||||
|
tokens:
|
||||||
|
- am
|
||||||
|
- are
|
||||||
|
- aren't
|
||||||
|
- be
|
||||||
|
- been
|
||||||
|
- being
|
||||||
|
- he's
|
||||||
|
- here's
|
||||||
|
- here's
|
||||||
|
- how's
|
||||||
|
- i'm
|
||||||
|
- is
|
||||||
|
- isn't
|
||||||
|
- it's
|
||||||
|
- she's
|
||||||
|
- that's
|
||||||
|
- there's
|
||||||
|
- they're
|
||||||
|
- was
|
||||||
|
- wasn't
|
||||||
|
- we're
|
||||||
|
- were
|
||||||
|
- weren't
|
||||||
|
- what's
|
||||||
|
- where's
|
||||||
|
- who's
|
||||||
|
- you're
|
||||||
@@ -0,0 +1,11 @@
|
|||||||
|
extends: repetition
|
||||||
|
message: "'%s' is repeated!"
|
||||||
|
level: warning
|
||||||
|
alpha: true
|
||||||
|
action:
|
||||||
|
name: edit
|
||||||
|
params:
|
||||||
|
- truncate
|
||||||
|
- " "
|
||||||
|
tokens:
|
||||||
|
- '[^\s]+'
|
||||||
@@ -0,0 +1,183 @@
|
|||||||
|
extends: existence
|
||||||
|
message: "'%s' may be passive voice. Use active voice if you can."
|
||||||
|
ignorecase: true
|
||||||
|
level: warning
|
||||||
|
raw:
|
||||||
|
- \b(am|are|were|being|is|been|was|be)\b\s*
|
||||||
|
tokens:
|
||||||
|
- '[\w]+ed'
|
||||||
|
- awoken
|
||||||
|
- beat
|
||||||
|
- become
|
||||||
|
- been
|
||||||
|
- begun
|
||||||
|
- bent
|
||||||
|
- beset
|
||||||
|
- bet
|
||||||
|
- bid
|
||||||
|
- bidden
|
||||||
|
- bitten
|
||||||
|
- bled
|
||||||
|
- blown
|
||||||
|
- born
|
||||||
|
- bought
|
||||||
|
- bound
|
||||||
|
- bred
|
||||||
|
- broadcast
|
||||||
|
- broken
|
||||||
|
- brought
|
||||||
|
- built
|
||||||
|
- burnt
|
||||||
|
- burst
|
||||||
|
- cast
|
||||||
|
- caught
|
||||||
|
- chosen
|
||||||
|
- clung
|
||||||
|
- come
|
||||||
|
- cost
|
||||||
|
- crept
|
||||||
|
- cut
|
||||||
|
- dealt
|
||||||
|
- dived
|
||||||
|
- done
|
||||||
|
- drawn
|
||||||
|
- dreamt
|
||||||
|
- driven
|
||||||
|
- drunk
|
||||||
|
- dug
|
||||||
|
- eaten
|
||||||
|
- fallen
|
||||||
|
- fed
|
||||||
|
- felt
|
||||||
|
- fit
|
||||||
|
- fled
|
||||||
|
- flown
|
||||||
|
- flung
|
||||||
|
- forbidden
|
||||||
|
- foregone
|
||||||
|
- forgiven
|
||||||
|
- forgotten
|
||||||
|
- forsaken
|
||||||
|
- fought
|
||||||
|
- found
|
||||||
|
- frozen
|
||||||
|
- given
|
||||||
|
- gone
|
||||||
|
- gotten
|
||||||
|
- ground
|
||||||
|
- grown
|
||||||
|
- heard
|
||||||
|
- held
|
||||||
|
- hidden
|
||||||
|
- hit
|
||||||
|
- hung
|
||||||
|
- hurt
|
||||||
|
- kept
|
||||||
|
- knelt
|
||||||
|
- knit
|
||||||
|
- known
|
||||||
|
- laid
|
||||||
|
- lain
|
||||||
|
- leapt
|
||||||
|
- learnt
|
||||||
|
- led
|
||||||
|
- left
|
||||||
|
- lent
|
||||||
|
- let
|
||||||
|
- lighted
|
||||||
|
- lost
|
||||||
|
- made
|
||||||
|
- meant
|
||||||
|
- met
|
||||||
|
- misspelt
|
||||||
|
- mistaken
|
||||||
|
- mown
|
||||||
|
- overcome
|
||||||
|
- overdone
|
||||||
|
- overtaken
|
||||||
|
- overthrown
|
||||||
|
- paid
|
||||||
|
- pled
|
||||||
|
- proven
|
||||||
|
- put
|
||||||
|
- quit
|
||||||
|
- read
|
||||||
|
- rid
|
||||||
|
- ridden
|
||||||
|
- risen
|
||||||
|
- run
|
||||||
|
- rung
|
||||||
|
- said
|
||||||
|
- sat
|
||||||
|
- sawn
|
||||||
|
- seen
|
||||||
|
- sent
|
||||||
|
- set
|
||||||
|
- sewn
|
||||||
|
- shaken
|
||||||
|
- shaven
|
||||||
|
- shed
|
||||||
|
- shod
|
||||||
|
- shone
|
||||||
|
- shorn
|
||||||
|
- shot
|
||||||
|
- shown
|
||||||
|
- shrunk
|
||||||
|
- shut
|
||||||
|
- slain
|
||||||
|
- slept
|
||||||
|
- slid
|
||||||
|
- slit
|
||||||
|
- slung
|
||||||
|
- smitten
|
||||||
|
- sold
|
||||||
|
- sought
|
||||||
|
- sown
|
||||||
|
- sped
|
||||||
|
- spent
|
||||||
|
- spilt
|
||||||
|
- spit
|
||||||
|
- split
|
||||||
|
- spoken
|
||||||
|
- spread
|
||||||
|
- sprung
|
||||||
|
- spun
|
||||||
|
- stolen
|
||||||
|
- stood
|
||||||
|
- stridden
|
||||||
|
- striven
|
||||||
|
- struck
|
||||||
|
- strung
|
||||||
|
- stuck
|
||||||
|
- stung
|
||||||
|
- stunk
|
||||||
|
- sung
|
||||||
|
- sunk
|
||||||
|
- swept
|
||||||
|
- swollen
|
||||||
|
- sworn
|
||||||
|
- swum
|
||||||
|
- swung
|
||||||
|
- taken
|
||||||
|
- taught
|
||||||
|
- thought
|
||||||
|
- thrived
|
||||||
|
- thrown
|
||||||
|
- thrust
|
||||||
|
- told
|
||||||
|
- torn
|
||||||
|
- trodden
|
||||||
|
- understood
|
||||||
|
- upheld
|
||||||
|
- upset
|
||||||
|
- wed
|
||||||
|
- wept
|
||||||
|
- withheld
|
||||||
|
- withstood
|
||||||
|
- woken
|
||||||
|
- won
|
||||||
|
- worn
|
||||||
|
- wound
|
||||||
|
- woven
|
||||||
|
- written
|
||||||
|
- wrung
|
||||||
@@ -0,0 +1,27 @@
|
|||||||
|
Based on [write-good](https://github.com/btford/write-good).
|
||||||
|
|
||||||
|
> Naive linter for English prose for developers who can't write good and wanna learn to do other stuff good too.
|
||||||
|
|
||||||
|
```
|
||||||
|
The MIT License (MIT)
|
||||||
|
|
||||||
|
Copyright (c) 2014 Brian Ford
|
||||||
|
|
||||||
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
|
of this software and associated documentation files (the "Software"), to deal
|
||||||
|
in the Software without restriction, including without limitation the rights
|
||||||
|
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||||
|
copies of the Software, and to permit persons to whom the Software is
|
||||||
|
furnished to do so, subject to the following conditions:
|
||||||
|
|
||||||
|
The above copyright notice and this permission notice shall be included in all
|
||||||
|
copies or substantial portions of the Software.
|
||||||
|
|
||||||
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||||
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||||
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||||
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||||
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||||
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||||
|
SOFTWARE.
|
||||||
|
```
|
||||||
@@ -0,0 +1,5 @@
|
|||||||
|
extends: existence
|
||||||
|
message: "Don't start a sentence with '%s'."
|
||||||
|
level: error
|
||||||
|
raw:
|
||||||
|
- '(?:[;-]\s)so[\s,]|\bSo[\s,]'
|
||||||
@@ -0,0 +1,6 @@
|
|||||||
|
extends: existence
|
||||||
|
message: "Don't start a sentence with '%s'."
|
||||||
|
ignorecase: false
|
||||||
|
level: error
|
||||||
|
raw:
|
||||||
|
- '(?:[;-]\s)There\s(is|are)|\bThere\s(is|are)\b'
|
||||||
@@ -0,0 +1,221 @@
|
|||||||
|
extends: existence
|
||||||
|
message: "'%s' is too wordy."
|
||||||
|
ignorecase: true
|
||||||
|
level: warning
|
||||||
|
tokens:
|
||||||
|
- a number of
|
||||||
|
- abundance
|
||||||
|
- accede to
|
||||||
|
- accelerate
|
||||||
|
- accentuate
|
||||||
|
- accompany
|
||||||
|
- accomplish
|
||||||
|
- accorded
|
||||||
|
- accrue
|
||||||
|
- acquiesce
|
||||||
|
- acquire
|
||||||
|
- additional
|
||||||
|
- adjacent to
|
||||||
|
- adjustment
|
||||||
|
- admissible
|
||||||
|
- advantageous
|
||||||
|
- adversely impact
|
||||||
|
- advise
|
||||||
|
- aforementioned
|
||||||
|
- aggregate
|
||||||
|
- aircraft
|
||||||
|
- all of
|
||||||
|
- all things considered
|
||||||
|
- alleviate
|
||||||
|
- allocate
|
||||||
|
- along the lines of
|
||||||
|
- already existing
|
||||||
|
- alternatively
|
||||||
|
- amazing
|
||||||
|
- ameliorate
|
||||||
|
- anticipate
|
||||||
|
- apparent
|
||||||
|
- appreciable
|
||||||
|
- as a matter of fact
|
||||||
|
- as a means of
|
||||||
|
- as far as I'm concerned
|
||||||
|
- as of yet
|
||||||
|
- as to
|
||||||
|
- as yet
|
||||||
|
- ascertain
|
||||||
|
- assistance
|
||||||
|
- at the present time
|
||||||
|
- at this time
|
||||||
|
- attain
|
||||||
|
- attributable to
|
||||||
|
- authorize
|
||||||
|
- because of the fact that
|
||||||
|
- belated
|
||||||
|
- benefit from
|
||||||
|
- bestow
|
||||||
|
- by means of
|
||||||
|
- by virtue of
|
||||||
|
- by virtue of the fact that
|
||||||
|
- cease
|
||||||
|
- close proximity
|
||||||
|
- commence
|
||||||
|
- comply with
|
||||||
|
- concerning
|
||||||
|
- consequently
|
||||||
|
- consolidate
|
||||||
|
- constitutes
|
||||||
|
- demonstrate
|
||||||
|
- depart
|
||||||
|
- designate
|
||||||
|
- discontinue
|
||||||
|
- due to the fact that
|
||||||
|
- each and every
|
||||||
|
- economical
|
||||||
|
- eliminate
|
||||||
|
- elucidate
|
||||||
|
- employ
|
||||||
|
- endeavor
|
||||||
|
- enumerate
|
||||||
|
- equitable
|
||||||
|
- equivalent
|
||||||
|
- evaluate
|
||||||
|
- evidenced
|
||||||
|
- exclusively
|
||||||
|
- expedite
|
||||||
|
- expend
|
||||||
|
- expiration
|
||||||
|
- facilitate
|
||||||
|
- factual evidence
|
||||||
|
- feasible
|
||||||
|
- finalize
|
||||||
|
- first and foremost
|
||||||
|
- for all intents and purposes
|
||||||
|
- for the most part
|
||||||
|
- for the purpose of
|
||||||
|
- forfeit
|
||||||
|
- formulate
|
||||||
|
- have a tendency to
|
||||||
|
- honest truth
|
||||||
|
- however
|
||||||
|
- if and when
|
||||||
|
- impacted
|
||||||
|
- implement
|
||||||
|
- in a manner of speaking
|
||||||
|
- in a timely manner
|
||||||
|
- in a very real sense
|
||||||
|
- in accordance with
|
||||||
|
- in addition
|
||||||
|
- in all likelihood
|
||||||
|
- in an effort to
|
||||||
|
- in between
|
||||||
|
- in excess of
|
||||||
|
- in lieu of
|
||||||
|
- in light of the fact that
|
||||||
|
- in many cases
|
||||||
|
- in my opinion
|
||||||
|
- in order to
|
||||||
|
- in regard to
|
||||||
|
- in some instances
|
||||||
|
- in terms of
|
||||||
|
- in the case of
|
||||||
|
- in the event that
|
||||||
|
- in the final analysis
|
||||||
|
- in the nature of
|
||||||
|
- in the near future
|
||||||
|
- in the process of
|
||||||
|
- inception
|
||||||
|
- incumbent upon
|
||||||
|
- indicate
|
||||||
|
- indication
|
||||||
|
- initiate
|
||||||
|
- irregardless
|
||||||
|
- is applicable to
|
||||||
|
- is authorized to
|
||||||
|
- is responsible for
|
||||||
|
- it is
|
||||||
|
- it is essential
|
||||||
|
- it seems that
|
||||||
|
- it was
|
||||||
|
- magnitude
|
||||||
|
- maximum
|
||||||
|
- methodology
|
||||||
|
- minimize
|
||||||
|
- minimum
|
||||||
|
- modify
|
||||||
|
- monitor
|
||||||
|
- multiple
|
||||||
|
- necessitate
|
||||||
|
- nevertheless
|
||||||
|
- not certain
|
||||||
|
- not many
|
||||||
|
- not often
|
||||||
|
- not unless
|
||||||
|
- not unlike
|
||||||
|
- notwithstanding
|
||||||
|
- null and void
|
||||||
|
- numerous
|
||||||
|
- objective
|
||||||
|
- obligate
|
||||||
|
- obtain
|
||||||
|
- on the contrary
|
||||||
|
- on the other hand
|
||||||
|
- one particular
|
||||||
|
- optimum
|
||||||
|
- overall
|
||||||
|
- owing to the fact that
|
||||||
|
- participate
|
||||||
|
- particulars
|
||||||
|
- pass away
|
||||||
|
- pertaining to
|
||||||
|
- point in time
|
||||||
|
- portion
|
||||||
|
- possess
|
||||||
|
- preclude
|
||||||
|
- previously
|
||||||
|
- prior to
|
||||||
|
- prioritize
|
||||||
|
- procure
|
||||||
|
- proficiency
|
||||||
|
- provided that
|
||||||
|
- purchase
|
||||||
|
- put simply
|
||||||
|
- readily apparent
|
||||||
|
- refer back
|
||||||
|
- regarding
|
||||||
|
- relocate
|
||||||
|
- remainder
|
||||||
|
- remuneration
|
||||||
|
- requirement
|
||||||
|
- reside
|
||||||
|
- residence
|
||||||
|
- retain
|
||||||
|
- satisfy
|
||||||
|
- shall
|
||||||
|
- should you wish
|
||||||
|
- similar to
|
||||||
|
- solicit
|
||||||
|
- span across
|
||||||
|
- strategize
|
||||||
|
- subsequent
|
||||||
|
- substantial
|
||||||
|
- successfully complete
|
||||||
|
- sufficient
|
||||||
|
- terminate
|
||||||
|
- the month of
|
||||||
|
- the point I am trying to make
|
||||||
|
- therefore
|
||||||
|
- time period
|
||||||
|
- took advantage of
|
||||||
|
- transmit
|
||||||
|
- transpire
|
||||||
|
- type of
|
||||||
|
- until such time as
|
||||||
|
- utilization
|
||||||
|
- utilize
|
||||||
|
- validate
|
||||||
|
- various different
|
||||||
|
- what I mean to say is
|
||||||
|
- whether or not
|
||||||
|
- with respect to
|
||||||
|
- with the exception of
|
||||||
|
- witnessed
|
||||||
@@ -0,0 +1,29 @@
|
|||||||
|
extends: existence
|
||||||
|
message: "'%s' is a weasel word!"
|
||||||
|
ignorecase: true
|
||||||
|
level: warning
|
||||||
|
tokens:
|
||||||
|
- clearly
|
||||||
|
- completely
|
||||||
|
- exceedingly
|
||||||
|
- excellent
|
||||||
|
- extremely
|
||||||
|
- fairly
|
||||||
|
- huge
|
||||||
|
- interestingly
|
||||||
|
- is a number
|
||||||
|
- largely
|
||||||
|
- mostly
|
||||||
|
- obviously
|
||||||
|
- quite
|
||||||
|
- relatively
|
||||||
|
- remarkably
|
||||||
|
- several
|
||||||
|
- significantly
|
||||||
|
- substantially
|
||||||
|
- surprisingly
|
||||||
|
- tiny
|
||||||
|
- usually
|
||||||
|
- various
|
||||||
|
- vast
|
||||||
|
- very
|
||||||
@@ -0,0 +1,4 @@
|
|||||||
|
{
|
||||||
|
"feed": "https://github.com/errata-ai/write-good/releases.atom",
|
||||||
|
"vale_version": ">=1.0.0"
|
||||||
|
}
|
||||||
@@ -1,22 +1,38 @@
|
|||||||
# AGENTS.md — Project Conventions for devx
|
# AGENTS.md — Project Conventions for devx
|
||||||
|
|
||||||
|
## Virtual Environment
|
||||||
|
|
||||||
|
All Python tools, tests, and scripts run inside a standard `.venv` directory.
|
||||||
|
Activate it before running any non-`make` command:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
source activate.sh # bash/zsh
|
||||||
|
source activate.fish # fish
|
||||||
|
source activate.zsh # zsh
|
||||||
|
```
|
||||||
|
|
||||||
|
If `.venv` doesn't exist, run `make setup` first. The `make` targets handle
|
||||||
|
venv activation automatically — always prefer `make <target>` over raw commands.
|
||||||
|
|
||||||
## Build & Test Commands
|
## Build & Test Commands
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
make setup # Create venv, install deps, set up hooks, install CI tools
|
make setup # Create venv, install deps, set up hooks, install CI tools
|
||||||
make install-tools # Install actionlint, git-cliff, act_runner, tea, hadolint to ~/.local/bin
|
make install-tools # Install actionlint, git-cliff, act_runner, tea, hadolint, vale to ~/.local/bin
|
||||||
make lint-all # ruff + pyright + bandit + actionlint + lint-dockerfiles
|
make lint-all # ruff + pyright + bandit + actionlint + lint-dockerfiles
|
||||||
make pytest-cov # Unit tests with 100% coverage enforcement
|
make pytest-cov # Unit tests with 100% coverage enforcement
|
||||||
make test-unit # Unit tests without coverage
|
make test-unit # Unit tests without coverage
|
||||||
make workflow-lint # Static lint of .gitea/workflows/*.yml (actionlint)
|
make workflow-lint # Static lint of .gitea/workflows/*.yml (actionlint)
|
||||||
make workflow-dryrun # Dry-run all workflows in Docker (act_runner exec --dryrun)
|
make workflow-dryrun # Dry-run all workflows in Docker (act_runner exec --dryrun)
|
||||||
make workflow-check # workflow-lint + workflow-dryrun
|
make workflow-check # workflow-lint + workflow-dryrun
|
||||||
|
make devx-check-doc-versions # Verify docs version refs match __version__
|
||||||
|
make devx-vale # Run Vale prose linter on docs and README
|
||||||
make clean # Remove caches, build artifacts, coverage data
|
make clean # Remove caches, build artifacts, coverage data
|
||||||
```
|
```
|
||||||
|
|
||||||
`make setup` automatically installs all development tools:
|
`make setup` automatically installs all development tools:
|
||||||
- **Python deps** via `python -m devx.tools.setup` (pip install -e .[dev], pre-commit hooks)
|
- **Python deps** via `python -m devx.tools.setup` (pip install -e .[dev], pre-commit hooks)
|
||||||
- **actionlint, git-cliff, act_runner, tea, hadolint** via `python -m devx.tools.install_tools` (CI/CD tools to ~/.local/bin)
|
- **actionlint, git-cliff, act_runner, tea, hadolint, vale** via `python -m devx.tools.install_tools` (CI/CD tools to ~/.local/bin)
|
||||||
- **tea CLI login** via `python -m devx.tools.setup` (configures `tea login` from `.env` `CI_GITEA_TOKEN`)
|
- **tea CLI login** via `python -m devx.tools.setup` (configures `tea login` from `.env` `CI_GITEA_TOKEN`)
|
||||||
|
|
||||||
## Workflow Verification (Before Push)
|
## Workflow Verification (Before Push)
|
||||||
@@ -34,7 +50,7 @@ Workflow YAML files (`.gitea/workflows/*.yml`) are verified with two tools:
|
|||||||
|
|
||||||
Both run via `make workflow-check` and are part of `make lint-all`.
|
Both run via `make workflow-check` and are part of `make lint-all`.
|
||||||
The pre-commit hook runs actionlint automatically when workflow files change.
|
The pre-commit hook runs actionlint automatically when workflow files change.
|
||||||
The CI `quality` job runs `make setup-quality` then `make lint-all`.
|
The CI `validate` job runs `make setup-image` then `make lint-all`.
|
||||||
CI also runs a best-effort `make workflow-dryrun` step (skipped if act_runner is not installed in the CI Docker image).
|
CI also runs a best-effort `make workflow-dryrun` step (skipped if act_runner is not installed in the CI Docker image).
|
||||||
|
|
||||||
## Architecture
|
## Architecture
|
||||||
@@ -43,7 +59,7 @@ devx is a reusable Python package providing development and CI/CD tools for obla
|
|||||||
|
|
||||||
### Package Structure
|
### Package Structure
|
||||||
|
|
||||||
```
|
```text
|
||||||
src/devx/
|
src/devx/
|
||||||
├── __init__.py # Version (single source of truth, read by setuptools)
|
├── __init__.py # Version (single source of truth, read by setuptools)
|
||||||
├── cli.py # Click-based CLI entry point (devx command)
|
├── cli.py # Click-based CLI entry point (devx command)
|
||||||
@@ -52,14 +68,14 @@ src/devx/
|
|||||||
├── gitea_cli.py # TeaCLI — wrapper around tea CLI with JSON parsing
|
├── gitea_cli.py # TeaCLI — wrapper around tea CLI with JSON parsing
|
||||||
├── i18n.py # Translation system (gettext-based, translations.json)
|
├── i18n.py # Translation system (gettext-based, translations.json)
|
||||||
├── exceptions.py # Custom exception types
|
├── exceptions.py # Custom exception types
|
||||||
├── translations.json # Translation strings (en, bg)
|
├── translations.json # Translation strings (en, bg, de, pl, ru, zh)
|
||||||
├── ci/ # CI/CD automation modules (run by workflows)
|
├── ci/ # CI/CD automation modules (run by workflows)
|
||||||
│ ├── release.py # Automated versioning, tagging, changelog
|
│ ├── release.py # Automated versioning, tagging, changelog
|
||||||
│ ├── publish.py # Build and publish to Gitea PyPI registry (--skip-build for non-Python repos)
|
│ ├── publish.py # Build and publish to Gitea PyPI registry (--skip-build for non-Python repos)
|
||||||
│ ├── auto_merge.py # Squash-merge PRs with task ID validation
|
│ ├── auto_merge.py # Squash-merge PRs with task ID validation
|
||||||
│ ├── check_auto_merge_ready.py # Pre-merge validation gate (branch, PR title, Vikunja, behind-master)
|
│ ├── check_auto_merge_ready.py # Pre-merge validation gate (branch, PR title, Vikunja, behind-master)
|
||||||
│ ├── _shared.py # Shared utilities (get_latest_tag)
|
│ ├── _shared.py # Shared utilities (get_latest_tag)
|
||||||
│ ├── classify_changes.py # User-facing vs workflow-only change detection
|
│ ├── classify_changes.py # User-facing vs infrastructure change detection
|
||||||
│ ├── detect_release_commit.py # Detect release commits on master
|
│ ├── detect_release_commit.py # Detect release commits on master
|
||||||
│ ├── validate_commit_msg.py # Conventional commit validation
|
│ ├── validate_commit_msg.py # Conventional commit validation
|
||||||
│ ├── pr_review.py # Automated PR review + manual reviews (--event, --body, --checklist-confirmed)
|
│ ├── pr_review.py # Automated PR review + manual reviews (--event, --body, --checklist-confirmed)
|
||||||
@@ -72,11 +88,14 @@ src/devx/
|
|||||||
│ ├── integration_guard.py # Run pytest with cross-runner fail-fast
|
│ ├── integration_guard.py # Run pytest with cross-runner fail-fast
|
||||||
│ ├── check_translations.py # Translation completeness check
|
│ ├── check_translations.py # Translation completeness check
|
||||||
│ ├── doc_coverage.py # Documentation coverage check
|
│ ├── doc_coverage.py # Documentation coverage check
|
||||||
│ └── lint_docs.py # Documentation linter (structure, links, headings)
|
│ ├── lint_docs.py # Documentation linter (structure, links, headings, code blocks, orphans)
|
||||||
|
│ ├── validate_deploy_ref.py # Validate git tag for deployments (--github-output)
|
||||||
|
│ └── record_deployed_tag.py # Record deployed tag to Gitea repo variable
|
||||||
├── tools/ # Developer tooling modules (run locally or by CI)
|
├── tools/ # Developer tooling modules (run locally or by CI)
|
||||||
│ ├── setup.py # Environment setup (venv, deps, hooks)
|
│ ├── setup.py # Environment setup (venv, deps, hooks)
|
||||||
│ ├── install_tools.py # Install actionlint, git-cliff, act_runner, tea, hadolint
|
│ ├── install_tools.py # Install actionlint, git-cliff, act_runner, tea, hadolint, vale
|
||||||
│ ├── install_checkmake.py # Install checkmake (Makefile linter)
|
│ ├── install_checkmake.py # Install checkmake (Makefile linter)
|
||||||
|
│ ├── check_doc_versions.py # Verify docs version refs match __version__
|
||||||
│ ├── build_image.py # Build and push Docker images to Gitea registry
|
│ ├── build_image.py # Build and push Docker images to Gitea registry
|
||||||
│ ├── clean_images.py # Clean up old Docker image versions from Gitea registry
|
│ ├── clean_images.py # Clean up old Docker image versions from Gitea registry
|
||||||
│ ├── check_test_speed.py # Measure unit test execution time
|
│ ├── check_test_speed.py # Measure unit test execution time
|
||||||
@@ -84,19 +103,34 @@ src/devx/
|
|||||||
│ ├── check_pyproject_deps.py # Validate pyproject.toml deps have documentation comments
|
│ ├── check_pyproject_deps.py # Validate pyproject.toml deps have documentation comments
|
||||||
│ ├── check_test_coverage.py # Ensure changed files have corresponding tests (configurable rules)
|
│ ├── check_test_coverage.py # Ensure changed files have corresponding tests (configurable rules)
|
||||||
│ ├── check_agent_docs.py # Validate docs for stale file references (configurable patterns)
|
│ ├── check_agent_docs.py # Validate docs for stale file references (configurable patterns)
|
||||||
|
│ ├── check_config.py # Validate pyproject.toml [tool.devx] config
|
||||||
│ ├── configure_repo.py # Branch protection and label setup
|
│ ├── configure_repo.py # Branch protection and label setup
|
||||||
│ ├── generate_badges.py # Badge SVG generation
|
│ ├── generate_badges.py # Badge SVG generation
|
||||||
|
│ ├── generate_cliff_config.py # Generate git-cliff config (cliff.toml)
|
||||||
│ ├── create_task.py # Create Vikunja tasks
|
│ ├── create_task.py # Create Vikunja tasks
|
||||||
│ ├── create_pr.py # Create PRs with auto-derived title from Vikunja
|
│ ├── create_pr.py # Create PRs with auto-derived title from Vikunja
|
||||||
│ ├── pr_status.py # Check CI status for a PR/commit (--wait polls)
|
│ ├── pr_status.py # Check CI status for a PR/commit (--wait polls)
|
||||||
│ ├── pr_logs.py # Fetch logs for failed CI jobs
|
│ ├── pr_logs.py # Fetch logs for failed CI jobs
|
||||||
│ └── pr_label.py # Add labels to PRs (idempotent)
|
│ ├── pr_label.py # Add labels to PRs (idempotent)
|
||||||
|
│ ├── pre_push_check.py # Validate Vikunja task existence before push
|
||||||
|
│ └── _shared.py # Shared tool utilities
|
||||||
├── opentofu.py # OpenTofu output helpers (get_tofu_output, get_tofu_vm_ip, get_tofu_vm_field)
|
├── opentofu.py # OpenTofu output helpers (get_tofu_output, get_tofu_vm_ip, get_tofu_vm_field)
|
||||||
|
├── utils/ # Shared utilities (reusable across projects)
|
||||||
|
│ ├── api.py # API response helpers (is_truthy, is_falsy)
|
||||||
|
│ ├── ssh.py # SSH exec + wait_for_ssh (pure-Python socket check)
|
||||||
|
│ ├── crypto.py # Secret generation (shell-safe passwords)
|
||||||
|
│ ├── vault.py # Ansible vault encrypt/decrypt helpers
|
||||||
|
│ ├── network.py # HTTP connectivity check + wait_for_ssh
|
||||||
|
│ ├── confirm.py # Typed confirmation validation for destructive ops
|
||||||
|
│ ├── json_registry.py # File-locked JSON registry for local state
|
||||||
|
│ ├── step_tracker.py # Multi-step operation tracking with reports
|
||||||
|
│ └── logging.py # XDG-compliant logging configuration
|
||||||
└── molecule/ # Optional molecule testing helpers (for Ansible projects)
|
└── molecule/ # Optional molecule testing helpers (for Ansible projects)
|
||||||
├── discover_runners.py # Dynamic Gitea runner discovery
|
├── discover_runners.py # Dynamic Gitea runner discovery
|
||||||
├── distribute_molecule.py # Distribute molecule scenarios across runners (LPT scheduling, --roles-root for multi-role)
|
├── distribute_molecule.py # Distribute molecule scenarios across runners (LPT scheduling, --roles-root for multi-role)
|
||||||
├── molecule_ci_guard.py # Run molecule with cross-runner fail-fast (--roles-root)
|
├── molecule_ci_guard.py # Run molecule with cross-runner fail-fast (--roles-root)
|
||||||
├── molecule_all.py # Run all molecule scenarios locally
|
├── molecule_all.py # Run all molecule scenarios locally
|
||||||
|
├── start_docker.py # Ensure Docker daemon is running for molecule tests
|
||||||
└── platforms.py # Supported molecule platforms
|
└── platforms.py # Supported molecule platforms
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -114,18 +148,24 @@ Every change to master goes through this workflow. No exceptions.
|
|||||||
### Branch Protection (Required Gitea Settings)
|
### Branch Protection (Required Gitea Settings)
|
||||||
|
|
||||||
Branch protection and labels are automatically configured by
|
Branch protection and labels are automatically configured by
|
||||||
`python -m devx.tools.configure_repo`, which runs as a `configure-repo` job in
|
`python -m devx.tools.configure_repo`, which runs as a step in the
|
||||||
the post-merge workflow on every push to master.
|
`detect-and-configure` job in the post-merge workflow on every push to master.
|
||||||
|
|
||||||
The following rules are enforced for `master`:
|
The following rules are enforced for `master`:
|
||||||
- **Require pull request**: No direct pushes to master
|
- **Require pull request**: No direct pushes to master
|
||||||
- **Require approval review**: At least 1 `APPROVE` review before merge
|
- **Require approval review**: At least 1 `APPROVE` review before merge
|
||||||
- **Require status checks**: CI quality must pass
|
- **Require status checks**: CI validate must pass
|
||||||
- **Block force pushes**: No history rewriting on master
|
- **Block force pushes**: No history rewriting on master
|
||||||
|
|
||||||
### 1. Create Vikunja Task
|
### 1. Create Vikunja Task
|
||||||
Create a task in Vikunja to get a `DEVX-N` identifier.
|
Create a task in Vikunja to get a `DEVX-N` identifier.
|
||||||
|
|
||||||
|
**IMPORTANT:** The task title must NOT include the `DEVX-N:` prefix.
|
||||||
|
The `make create-pr` and `check_auto_merge_ready` commands automatically
|
||||||
|
prepend `DEVX-N: ` to the Vikunja task title when forming the PR title.
|
||||||
|
If the Vikunja task title already includes the prefix, the PR title will
|
||||||
|
have a double prefix and auto-merge validation will fail.
|
||||||
|
|
||||||
### 2. Create Branch
|
### 2. Create Branch
|
||||||
```bash
|
```bash
|
||||||
git checkout master && git pull
|
git checkout master && git pull
|
||||||
@@ -139,7 +179,7 @@ git checkout -b DEVX-N-short-description
|
|||||||
|
|
||||||
### 4. Commit (Conventional Commits)
|
### 4. Commit (Conventional Commits)
|
||||||
Branch commits use conventional commit format (no `DEVX-N:` prefix):
|
Branch commits use conventional commit format (no `DEVX-N:` prefix):
|
||||||
```
|
```text
|
||||||
feat: add new feature
|
feat: add new feature
|
||||||
fix: resolve bug
|
fix: resolve bug
|
||||||
docs: update README
|
docs: update README
|
||||||
@@ -152,8 +192,9 @@ docs: update README
|
|||||||
|
|
||||||
### 6. Review the PR
|
### 6. Review the PR
|
||||||
|
|
||||||
**Automated review (CI `pr-review` job):** Every PR triggers an automated
|
**Automated review (CI `validate` job):** Every PR triggers an automated
|
||||||
review via `python -m devx.ci.pr_review`. This job posts a review with
|
review via `python -m devx.ci.pr_review` as a step in the `validate` job.
|
||||||
|
This posts a review with
|
||||||
`COMMENT` (no issues) or `REQUEST_CHANGES` (issues found):
|
`COMMENT` (no issues) or `REQUEST_CHANGES` (issues found):
|
||||||
|
|
||||||
- Architecture compliance (no subprocess in CLI, no hardcoded URLs)
|
- Architecture compliance (no subprocess in CLI, no hardcoded URLs)
|
||||||
@@ -176,7 +217,7 @@ Once all checklist items are verified and comments are addressed, approve
|
|||||||
the PR. Then add the `ready-to-merge` label. The auto-merge workflow will:
|
the PR. Then add the `ready-to-merge` label. The auto-merge workflow will:
|
||||||
1. **Validate** PR title format (`DEVX-N: <vikunja task title>`) and match against Vikunja task title
|
1. **Validate** PR title format (`DEVX-N: <vikunja task title>`) and match against Vikunja task title
|
||||||
2. **Check** that at least one substantive APPROVE review exists
|
2. **Check** that at least one substantive APPROVE review exists
|
||||||
3. Wait for all CI checks to pass (including the `pr-review` job)
|
3. Wait for all CI checks to pass (including the `validate` job)
|
||||||
4. Squash-merge with title: `DEVX-N: <conventional commit message>`
|
4. Squash-merge with title: `DEVX-N: <conventional commit message>`
|
||||||
5. The post-merge workflow marks the Vikunja task as done
|
5. The post-merge workflow marks the Vikunja task as done
|
||||||
6. The release workflow automatically versions, tags, and publishes
|
6. The release workflow automatically versions, tags, and publishes
|
||||||
@@ -187,36 +228,27 @@ the PR. Then add the `ready-to-merge` label. The auto-merge workflow will:
|
|||||||
### Automated Release Pipeline
|
### Automated Release Pipeline
|
||||||
|
|
||||||
After a PR is merged to master, the **post-merge workflow**
|
After a PR is merged to master, the **post-merge workflow**
|
||||||
(`.gitea/workflows/post-merge.yml`) runs automatically:
|
(`.gitea/workflows/post-merge.yml`) runs automatically. Consolidated
|
||||||
|
into 2 jobs (from 7) to reduce runner overhead:
|
||||||
|
|
||||||
1. **detect-type** — Checks if the commit is a regular merge or a
|
1. **detect-and-configure** — Configures repo (branch protection, labels),
|
||||||
release commit (`release: vX.Y.Z`). All subsequent jobs skip for
|
detects release commit, validates commit message. Outputs `is-release`
|
||||||
release commits (except badges).
|
and `is-automated` for the next job.
|
||||||
|
|
||||||
2. **release** — Runs `python -m devx.ci.release` which:
|
2. **release-and-maintain** — Runs all post-merge maintenance as
|
||||||
- Checks for user-facing changes via `python -m devx.ci.classify_changes`
|
conditional steps:
|
||||||
- Uses **git-cliff** to calculate the next semver version from conventional commits
|
- **release** (if not a release commit) — Runs `python -m devx.ci.release`
|
||||||
- Updates `__version__` in `src/devx/__init__.py` (single source of truth)
|
which checks for user-facing changes via `classify_changes`, uses
|
||||||
- Updates `CHANGELOG.md` with the new version section
|
git-cliff for semver, updates `__version__`, updates `CHANGELOG.md`,
|
||||||
- Runs `make lint-ruff` and `make pytest-cov` to verify the release is healthy
|
runs lint+tests, commits with `release: vX.Y.Z [skip ci]`, creates
|
||||||
- Commits with `release: vX.Y.Z [skip ci]` prefix
|
annotated tag, pushes to master.
|
||||||
- Creates an annotated tag `vX.Y.Z` on the release commit
|
- **publish** (if release created a tag) — Builds and publishes the
|
||||||
- Pushes both the commit and tag to master
|
package to the Gitea PyPI registry. Checks out the release tag
|
||||||
|
within the same job.
|
||||||
3. **sync-wiki** — Syncs documentation to the Gitea wiki. Runs for ALL
|
- **sync-wiki** (if not automated) — Syncs documentation to the Gitea wiki.
|
||||||
non-release commits (not just when release succeeds), so docs-only
|
- **vikunja** (if not automated) — Marks the corresponding Vikunja task as done.
|
||||||
changes still update the wiki.
|
- **badges** (always) — Generates and pushes quality badge SVGs to the
|
||||||
|
`badges` branch. Fetches latest master first to pick up release commits.
|
||||||
4. **badges** — Generates and pushes quality badge SVGs to the `badges` branch.
|
|
||||||
Uses `if: always()` so it runs on every push, including release commits.
|
|
||||||
|
|
||||||
5. **vikunja** — Marks the corresponding Vikunja task as done. Runs for ALL
|
|
||||||
non-release commits (not just when release succeeds), so infrastructure-only
|
|
||||||
changes still update the task tracker.
|
|
||||||
|
|
||||||
6. **publish** — Runs after release succeeds (needs: release). Builds and
|
|
||||||
publishes the package to the Gitea PyPI registry. Gets the tag from the
|
|
||||||
release job's `tag` output (written via `GITHUB_OUTPUT`).
|
|
||||||
|
|
||||||
### Smart CI: User-Facing vs Workflow-Only Changes
|
### Smart CI: User-Facing vs Workflow-Only Changes
|
||||||
|
|
||||||
@@ -307,14 +339,14 @@ setuptools via `dynamic = ["version"]` in `pyproject.toml`.
|
|||||||
|
|
||||||
### Task ID Resolution
|
### Task ID Resolution
|
||||||
|
|
||||||
`auto_merge` resolves the task ID solely from the branch name (e.g.
|
`auto_merge` resolves the task ID solely from the branch name (for example
|
||||||
`DEVX-12-fix-foo` → `DEVX-12`). Branch names must include the task ID
|
`DEVX-12-fix-foo` → `DEVX-12`). Branch names must include the task ID
|
||||||
prefix — there is no `.taskid` file fallback. If a stale `.taskid` file
|
prefix — there is no `.taskid` file fallback. If a stale `.taskid` file
|
||||||
exists in the repo, a deprecation warning is printed advising its removal.
|
exists in the repo, a deprecation warning is printed advising its removal.
|
||||||
|
|
||||||
### Workflow `auto-merge` Job and `always()`
|
### Workflow `auto-merge` Job and `always()`
|
||||||
|
|
||||||
When `auto-merge` depends on a job that can be skipped (e.g.
|
When `auto-merge` depends on a job that can be skipped (for example
|
||||||
`molecule-tests`), the `if:` condition MUST include `always() &&`
|
`molecule-tests`), the `if:` condition MUST include `always() &&`
|
||||||
at the start. Without it, Gitea Actions skips `auto-merge` when any
|
at the start. Without it, Gitea Actions skips `auto-merge` when any
|
||||||
dependency is skipped, even if the condition explicitly allows
|
dependency is skipped, even if the condition explicitly allows
|
||||||
@@ -322,12 +354,11 @@ dependency is skipped, even if the condition explicitly allows
|
|||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
auto-merge:
|
auto-merge:
|
||||||
needs: [quality, detect-changes, pr-review, molecule-tests]
|
needs: [validate, molecule-tests]
|
||||||
if: >-
|
if: >-
|
||||||
always() &&
|
always() &&
|
||||||
github.event_name == 'pull_request' &&
|
github.event_name == 'pull_request' &&
|
||||||
needs.quality.result == 'success' &&
|
needs.validate.result == 'success' &&
|
||||||
needs.pr-review.result == 'success' &&
|
|
||||||
(needs.molecule-tests.result == 'success' || needs.molecule-tests.result == 'skipped')
|
(needs.molecule-tests.result == 'success' || needs.molecule-tests.result == 'skipped')
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -346,7 +377,7 @@ balanced distribution when test items have varying costs:
|
|||||||
2. **LPT assignment**: Items are sorted by weight (descending), then
|
2. **LPT assignment**: Items are sorted by weight (descending), then
|
||||||
each is assigned to the runner with the least total weight.
|
each is assigned to the runner with the least total weight.
|
||||||
|
|
||||||
This ensures heavy scenarios (e.g. `nextcloud`) are spread across
|
This ensures heavy scenarios (for example `nextcloud`) are spread across
|
||||||
different runners rather than clustered on one, reducing the
|
different runners rather than clustered on one, reducing the
|
||||||
longest-runner time from ~16 min to ~11 min with 6 runners.
|
longest-runner time from ~16 min to ~11 min with 6 runners.
|
||||||
|
|
||||||
@@ -364,7 +395,7 @@ devx uses environment variables with `.env` file fallback for configuration.
|
|||||||
| `DEVX_REPO_NAME` | **(none — must be set)** | Repository name (or `owner/repo`) |
|
| `DEVX_REPO_NAME` | **(none — must be set)** | Repository name (or `owner/repo`) |
|
||||||
| `DEVX_TASK_PREFIX` | `DEVX` | Task ID prefix (GRM, OBL-INFRA, etc.) |
|
| `DEVX_TASK_PREFIX` | `DEVX` | Task ID prefix (GRM, OBL-INFRA, etc.) |
|
||||||
| `DEVX_VIKUNJA_PROJECT_ID` | `6` | Vikunja project ID |
|
| `DEVX_VIKUNJA_PROJECT_ID` | `6` | Vikunja project ID |
|
||||||
| `DEVX_LANG` | `en` | Language for i18n (en, bg) |
|
| `DEVX_LANG` | `en` | Language for i18n (en, bg, de, pl, ru, zh) |
|
||||||
| `CI_GITEA_TOKEN` | (from .env) | Gitea API token |
|
| `CI_GITEA_TOKEN` | (from .env) | Gitea API token |
|
||||||
| `VIKUNJA_TOKEN` | (from .env) | Vikunja API token |
|
| `VIKUNJA_TOKEN` | (from .env) | Vikunja API token |
|
||||||
|
|
||||||
@@ -376,12 +407,12 @@ system loads `.env` automatically via `python-dotenv`.
|
|||||||
|
|
||||||
### pyproject.toml [tool.devx] Configuration
|
### pyproject.toml [tool.devx] Configuration
|
||||||
|
|
||||||
In addition to `DEVX_` env vars, several devx tools read configuration from
|
In addition to `DEVX_` env vars, many devx tools read configuration from
|
||||||
the `[tool.devx]` section in `pyproject.toml`. This allows per-project
|
the `[tool.devx]` section in `pyproject.toml`. This allows per-project
|
||||||
customization without environment variables.
|
customization without environment variables.
|
||||||
|
|
||||||
**Base config** (`[tool.devx]`):
|
**Base config** (`[tool.devx]`):
|
||||||
- `task_prefix` — Task ID prefix (e.g. `"DEVX"`, `"GRM"`, `"OBL-INFRA"`)
|
- `task_prefix` — Task ID prefix (for example `"DEVX"`, `"GRM"`, `"OBL-INFRA"`)
|
||||||
- `vikunja_project_id` — Vikunja project ID
|
- `vikunja_project_id` — Vikunja project ID
|
||||||
- `repo_owner` / `repo_name` — Gitea repository coordinates
|
- `repo_owner` / `repo_name` — Gitea repository coordinates
|
||||||
- `gitea_api_url` / `vikunja_api_url` — API endpoints
|
- `gitea_api_url` / `vikunja_api_url` — API endpoints
|
||||||
@@ -465,9 +496,9 @@ to eliminate the 40-120s setup tax on every CI job:
|
|||||||
|
|
||||||
| Image | Contains | Used by jobs |
|
| Image | Contains | Used by jobs |
|
||||||
|-------|----------|-------------|
|
|-------|----------|-------------|
|
||||||
| `ci-base-latest` | Python 3.12 + devx[ci] + tea | detect-changes, detect-type, validate-commit-msg, pr-review, auto-merge, sync-wiki, vikunja, configure-repo |
|
| `ci-base-latest` | Python 3.12 + devx[ci] + tea | auto-merge, detect-and-configure |
|
||||||
| `ci-quality-latest` | ci-base + devx[lint] + actionlint + checkmake + hadolint | quality, badges |
|
| `ci-quality-latest` | ci-base + devx[lint] + actionlint + checkmake + hadolint | (badges in release-and-maintain uses ci-full) |
|
||||||
| `ci-full-latest` | ci-quality + devx[release,molecule,deploy] + git-cliff + OpenTofu | release, publish, release-dry-run, molecule-tests, deploy jobs |
|
| `ci-full-latest` | ci-quality + devx[release,molecule,deploy] + git-cliff + OpenTofu | validate, release-and-maintain, molecule-tests, build-and-push |
|
||||||
|
|
||||||
**Build process** (in `build-images.yml` workflow):
|
**Build process** (in `build-images.yml` workflow):
|
||||||
1. `ci-base` builds FROM `gitea/runner-images:ubuntu-latest`
|
1. `ci-base` builds FROM `gitea/runner-images:ubuntu-latest`
|
||||||
@@ -480,9 +511,9 @@ Each image is tagged `latest` and pushed to
|
|||||||
**Using images in workflows**:
|
**Using images in workflows**:
|
||||||
```yaml
|
```yaml
|
||||||
jobs:
|
jobs:
|
||||||
quality:
|
validate:
|
||||||
runs-on: docker
|
runs-on: docker
|
||||||
container: git.oblachno.oblachno.fyi/oblachno-oss/runner-images/ci-quality:latest
|
container: git.oblachno.oblachno.fyi/oblachno-oss/runner-images/ci-full:latest
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v4
|
||||||
- name: Set up environment
|
- name: Set up environment
|
||||||
@@ -516,3 +547,113 @@ create-task: devx-create-task
|
|||||||
- Line length: 120 chars
|
- Line length: 120 chars
|
||||||
- Secrets are passed via environment variables, never on the command line
|
- Secrets are passed via environment variables, never on the command line
|
||||||
- All user-facing strings wrapped in `_()` for i18n
|
- All user-facing strings wrapped in `_()` for i18n
|
||||||
|
|
||||||
|
### Container-Level Fix Verification (Mandatory)
|
||||||
|
|
||||||
|
**Rule:** Before pushing any fix that modifies container state (CA certs,
|
||||||
|
config files, installed packages, daemon restarts), reproduce the exact
|
||||||
|
sequence locally with the actual Docker image. Do not push to CI as the
|
||||||
|
first test.
|
||||||
|
|
||||||
|
This is a hard rule, not a suggestion. CI cycles take 20+ minutes and
|
||||||
|
ephemeral staging VMs are destroyed after each run, making interactive
|
||||||
|
debugging impossible. A local reproduction takes 30 seconds and catches
|
||||||
|
silent failures immediately.
|
||||||
|
|
||||||
|
**Procedure:**
|
||||||
|
1. `docker pull <actual_image>`
|
||||||
|
2. `docker run -d --name <test> ...` and wait for it to start
|
||||||
|
3. Run the exact commands from the Ansible task or script
|
||||||
|
4. Verify the state change took effect
|
||||||
|
5. Clean up: `docker rm -f <test>`
|
||||||
|
|
||||||
|
### Verified State Modification (Mandatory)
|
||||||
|
|
||||||
|
Ansible tasks that modify container state with `changed_when: false`
|
||||||
|
MUST include a post-task verification step that confirms the state
|
||||||
|
change took effect. `changed_when: false` suppresses both change
|
||||||
|
detection AND failure visibility — a task can silently do nothing and
|
||||||
|
report `ok`.
|
||||||
|
|
||||||
|
## Subagent Delegation Policy
|
||||||
|
|
||||||
|
Custom subagent profiles are defined in `.devin/agents/` (project-specific)
|
||||||
|
and `~/.config/devin/agents/` (global, shared across repos). The agent MUST
|
||||||
|
automatically delegate to the appropriate subagent based on the task —
|
||||||
|
the user should not need to specify which profile to use.
|
||||||
|
|
||||||
|
### Available Profiles
|
||||||
|
|
||||||
|
**Global** (shared across all projects):
|
||||||
|
|
||||||
|
| Profile | Location | Purpose |
|
||||||
|
|---------|----------|---------|
|
||||||
|
| `pr-reviewer` | `~/.config/devin/agents/` | 13-category PR checklist + quality gates |
|
||||||
|
| `release-check` | `~/.config/devin/agents/` | Pre-merge readiness validation |
|
||||||
|
|
||||||
|
**devx-specific** (in `.devin/agents/`):
|
||||||
|
|
||||||
|
| Profile | Purpose |
|
||||||
|
|---------|---------|
|
||||||
|
| `ci-investigator` | Investigate CI failures (validate, release-and-maintain, build-images) |
|
||||||
|
| `dep-upgrader` | Python dependency upgrades in pyproject.toml with dep-doc validation |
|
||||||
|
| `docker-image-builder` | Build/push/cleanup 3-tier runner images (ci-base, ci-quality, ci-full) |
|
||||||
|
| `doc-sync-specialist` | Doc coverage, doc linting, wiki sync integrity |
|
||||||
|
| `workflow-validator` | actionlint + act_runner dry-run validation |
|
||||||
|
|
||||||
|
### When to Delegate Automatically
|
||||||
|
|
||||||
|
| Trigger | Profile | Mode |
|
||||||
|
|---------|---------|------|
|
||||||
|
| CI run failure (validate, release-and-maintain, build-images) | `ci-investigator` | Background |
|
||||||
|
| PR ready for review | `pr-reviewer` | Foreground |
|
||||||
|
| Dependency upgrade requested | `dep-upgrader` | Background |
|
||||||
|
| Docker image build/push needed | `docker-image-builder` | Background |
|
||||||
|
| Doc coverage failure or wiki sync issue | `doc-sync-specialist` | Background |
|
||||||
|
| Workflow YAML modified or validation needed | `workflow-validator` | Background |
|
||||||
|
| Branch ready for merge | `release-check` | Foreground |
|
||||||
|
|
||||||
|
### Delegation Rules
|
||||||
|
|
||||||
|
1. **Auto-select the profile.** Do not ask the user which profile to use.
|
||||||
|
2. **Background by default, foreground when blocking.**
|
||||||
|
3. **Provide full context in the prompt** — subagents don't inherit conversation history.
|
||||||
|
4. **One subagent per concern.** Chain: investigate → fix in main session → review.
|
||||||
|
5. **Don't delegate minor work** (<30s, <50 lines of context).
|
||||||
|
6. **Compact after subagent returns.**
|
||||||
|
7. **Never skip delegation to save time** — it keeps main context small.
|
||||||
|
|
||||||
|
|
||||||
|
## Feedback Issue Handling
|
||||||
|
|
||||||
|
Subagents create Gitea issues in the current repo when they encounter
|
||||||
|
tool, workflow, or process issues that warrant follow-up. These issues
|
||||||
|
use the `feedback` label plus a category label (`tooling`,
|
||||||
|
`ci-improvement`, `doc-improvement`, `workflow-improvement`).
|
||||||
|
|
||||||
|
Standard labels are created automatically by `configure_repo` (runs in
|
||||||
|
post-merge on every master push). If a label does not exist yet, the
|
||||||
|
subagent's issue creation will still succeed — labels can be added
|
||||||
|
afterwards.
|
||||||
|
|
||||||
|
### When a Subagent Reports a Feedback Issue URL
|
||||||
|
|
||||||
|
1. **Acknowledge it** in your response to the user — mention the issue URL
|
||||||
|
2. **Do NOT close or modify** the issue — it is for follow-up work
|
||||||
|
3. **Do NOT create a PR** to address it unless the user explicitly asks
|
||||||
|
4. If the user asks to address feedback, spawn a subagent to investigate
|
||||||
|
the issue and implement a fix
|
||||||
|
|
||||||
|
### Creating Feedback Issues Manually
|
||||||
|
|
||||||
|
As the parent agent, you can also create feedback issues directly using
|
||||||
|
the Gitea MCP (`issue_write` with `create_issue` method). Follow the
|
||||||
|
same format as subagents:
|
||||||
|
|
||||||
|
- Title: `[feedback] <category>: <short description>`
|
||||||
|
- Labels: `feedback` + category label
|
||||||
|
- Body: include context, tool/workflow, issue, reproduction, affected
|
||||||
|
files, suggested investigation, and "Reported by: parent agent"
|
||||||
|
|
||||||
|
Always deduplicate first via `list_issues` with `labels: "feedback"`.
|
||||||
|
|
||||||
|
|||||||
+198
@@ -2,6 +2,204 @@
|
|||||||
|
|
||||||
All notable changes to this project will be documented in this file.
|
All notable changes to this project will be documented in this file.
|
||||||
|
|
||||||
|
## [0.42.0] - 2026-07-13
|
||||||
|
|
||||||
|
### Features
|
||||||
|
|
||||||
|
- Add I/O function isolation check and skip integration tests
|
||||||
|
|
||||||
|
## [0.41.2] - 2026-07-13
|
||||||
|
|
||||||
|
### Bug Fixes
|
||||||
|
|
||||||
|
- Auto-discover molecule root instead of hardcoding gitea-runner
|
||||||
|
|
||||||
|
## [0.41.1] - 2026-07-13
|
||||||
|
|
||||||
|
### Bug Fixes
|
||||||
|
|
||||||
|
- Check_test_isolation accepts multiple --test-path values
|
||||||
|
|
||||||
|
## [0.41.0] - 2026-07-13
|
||||||
|
|
||||||
|
### Features
|
||||||
|
|
||||||
|
- Test isolation pytest plugin, shift-left quality gates, dep upgrades
|
||||||
|
|
||||||
|
## [0.40.1] - 2026-07-12
|
||||||
|
|
||||||
|
### Bug Fixes
|
||||||
|
|
||||||
|
- Fall back to CI token when reviewer self-approval is rejected
|
||||||
|
|
||||||
|
## [0.40.0] - 2026-07-11
|
||||||
|
|
||||||
|
### Features
|
||||||
|
|
||||||
|
- Detect double-prefix in Vikunja task title during pre-merge validation
|
||||||
|
|
||||||
|
## [0.39.0] - 2026-07-09
|
||||||
|
|
||||||
|
### Features
|
||||||
|
|
||||||
|
- Extract shared utilities from infra and grm into devx
|
||||||
|
|
||||||
|
## [0.38.0] - 2026-07-08
|
||||||
|
|
||||||
|
### Features
|
||||||
|
|
||||||
|
- Introduce role-based Gitea API token environment variables
|
||||||
|
|
||||||
|
## [0.37.0] - 2026-07-07
|
||||||
|
|
||||||
|
### Features
|
||||||
|
|
||||||
|
- Consolidate docs checks into devx-docs-check target
|
||||||
|
|
||||||
|
## [0.36.2] - 2026-07-07
|
||||||
|
|
||||||
|
### Bug Fixes
|
||||||
|
|
||||||
|
- GiteaClient.set_repo_variable uses PUT instead of PATCH
|
||||||
|
|
||||||
|
## [0.36.1] - 2026-07-07
|
||||||
|
|
||||||
|
### Bug Fixes
|
||||||
|
|
||||||
|
- Preserve .badges/ dir during git clean in push_badges
|
||||||
|
|
||||||
|
## [0.36.0] - 2026-07-07
|
||||||
|
|
||||||
|
### Features
|
||||||
|
|
||||||
|
- Add GiteaClient repo variable methods and parallelize pytest-cov
|
||||||
|
|
||||||
|
## [0.35.7] - 2026-07-06
|
||||||
|
|
||||||
|
### Bug Fixes
|
||||||
|
|
||||||
|
- Use Gitea wiki dash-marker filename convention
|
||||||
|
|
||||||
|
## [0.35.6] - 2026-07-06
|
||||||
|
|
||||||
|
### Bug Fixes
|
||||||
|
|
||||||
|
- Add delay before wiki verification to avoid race condition
|
||||||
|
|
||||||
|
## [0.35.5] - 2026-07-06
|
||||||
|
|
||||||
|
### Bug Fixes
|
||||||
|
|
||||||
|
- Embed token in wiki clone URL for push auth
|
||||||
|
|
||||||
|
## [0.35.4] - 2026-07-06
|
||||||
|
|
||||||
|
### Bug Fixes
|
||||||
|
|
||||||
|
- Configure git identity before commit in sync_wiki
|
||||||
|
|
||||||
|
## [0.35.3] - 2026-07-06
|
||||||
|
|
||||||
|
### Bug Fixes
|
||||||
|
|
||||||
|
- Replace --strict with --verify for sync_wiki
|
||||||
|
|
||||||
|
## [0.35.2] - 2026-07-06
|
||||||
|
|
||||||
|
### Bug Fixes
|
||||||
|
|
||||||
|
- Exclude .vale directory from lint_docs scanning
|
||||||
|
|
||||||
|
## [0.35.1] - 2026-07-06
|
||||||
|
|
||||||
|
### Refactor
|
||||||
|
|
||||||
|
- Rewrite sync_wiki.py to use git-based approach
|
||||||
|
|
||||||
|
## [0.35.0] - 2026-07-06
|
||||||
|
|
||||||
|
### Features
|
||||||
|
|
||||||
|
- Enrich lint_docs.py with single H1, max depth, line length, code block lang, orphan checks
|
||||||
|
|
||||||
|
## [0.34.0] - 2026-07-06
|
||||||
|
|
||||||
|
### Features
|
||||||
|
|
||||||
|
- Enhance documentation-as-code with badges, version refs, Vale
|
||||||
|
|
||||||
|
## [0.33.4] - 2026-07-06
|
||||||
|
|
||||||
|
### Refactor
|
||||||
|
|
||||||
|
- Remove project-specific references from devx
|
||||||
|
|
||||||
|
## [0.33.3] - 2026-07-06
|
||||||
|
|
||||||
|
### Bug Fixes
|
||||||
|
|
||||||
|
- Make wiki sync resilient to API timeouts and stale page lists
|
||||||
|
|
||||||
|
## [0.33.2] - 2026-07-05
|
||||||
|
|
||||||
|
### Bug Fixes
|
||||||
|
|
||||||
|
- Abort sync_wiki when list_wiki_pages fails
|
||||||
|
|
||||||
|
## [0.33.1] - 2026-07-05
|
||||||
|
|
||||||
|
### Bug Fixes
|
||||||
|
|
||||||
|
- Build images after post-merge publish, not on push
|
||||||
|
|
||||||
|
## [0.33.0] - 2026-07-05
|
||||||
|
|
||||||
|
### Features
|
||||||
|
|
||||||
|
- Add check_api_identity_checks, setup_ssh_key, and api utils
|
||||||
|
|
||||||
|
## [0.32.1] - 2026-07-01
|
||||||
|
|
||||||
|
### Bug Fixes
|
||||||
|
|
||||||
|
- Add missing i18n translations for new tools
|
||||||
|
|
||||||
|
## [0.32.0] - 2026-07-01
|
||||||
|
|
||||||
|
### Features
|
||||||
|
|
||||||
|
- Extract docker-login, tofu-ops, check-deps, install-tofu to Python tools
|
||||||
|
|
||||||
|
## [0.31.0] - 2026-07-01
|
||||||
|
|
||||||
|
### Features
|
||||||
|
|
||||||
|
- Centralize venv management in devx.mak
|
||||||
|
|
||||||
|
## [0.30.0] - 2026-07-01
|
||||||
|
|
||||||
|
### Features
|
||||||
|
|
||||||
|
- Add standard label creation to configure_repo
|
||||||
|
|
||||||
|
## [0.29.1] - 2026-07-01
|
||||||
|
|
||||||
|
### Bug Fixes
|
||||||
|
|
||||||
|
- Strip task ID prefix from commit messages in extract_conventional_msg
|
||||||
|
|
||||||
|
## [0.29.0] - 2026-07-01
|
||||||
|
|
||||||
|
### Features
|
||||||
|
|
||||||
|
- Detect badge commits as automated CI commits
|
||||||
|
|
||||||
|
## [0.28.0] - 2026-07-01
|
||||||
|
|
||||||
|
### Features
|
||||||
|
|
||||||
|
- Auto-rebase in auto-merge, new rebase tools, CLI registration
|
||||||
|
|
||||||
## [0.27.3] - 2026-06-30
|
## [0.27.3] - 2026-06-30
|
||||||
|
|
||||||
### Bug Fixes
|
### Bug Fixes
|
||||||
|
|||||||
@@ -6,6 +6,36 @@ BIN := $(VENV)/bin
|
|||||||
|
|
||||||
all: setup
|
all: setup
|
||||||
|
|
||||||
|
# --- devx.mak integration ----------------------------------------------------
|
||||||
|
# Include shared targets from the devx package itself (venv management,
|
||||||
|
# workflow-lint, notify-failure, checkmake, lint targets, quality checks, etc.)
|
||||||
|
# Since devx IS the package, we can include its own devx.mak.
|
||||||
|
DEVX_PYTHON := $(BIN)/python
|
||||||
|
DEVX_VENV := $(VENV)
|
||||||
|
DEVX_BIN := $(BIN)
|
||||||
|
DEVX_LINT_PATHS := src/ tests/
|
||||||
|
DEVX_COV_PKG := src/devx
|
||||||
|
DEVX_TEST_PATHS := tests/
|
||||||
|
|
||||||
|
DEVX_MAK := $(shell $(BIN)/python -c \
|
||||||
|
"from pathlib import Path; import devx; print(Path(devx.__file__).parent / 'make' / 'devx.mak')" \
|
||||||
|
2>/dev/null)
|
||||||
|
# Fallback: when the venv doesn't exist yet (chicken-and-egg), use the
|
||||||
|
# source tree copy directly. devx IS the package, so src/devx/make/devx.mak
|
||||||
|
# is always available in this repo.
|
||||||
|
ifeq ($(strip $(DEVX_MAK)),)
|
||||||
|
DEVX_MAK := $(CURDIR)/src/devx/make/devx.mak
|
||||||
|
endif
|
||||||
|
-include $(DEVX_MAK)
|
||||||
|
|
||||||
|
# venv, .env, and activate-scripts are provided by devx.mak
|
||||||
|
# (devx-venv, devx-env, devx-activate-scripts, $(DEVX_VENV)/bin/activate rule)
|
||||||
|
# Aliases for convenience and backward compatibility:
|
||||||
|
.PHONY: venv activate-scripts
|
||||||
|
venv: devx-venv
|
||||||
|
.env: devx-env
|
||||||
|
activate-scripts: devx-activate-scripts
|
||||||
|
|
||||||
# Full setup for local development
|
# Full setup for local development
|
||||||
setup: $(VENV)/bin/activate .env activate-scripts install-tools
|
setup: $(VENV)/bin/activate .env activate-scripts install-tools
|
||||||
@$(BIN)/pip install -e '.[dev]' 2>/dev/null; \
|
@$(BIN)/pip install -e '.[dev]' 2>/dev/null; \
|
||||||
@@ -35,22 +65,9 @@ setup-release: $(VENV)/bin/activate .env
|
|||||||
# an older devx.mak that doesn't yet define devx-setup-image. Consumer repos
|
# an older devx.mak that doesn't yet define devx-setup-image. Consumer repos
|
||||||
# (grm, infra) can safely alias to devx-setup-image since they install devx from PyPI.
|
# (grm, infra) can safely alias to devx-setup-image since they install devx from PyPI.
|
||||||
setup-image:
|
setup-image:
|
||||||
@if [ -d /opt/venv ]; then ln -sf /opt/venv .venv; . .venv/bin/activate && pip install --no-cache-dir -e . 2>/dev/null; \
|
@if [ -d /opt/venv ]; then ln -sf /opt/venv $(VENV); . $(VENV)/bin/activate && pip install --no-cache-dir -e . 2>/dev/null; \
|
||||||
else echo "[setup-image] /opt/venv not found — falling back to setup-ci"; $(MAKE) setup-ci; fi
|
else echo "[setup-image] /opt/venv not found — falling back to setup-ci"; $(MAKE) setup-ci; fi
|
||||||
|
|
||||||
.env:
|
|
||||||
@if [ ! -f .env ]; then cp .env.example .env; echo "Created .env from .env.example — please edit it."; fi
|
|
||||||
|
|
||||||
$(VENV)/bin/activate:
|
|
||||||
@python3 -c "import sys; v=sys.version_info; assert v >= (3, 12), f'Python 3.12+ required, found {v.major}.{v.minor}'; print(f'Python {v.major}.{v.minor}.{v.micro} OK')"
|
|
||||||
$(PYTHON) -m venv $(VENV)
|
|
||||||
$(BIN)/pip install --upgrade pip setuptools wheel
|
|
||||||
|
|
||||||
activate-scripts: $(VENV)/bin/activate
|
|
||||||
@test -f activate.sh || (echo '#!/usr/bin/env bash' > activate.sh && echo 'source "$$(cd "$$(dirname "$${BASH_SOURCE[0]}")" && pwd)/.venv/bin/activate"' >> activate.sh && chmod +x activate.sh)
|
|
||||||
@test -f activate.fish || (echo '#!/usr/bin/env fish' > activate.fish && echo 'set -l script_dir (dirname (status --current-filename))' >> activate.fish && echo 'source "$$script_dir/.venv/bin/activate.fish"' >> activate.fish && chmod +x activate.fish)
|
|
||||||
@test -f activate.zsh || (echo '#!/usr/bin/env zsh' > activate.zsh && echo '0="$${ZERO:-$${0:#$$ZSH_ARGZERO}}"' >> activate.zsh && echo '0="$${$${(M)0:#/*}:-$$PWD/$$0}"' >> activate.zsh && echo 'source "$${0:A:h}/.venv/bin/activate"' >> activate.zsh && chmod +x activate.zsh)
|
|
||||||
|
|
||||||
install-hooks:
|
install-hooks:
|
||||||
@cp hooks/pre-commit .git/hooks/pre-commit && chmod +x .git/hooks/pre-commit
|
@cp hooks/pre-commit .git/hooks/pre-commit && chmod +x .git/hooks/pre-commit
|
||||||
@cp hooks/pre-push .git/hooks/pre-push && chmod +x .git/hooks/pre-push
|
@cp hooks/pre-push .git/hooks/pre-push && chmod +x .git/hooks/pre-push
|
||||||
@@ -60,23 +77,13 @@ install-tools: $(VENV)/bin/activate
|
|||||||
@$(BIN)/pip install -e '.' 2>/dev/null; \
|
@$(BIN)/pip install -e '.' 2>/dev/null; \
|
||||||
$(BIN)/python -m devx.tools.install_tools
|
$(BIN)/python -m devx.tools.install_tools
|
||||||
|
|
||||||
# --- devx.mak integration ----------------------------------------------------
|
|
||||||
# Include shared targets from the devx package itself (workflow-lint,
|
|
||||||
# notify-failure, checkmake, lint targets, quality checks, etc.)
|
|
||||||
# Since devx IS the package, we can include its own devx.mak.
|
|
||||||
DEVX_PYTHON := $(BIN)/python
|
|
||||||
DEVX_VENV := $(VENV)
|
|
||||||
DEVX_BIN := $(BIN)
|
|
||||||
DEVX_LINT_PATHS := src/ tests/
|
|
||||||
DEVX_COV_PKG := src/devx
|
|
||||||
DEVX_TEST_PATHS := tests/
|
|
||||||
|
|
||||||
DEVX_MAK := $(shell $(BIN)/python -c \
|
|
||||||
"from pathlib import Path; import devx; print(Path(devx.__file__).parent / 'make' / 'devx.mak')" \
|
|
||||||
2>/dev/null)
|
|
||||||
-include $(DEVX_MAK)
|
|
||||||
|
|
||||||
# Aliases — project-specific names map to devx.mak targets
|
# Aliases — project-specific names map to devx.mak targets
|
||||||
|
.PHONY: lint-ruff lint-format typecheck lint-bandit lint-deps lint
|
||||||
|
.PHONY: workflow-lint workflow-dryrun workflow-dryrun-safe workflow-check
|
||||||
|
.PHONY: notify-failure checkmake check-mutable-globals check-dep-docs
|
||||||
|
.PHONY: check-test-speed check-test-coverage check-docs check-test-isolation check-translations
|
||||||
|
.PHONY: create-task create-pr push-with-pr git-push rebase pr-rebase
|
||||||
|
.PHONY: lint-all lint-dockerfiles
|
||||||
lint-ruff: devx-lint-ruff
|
lint-ruff: devx-lint-ruff
|
||||||
lint-format: devx-lint-format
|
lint-format: devx-lint-format
|
||||||
typecheck: devx-typecheck
|
typecheck: devx-typecheck
|
||||||
@@ -92,12 +99,16 @@ checkmake: devx-checkmake
|
|||||||
check-mutable-globals: devx-check-mutable-globals
|
check-mutable-globals: devx-check-mutable-globals
|
||||||
check-dep-docs: devx-check-dep-docs
|
check-dep-docs: devx-check-dep-docs
|
||||||
check-test-speed: devx-check-test-speed
|
check-test-speed: devx-check-test-speed
|
||||||
|
check-test-isolation: devx-check-test-isolation
|
||||||
|
check-translations: devx-check-translations
|
||||||
check-test-coverage: devx-check-test-coverage
|
check-test-coverage: devx-check-test-coverage
|
||||||
check-docs: devx-check-docs
|
check-docs: devx-check-docs
|
||||||
create-task: devx-create-task
|
create-task: devx-create-task
|
||||||
create-pr: devx-create-pr
|
create-pr: devx-create-pr
|
||||||
push-with-pr: devx-push-with-pr
|
push-with-pr: devx-push-with-pr
|
||||||
git-push: devx-push
|
git-push: devx-push
|
||||||
|
rebase: devx-rebase
|
||||||
|
pr-rebase: devx-pr-rebase
|
||||||
|
|
||||||
lint-all: lint workflow-lint lint-dockerfiles
|
lint-all: lint workflow-lint lint-dockerfiles
|
||||||
@echo "[lint-all] All linting checks passed."
|
@echo "[lint-all] All linting checks passed."
|
||||||
@@ -106,10 +117,7 @@ lint-all: lint workflow-lint lint-dockerfiles
|
|||||||
# devx's own CI images may have an older devx.mak. Consumer repos can safely alias.
|
# devx's own CI images may have an older devx.mak. Consumer repos can safely alias.
|
||||||
lint-dockerfiles:
|
lint-dockerfiles:
|
||||||
@echo "[lint-dockerfiles] Linting Dockerfiles with hadolint..."
|
@echo "[lint-dockerfiles] Linting Dockerfiles with hadolint..."
|
||||||
@if ! command -v hadolint >/dev/null 2>&1; then \
|
@command -v hadolint >/dev/null 2>&1 || { echo "hadolint not found" >&2; exit 1; }
|
||||||
echo "[lint-dockerfiles] ERROR: hadolint not found. Install from https://github.com/hadolint/hadolint/releases" >&2; \
|
|
||||||
exit 1; \
|
|
||||||
fi
|
|
||||||
@find docker -name 'Dockerfile*' -exec hadolint {} +
|
@find docker -name 'Dockerfile*' -exec hadolint {} +
|
||||||
@echo "[lint-dockerfiles] All Dockerfiles passed."
|
@echo "[lint-dockerfiles] All Dockerfiles passed."
|
||||||
|
|
||||||
|
|||||||
@@ -16,12 +16,12 @@ quality badges.
|
|||||||
|
|
||||||
[](https://git.oblachno.oblachno.fyi/oblachno-oss/devx/actions)
|
[](https://git.oblachno.oblachno.fyi/oblachno-oss/devx/actions)
|
||||||
[](https://git.oblachno.oblachno.fyi/oblachno-oss/devx/src/branch/master/LICENSE)
|
[](https://git.oblachno.oblachno.fyi/oblachno-oss/devx/src/branch/master/LICENSE)
|
||||||
[](https://git.oblachno.oblachno.fyi/oblachno-oss/devx/actions)
|
[](https://git.oblachno.oblachno.fyi/oblachno-oss/devx/actions)
|
||||||
[](https://git.oblachno.oblachno.fyi/oblachno-oss/devx/actions)
|
[](https://git.oblachno.oblachno.fyi/oblachno-oss/devx/actions)
|
||||||
[](https://git.oblachno.oblachno.fyi/oblachno-oss/devx/wiki)
|
[](https://git.oblachno.oblachno.fyi/oblachno-oss/devx/wiki)
|
||||||
[](https://git.oblachno.oblachno.fyi/oblachno-oss/devx/actions)
|
[](https://git.oblachno.oblachno.fyi/oblachno-oss/devx/actions)
|
||||||
[](https://git.oblachno.oblachno.fyi/oblachno-oss/devx/releases)
|
[](https://git.oblachno.oblachno.fyi/oblachno-oss/devx/releases)
|
||||||
[](https://www.python.org/downloads/)
|
[](https://www.python.org/downloads/)
|
||||||
|
|
||||||
## Why devx?
|
## Why devx?
|
||||||
|
|
||||||
@@ -87,7 +87,7 @@ extra index and list devx in your dependencies:
|
|||||||
```toml
|
```toml
|
||||||
[project]
|
[project]
|
||||||
dependencies = [
|
dependencies = [
|
||||||
"devx>=0.11.1",
|
"devx>=0.42.0",
|
||||||
]
|
]
|
||||||
|
|
||||||
[tool.pip]
|
[tool.pip]
|
||||||
@@ -101,8 +101,8 @@ pip install -e .
|
|||||||
```
|
```
|
||||||
|
|
||||||
> **Note:** If your project requires a specific devx version, pin it in
|
> **Note:** If your project requires a specific devx version, pin it in
|
||||||
> `dependencies` (e.g., `"devx==0.11.1"`) or use a version constraint
|
> `dependencies` (for example, `"devx==0.42.0"`) or use a version constraint
|
||||||
> (e.g., `"devx>=0.11.1,<0.12"`).
|
> (for example, `"devx>=0.42.0,<0.43"`).
|
||||||
|
|
||||||
### Optional extras
|
### Optional extras
|
||||||
|
|
||||||
@@ -372,7 +372,7 @@ infrastructure = []
|
|||||||
|
|
||||||
# Files that would default to user-facing but are actually infrastructure
|
# Files that would default to user-facing but are actually infrastructure
|
||||||
infrastructure_overrides = [
|
infrastructure_overrides = [
|
||||||
"src/myproject/__init__.py", # only contains __version__
|
"src/myproject/__init__.py", # example only — only contains __version__
|
||||||
]
|
]
|
||||||
|
|
||||||
# Safety override for broad infrastructure patterns
|
# Safety override for broad infrastructure patterns
|
||||||
@@ -420,7 +420,7 @@ make clean # Remove caches, build artifacts, coverage data
|
|||||||
| `make lint-deps` | pip-audit dependency vulnerability scan |
|
| `make lint-deps` | pip-audit dependency vulnerability scan |
|
||||||
| `make test-unit` | Unit tests without coverage |
|
| `make test-unit` | Unit tests without coverage |
|
||||||
| `make pytest-cov` | Unit tests with 100% coverage enforcement |
|
| `make pytest-cov` | Unit tests with 100% coverage enforcement |
|
||||||
| `make workflow-lint` | actionlint on .gitea/workflows/*.yml |
|
| `make workflow-lint` | actionlint on `.gitea/workflows/*.yml` |
|
||||||
| `make workflow-dryrun` | act_runner exec --dryrun on all workflows |
|
| `make workflow-dryrun` | act_runner exec --dryrun on all workflows |
|
||||||
| `make workflow-check` | workflow-lint + workflow-dryrun |
|
| `make workflow-check` | workflow-lint + workflow-dryrun |
|
||||||
| `make clean` | Remove caches, build artifacts, coverage data |
|
| `make clean` | Remove caches, build artifacts, coverage data |
|
||||||
@@ -434,7 +434,7 @@ devx is a self-contained Python package under `src/devx/`. It never imports
|
|||||||
from scripts outside the package. All tools are invoked via
|
from scripts outside the package. All tools are invoked via
|
||||||
`python -m devx.ci.*`, `python -m devx.tools.*`, or `python -m devx.molecule.*`.
|
`python -m devx.ci.*`, `python -m devx.tools.*`, or `python -m devx.molecule.*`.
|
||||||
|
|
||||||
```
|
```text
|
||||||
src/devx/
|
src/devx/
|
||||||
├── __init__.py # Version (single source of truth, read by setuptools)
|
├── __init__.py # Version (single source of truth, read by setuptools)
|
||||||
├── cli.py # Click-based CLI entry point (devx command)
|
├── cli.py # Click-based CLI entry point (devx command)
|
||||||
|
|||||||
@@ -20,11 +20,5 @@ COPY . /tmp/devx
|
|||||||
RUN pip install --no-cache-dir /tmp/devx[release,molecule,deploy] \
|
RUN pip install --no-cache-dir /tmp/devx[release,molecule,deploy] \
|
||||||
&& rm -rf /tmp/devx
|
&& rm -rf /tmp/devx
|
||||||
|
|
||||||
# Install git-cliff (changelog generator for release job)
|
# Install git-cliff (changelog generator for release job) and OpenTofu (for infra deploy jobs)
|
||||||
RUN python3 -m devx.tools.install_tools --tool git-cliff
|
RUN python3 -m devx.tools.install_tools --tool git-cliff --tool tofu
|
||||||
|
|
||||||
# Install OpenTofu (for infra deploy jobs)
|
|
||||||
RUN ARCH=$(uname -m | sed 's/x86_64/amd64/') \
|
|
||||||
&& VERSION=1.12.3 \
|
|
||||||
&& curl -fsSL "https://github.com/opentofu/opentofu/releases/download/v${VERSION}/tofu_${VERSION}_$(uname -s | tr '[:upper:]' '[:lower:]')_${ARCH}.tar.gz" \
|
|
||||||
| tar -xz -C /usr/local/bin tofu
|
|
||||||
|
|||||||
@@ -13,10 +13,5 @@ RUN pip install --no-cache-dir /tmp/devx[lint] \
|
|||||||
&& rm -rf /tmp/devx
|
&& rm -rf /tmp/devx
|
||||||
|
|
||||||
# Install CI/CD binary tools
|
# Install CI/CD binary tools
|
||||||
RUN python3 -m devx.tools.install_tools --tool actionlint \
|
RUN python3 -m devx.tools.install_tools --tool actionlint --tool vale --tool hadolint \
|
||||||
&& python3 -m devx.tools.install_checkmake
|
&& python3 -m devx.tools.install_checkmake
|
||||||
|
|
||||||
# Install hadolint (Dockerfile linter)
|
|
||||||
RUN curl -fsSL "https://github.com/hadolint/hadolint/releases/download/v2.12.0/hadolint-Linux-x86_64" \
|
|
||||||
-o /usr/local/bin/hadolint \
|
|
||||||
&& chmod +x /usr/local/bin/hadolint
|
|
||||||
|
|||||||
@@ -0,0 +1,142 @@
|
|||||||
|
# ADR-0001: Test Isolation Pytest Plugin and Shift-Left Quality Gates
|
||||||
|
|
||||||
|
Date: 2026-07-13
|
||||||
|
Status: Accepted
|
||||||
|
|
||||||
|
## Context
|
||||||
|
|
||||||
|
Unit tests in devx were slow (10s+) and getting slower. Investigation
|
||||||
|
revealed two root causes:
|
||||||
|
|
||||||
|
1. **Unpatched subprocess calls** — test functions calling
|
||||||
|
`subprocess.run`, `update_doc_versions`, or `run_cmd` without
|
||||||
|
`@patch` decorators, causing real subprocess execution during tests.
|
||||||
|
2. **Excessive iterations** — statistical tests with 1000-iteration
|
||||||
|
loops that should use property-based testing or smaller samples.
|
||||||
|
|
||||||
|
These issues were discovered manually by profiling with
|
||||||
|
`pytest --durations=0`. There was no automated check to prevent
|
||||||
|
regressions — new tests could introduce the same patterns and slow
|
||||||
|
down the suite again.
|
||||||
|
|
||||||
|
Additionally, translation completeness checks
|
||||||
|
(`devx.ci.check_translations`) only ran in CI, not locally. Developers
|
||||||
|
discovered missing translations at CI time, wasting round-trips.
|
||||||
|
|
||||||
|
## Decision
|
||||||
|
|
||||||
|
### 1. Test Isolation as a Pytest Plugin (pytest11 entry point)
|
||||||
|
|
||||||
|
Implement the test isolation check as a **pytest plugin** registered
|
||||||
|
via the `pytest11` entry point in `pyproject.toml`:
|
||||||
|
|
||||||
|
```toml
|
||||||
|
[project.entry-points.pytest11]
|
||||||
|
devx_test_isolation = "devx.tools.check_test_isolation"
|
||||||
|
```
|
||||||
|
|
||||||
|
This makes the check **transparent and always-on** — every `pytest`
|
||||||
|
invocation in any repo with devx installed automatically runs the
|
||||||
|
static analysis. No extra Makefile target or CI step needed.
|
||||||
|
|
||||||
|
The plugin (`devx.tools.check_test_isolation`) statically analyzes
|
||||||
|
test files during `pytest_collection_finish` and emits
|
||||||
|
`UserWarning` for violations:
|
||||||
|
|
||||||
|
- **unpatched-subprocess**: `subprocess.run/call/Popen/check_call/check_output`
|
||||||
|
called in a test function without `@patch`
|
||||||
|
- **unpatched-sleep**: `time.sleep` called without `@patch`
|
||||||
|
- **unpatched-helper**: known subprocess-spawning helpers
|
||||||
|
(`update_doc_versions`, `run_cmd`, `run_tests`) called without
|
||||||
|
`@patch` (and without patching their internal dependencies)
|
||||||
|
- **excessive-iterations**: `for _ in range(N)` where N > 100
|
||||||
|
|
||||||
|
The plugin recognizes transitive safety: if `run_cmd` is patched,
|
||||||
|
`run_tests` (which calls `run_cmd`) is safe. This is tracked via
|
||||||
|
`HELPER_INTERNAL_CALLS`.
|
||||||
|
|
||||||
|
A standalone CLI (`python -m devx.tools.check_test_isolation`) is also
|
||||||
|
provided for CI gates and pre-commit hooks where pytest isn't run.
|
||||||
|
|
||||||
|
### 2. Shift-Left Quality Gates in `make lint`
|
||||||
|
|
||||||
|
Add `devx-check-translations` and `devx-check-test-isolation` to the
|
||||||
|
`devx-lint` target in `devx.mak`. This means `make lint` now runs:
|
||||||
|
|
||||||
|
- ruff check + format
|
||||||
|
- pyright typecheck
|
||||||
|
- bandit security scan
|
||||||
|
- **translation completeness** (missing keys, dead keys, missing languages)
|
||||||
|
- **test isolation** (unpatched subprocess, time.sleep, excessive loops)
|
||||||
|
|
||||||
|
These were previously CI-only checks. Running them in `make lint`
|
||||||
|
catches issues at the developer's machine, not in CI.
|
||||||
|
|
||||||
|
### 3. Pre-commit Hook Coverage
|
||||||
|
|
||||||
|
Update the pre-commit hook to run all three shift-left checks:
|
||||||
|
test speed, translation completeness, and test isolation. This
|
||||||
|
catches issues even earlier than `make lint` — before the commit
|
||||||
|
is even created.
|
||||||
|
|
||||||
|
## Consequences
|
||||||
|
|
||||||
|
### Positive
|
||||||
|
|
||||||
|
- **Automatic enforcement**: The pytest plugin runs on every `pytest`
|
||||||
|
invocation across devx, grm, and infra — no per-repo configuration
|
||||||
|
needed. New tests with unpatched subprocess calls emit warnings
|
||||||
|
immediately.
|
||||||
|
- **Shift-left**: Translation gaps and test isolation violations are
|
||||||
|
caught locally (pre-commit / `make lint`) instead of in CI.
|
||||||
|
- **Fast feedback**: Static analysis adds <0.1s to test runs — no
|
||||||
|
runtime overhead.
|
||||||
|
- **No false positives**: The transitive dependency tracking
|
||||||
|
(`HELPER_INTERNAL_CALLS`) correctly recognizes that patching
|
||||||
|
`run_cmd` makes `run_tests` safe, and patching `subprocess.run`
|
||||||
|
makes all helpers safe.
|
||||||
|
|
||||||
|
### Negative
|
||||||
|
|
||||||
|
- **Coverage instrumentation gap**: The pytest plugin module is loaded
|
||||||
|
before coverage starts, so module-level code (decorators, class
|
||||||
|
definitions) appears uncovered. Mitigated by `-p no:devx_test_isolation`
|
||||||
|
in devx's own `pyproject.toml` `addopts` and `# pragma: no cover` on
|
||||||
|
plugin hook functions.
|
||||||
|
- **Static analysis limitations**: The plugin only sees direct calls
|
||||||
|
in test function bodies, not indirect calls through `main()` or
|
||||||
|
other wrappers. This is acceptable — the `check_test_speed` tool
|
||||||
|
catches the symptom (slow tests) for indirect cases.
|
||||||
|
- **Translation burden**: Every new `_()` call in source requires
|
||||||
|
adding 6 language translations. This is by design (all supported
|
||||||
|
languages must be complete) but adds friction for quick prototypes.
|
||||||
|
|
||||||
|
## Implementation Details
|
||||||
|
|
||||||
|
### Pytest Plugin Discovery
|
||||||
|
|
||||||
|
The `pytest11` entry point is the standard mechanism for pytest
|
||||||
|
plugins. When devx is installed (via pip), pytest auto-discovers
|
||||||
|
the plugin. No `conftest.py` or `pytest_plugins` declaration needed
|
||||||
|
in consumer repos.
|
||||||
|
|
||||||
|
### Disabling the Plugin
|
||||||
|
|
||||||
|
- `--no-test-isolation` flag: disables analysis for a single run
|
||||||
|
- `-p no:devx_test_isolation` in `addopts`: disables for a repo
|
||||||
|
(used in devx's own `pyproject.toml` for coverage reasons)
|
||||||
|
|
||||||
|
### Strict Mode
|
||||||
|
|
||||||
|
- `--strict-test-isolation` flag: promotes warnings to errors and
|
||||||
|
prints a summary to stderr
|
||||||
|
- `filterwarnings = ["error:Test isolation:UserWarning"]` in
|
||||||
|
`pyproject.toml`: same effect via pytest's warning filter system
|
||||||
|
|
||||||
|
### Known Subprocess Helpers
|
||||||
|
|
||||||
|
The `KNOWN_SUBPROCESS_HELPERS` dict maps function names to
|
||||||
|
descriptions. `HELPER_INTERNAL_CALLS` maps each helper to the
|
||||||
|
function names it internally calls, enabling transitive safety
|
||||||
|
checks. Both are defined in `check_test_isolation.py` and can be
|
||||||
|
extended as new subprocess-spawning helpers are added to devx.
|
||||||
+9
-9
@@ -12,12 +12,12 @@ project to be reusable across all oblachno-oss repositories.
|
|||||||
|
|
||||||
[](https://git.oblachno.oblachno.fyi/oblachno-oss/devx/actions)
|
[](https://git.oblachno.oblachno.fyi/oblachno-oss/devx/actions)
|
||||||
[](https://git.oblachno.oblachno.fyi/oblachno-oss/devx/src/branch/master/LICENSE)
|
[](https://git.oblachno.oblachno.fyi/oblachno-oss/devx/src/branch/master/LICENSE)
|
||||||
[](https://git.oblachno.oblachno.fyi/oblachno-oss/devx/actions)
|
[](https://git.oblachno.oblachno.fyi/oblachno-oss/devx/actions)
|
||||||
[](https://git.oblachno.oblachno.fyi/oblachno-oss/devx/actions)
|
[](https://git.oblachno.oblachno.fyi/oblachno-oss/devx/actions)
|
||||||
[](https://git.oblachno.oblachno.fyi/oblachno-oss/devx/wiki)
|
[](https://git.oblachno.oblachno.fyi/oblachno-oss/devx/wiki)
|
||||||
[](https://git.oblachno.oblachno.fyi/oblachno-oss/devx/actions)
|
[](https://git.oblachno.oblachno.fyi/oblachno-oss/devx/actions)
|
||||||
[](https://git.oblachno.oblachno.fyi/oblachno-oss/devx/releases)
|
[](https://git.oblachno.oblachno.fyi/oblachno-oss/devx/releases)
|
||||||
[](https://www.python.org/downloads/)
|
[](https://www.python.org/downloads/)
|
||||||
|
|
||||||
## Overview
|
## Overview
|
||||||
|
|
||||||
@@ -74,14 +74,14 @@ Add devx to your `pyproject.toml` dependencies and configure the registry:
|
|||||||
```toml
|
```toml
|
||||||
[project]
|
[project]
|
||||||
dependencies = [
|
dependencies = [
|
||||||
"devx>=0.11.1",
|
"devx>=0.42.0",
|
||||||
]
|
]
|
||||||
|
|
||||||
[tool.pip]
|
[tool.pip]
|
||||||
extra-index-url = "https://git.oblachno.oblachno.fyi/api/packages/oblachno-oss/pypi/simple"
|
extra-index-url = "https://git.oblachno.oblachno.fyi/api/packages/oblachno-oss/pypi/simple"
|
||||||
```
|
```
|
||||||
|
|
||||||
Pin a specific version if needed: `"devx==0.11.1"` or `"devx>=0.11.1,<0.12"`.
|
Pin a specific version if needed: `"devx==0.42.0"` or `"devx>=0.42.0,<0.43"`.
|
||||||
|
|
||||||
### Optional extras
|
### Optional extras
|
||||||
|
|
||||||
@@ -131,7 +131,7 @@ wiki sync details.
|
|||||||
devx provides a `devx` CLI with three command groups:
|
devx provides a `devx` CLI with three command groups:
|
||||||
|
|
||||||
- `devx ci <command>` — CI/CD automation (17 commands)
|
- `devx ci <command>` — CI/CD automation (17 commands)
|
||||||
- `devx tools <command>` — Developer tools (7 commands)
|
- `devx tools <command>` — Developer tools (9 commands)
|
||||||
- `devx molecule <command>` — Molecule testing (4 commands, optional)
|
- `devx molecule <command>` — Molecule testing (4 commands, optional)
|
||||||
|
|
||||||
See [CLI Commands](CLI-Commands) for full command documentation with examples.
|
See [CLI Commands](CLI-Commands) for full command documentation with examples.
|
||||||
|
|||||||
@@ -0,0 +1,158 @@
|
|||||||
|
# Retrospective: Self-Approval Fallback and CI Consolidation
|
||||||
|
|
||||||
|
## Date
|
||||||
|
2026-07-12
|
||||||
|
|
||||||
|
## Context
|
||||||
|
The devx package (reusable CI/CD tools) underwent two significant
|
||||||
|
changes during this period: workflow consolidation (DEVX-126) and the
|
||||||
|
self-approval fallback fix (DEVX-127). The self-approval bug was the
|
||||||
|
last remaining blocker for end-to-end automated CI/CD across all
|
||||||
|
oblachno repos. This retrospective covers devx v0.40.0 through v0.40.1.
|
||||||
|
|
||||||
|
## Scope
|
||||||
|
|
||||||
|
PRs: DEVX-125 (double-prefix detection), DEVX-126 (CI consolidation),
|
||||||
|
DEVX-127 (self-approval fallback). ~16 commits including release/badge
|
||||||
|
churn.
|
||||||
|
|
||||||
|
## Timeline of Key Failures
|
||||||
|
|
||||||
|
| Run | Issue | Fix Commit |
|
||||||
|
|--------|----------------------------------------------|------------|
|
||||||
|
| infra #2562 | Self-approval rejected (403) | `d035b62` |
|
||||||
|
| devx CI | Auto-merge review body too short (< 20 chars) | `fc613d4` |
|
||||||
|
| devx CI | test_setup flaky due to PIP_BREAK_SYSTEM_PACKAGES | `043f259` |
|
||||||
|
| devx CI | Missing translations for self-approval messages | `0d8c7f5` |
|
||||||
|
|
||||||
|
## What Served Us Well
|
||||||
|
|
||||||
|
- **Test-driven fix for pr_review.py.** The self-approval fallback was
|
||||||
|
implemented with full test coverage before being deployed. Tests
|
||||||
|
covered both the fallback-available and fallback-unavailable paths,
|
||||||
|
ensuring the code was correct before it hit CI.
|
||||||
|
- **i18n enforcement caught missing translations.** The translation
|
||||||
|
completeness check flagged the new self-approval error messages that
|
||||||
|
were added without corresponding translation entries. This prevented
|
||||||
|
untranslated strings from reaching production.
|
||||||
|
- **Consolidated CI workflow.** DEVX-126 merged 7 separate CI jobs into
|
||||||
|
a single `validate` job, reducing runner overhead and eliminating
|
||||||
|
inter-job dependency issues. The consolidation pattern was then
|
||||||
|
applied to grm and infra.
|
||||||
|
- **Conventional commit enforcement.** The `validate_commit_msg` check
|
||||||
|
caught a double-prefix in the Vikunja task title (DEVX-125), which
|
||||||
|
would have caused auto-merge validation failures downstream.
|
||||||
|
|
||||||
|
## What Slowed Us Down
|
||||||
|
|
||||||
|
### 1. Self-Approval Bug Not Caught Earlier (1 infra CI failure)
|
||||||
|
|
||||||
|
The `pr_review.py` script used the `REVIEWER_GITEA_API_TOKEN` for
|
||||||
|
APPROVE events. When the token belonged to the PR author, Gitea
|
||||||
|
rejected the self-approval with 403. This was only discovered when the
|
||||||
|
infra PR CI run #2562 failed — the devx CI had passed because devx PRs
|
||||||
|
were reviewed by a different user.
|
||||||
|
|
||||||
|
**Root cause:** No test simulated the self-approval rejection scenario.
|
||||||
|
The tests mocked the Gitea API to always return 200 for review
|
||||||
|
submissions.
|
||||||
|
|
||||||
|
**Time wasted:** ~2 hours (cross-repo investigation + fix + test).
|
||||||
|
|
||||||
|
**Fix:** Added fallback to `CI_GITEA_API_TOKEN` when the reviewer token
|
||||||
|
is rejected with self-approval. The fallback is transparent — the
|
||||||
|
script logs a warning and retries with the CI token.
|
||||||
|
|
||||||
|
**Lesson:** Test API interactions against all HTTP error codes the
|
||||||
|
external system can return, not only the happy path. For Gitea, this
|
||||||
|
includes 403 (self-approval), 409 (conflict), and 422 (validation).
|
||||||
|
|
||||||
|
### 2. Auto-Merge Review Body Length Check (1 CI failure)
|
||||||
|
|
||||||
|
The auto-merge validation requires APPROVE review bodies to be > 20
|
||||||
|
chars (to prevent perfunctory approvals). The automated review posted
|
||||||
|
by `pr_review.py` had a body of exactly 17 chars, failing the check.
|
||||||
|
|
||||||
|
**Root cause:** The review body was a generic "Automated review passed"
|
||||||
|
message that was too short. The length check was added to prevent
|
||||||
|
rubber-stamping by human reviewers, but it also affected automated
|
||||||
|
reviews.
|
||||||
|
|
||||||
|
**Time wasted:** ~1 CI run.
|
||||||
|
|
||||||
|
**Fix:** Expanded the automated review body to include a summary of
|
||||||
|
checked categories, ensuring it exceeds 20 chars.
|
||||||
|
|
||||||
|
**Lesson:** Automated reviews need substantive bodies too. The length
|
||||||
|
check doesn't distinguish between human and automated reviewers.
|
||||||
|
|
||||||
|
### 3. test_setup Flaky Due to Environment Variable (1 CI failure)
|
||||||
|
|
||||||
|
`test_setup.py` failed intermittently because `PIP_BREAK_SYSTEM_PACKAGES`
|
||||||
|
was set in the CI environment but not in local tests. The test didn't
|
||||||
|
isolate itself from the environment variable.
|
||||||
|
|
||||||
|
**Root cause:** The test assumed a clean environment but CI sets
|
||||||
|
`PIP_BREAK_SYSTEM_PACKAGES=1` globally. The test's behavior changed
|
||||||
|
based on this env var.
|
||||||
|
|
||||||
|
**Time wasted:** ~1 CI run.
|
||||||
|
|
||||||
|
**Fix:** Isolated the test from the env var using `monkeypatch.delenv`.
|
||||||
|
|
||||||
|
**Lesson:** Tests that interact with environment-dependent behavior
|
||||||
|
should explicitly set or unset the relevant env vars, not assume
|
||||||
|
defaults.
|
||||||
|
|
||||||
|
### 4. Missing Translations for New Messages (1 CI failure)
|
||||||
|
|
||||||
|
The self-approval fallback added new user-facing messages (warning
|
||||||
|
about token fallback) but didn't add translations for all supported
|
||||||
|
languages. The translation completeness check caught this.
|
||||||
|
|
||||||
|
**Root cause:** New `click.echo()` calls were added with `_()` wrappers
|
||||||
|
but the translation JSON wasn't updated.
|
||||||
|
|
||||||
|
**Time wasted:** ~1 CI run.
|
||||||
|
|
||||||
|
**Fix:** Added translations for all new messages in `translations.json`.
|
||||||
|
|
||||||
|
**Lesson:** When adding new `_()` wrapped strings, update
|
||||||
|
`translations.json` in the same commit. The i18n check is strict —
|
||||||
|
100% completeness is required.
|
||||||
|
|
||||||
|
## Improvements Implemented
|
||||||
|
|
||||||
|
### 1. Self-Approval Fallback (HIGH impact)
|
||||||
|
|
||||||
|
`pr_review.py` now falls back to `CI_GITEA_API_TOKEN` for APPROVE
|
||||||
|
events when the reviewer token is rejected as self-approval. This
|
||||||
|
unblocked auto-merge across all three repos.
|
||||||
|
|
||||||
|
### 2. Double-Prefix Detection (MEDIUM impact)
|
||||||
|
|
||||||
|
`check_auto_merge_ready.py` now detects and rejects Vikunja task titles
|
||||||
|
that include the identifier prefix (for example, "DEVX-127: Fix...").
|
||||||
|
The validator adds the prefix automatically, so a double prefix would
|
||||||
|
fail validation.
|
||||||
|
|
||||||
|
### 3. CI Workflow Consolidation (MEDIUM impact)
|
||||||
|
|
||||||
|
Merged 7 separate CI jobs into a single `validate` job, reducing runner
|
||||||
|
overhead by ~5 min per CI run and eliminating inter-job dependency
|
||||||
|
issues.
|
||||||
|
|
||||||
|
## Action Items for Future Sessions
|
||||||
|
|
||||||
|
1. **Test API interactions against all relevant HTTP error codes.**
|
||||||
|
Don't only test the happy path. For Gitea: 200, 201, 204, 403, 404,
|
||||||
|
409, 422.
|
||||||
|
2. **Update translations in the same commit as new `_()` strings.**
|
||||||
|
The i18n check will fail otherwise.
|
||||||
|
3. **Isolate tests from environment variables.** Use `monkeypatch.setenv`
|
||||||
|
or `monkeypatch.delenv` for any env var the test's behavior depends on.
|
||||||
|
4. **Ensure automated review bodies are substantive (> 20 chars).**
|
||||||
|
Include a summary of checked categories.
|
||||||
|
5. **When adding fallback logic, test both the fallback-available and
|
||||||
|
fallback-unavailable paths.** Both must be covered for 100% branch
|
||||||
|
coverage.
|
||||||
+71
-54
@@ -6,7 +6,7 @@ from scripts outside the package.
|
|||||||
|
|
||||||
## Package structure
|
## Package structure
|
||||||
|
|
||||||
```
|
```text
|
||||||
src/devx/
|
src/devx/
|
||||||
├── __init__.py # Version (single source of truth, read by setuptools)
|
├── __init__.py # Version (single source of truth, read by setuptools)
|
||||||
├── cli.py # Click-based CLI entry point (devx command)
|
├── cli.py # Click-based CLI entry point (devx command)
|
||||||
@@ -41,6 +41,7 @@ src/devx/
|
|||||||
│ ├── setup.py # Environment setup (venv, deps, hooks, tea login)
|
│ ├── setup.py # Environment setup (venv, deps, hooks, tea login)
|
||||||
│ ├── install_tools.py # Install actionlint, git-cliff, act_runner, tea
|
│ ├── install_tools.py # Install actionlint, git-cliff, act_runner, tea
|
||||||
│ ├── check_test_speed.py # Measure unit test execution time
|
│ ├── check_test_speed.py # Measure unit test execution time
|
||||||
|
│ ├── check_test_isolation.py # Pytest plugin: detect un-hermetic test patterns
|
||||||
│ ├── configure_repo.py # Branch protection and label setup
|
│ ├── configure_repo.py # Branch protection and label setup
|
||||||
│ ├── generate_badges.py # Badge SVG generation
|
│ ├── generate_badges.py # Badge SVG generation
|
||||||
│ ├── generate_cliff_config.py # Generate cliff.toml with correct prefix
|
│ ├── generate_cliff_config.py # Generate cliff.toml with correct prefix
|
||||||
@@ -86,7 +87,7 @@ overridden via environment variables with the `DEVX_` prefix. Provides:
|
|||||||
|
|
||||||
- `GITEA_API_URL` / `VIKUNJA_API_URL` — API endpoints
|
- `GITEA_API_URL` / `VIKUNJA_API_URL` — API endpoints
|
||||||
- `REPO_OWNER` — repository owner (must be set per-project)
|
- `REPO_OWNER` — repository owner (must be set per-project)
|
||||||
- `TASK_PREFIX` / `TASK_ID_RE` — task ID prefix and regex (e.g., `DEVX-N`)
|
- `TASK_PREFIX` / `TASK_ID_RE` — task ID prefix and regex (for example, `DEVX-N`)
|
||||||
- `VIKUNJA_PROJECT_ID` — Vikunja project for task tracking
|
- `VIKUNJA_PROJECT_ID` — Vikunja project for task tracking
|
||||||
- `DEFAULT_TIMEOUT`, `DEFAULT_PER_PAGE` — HTTP client defaults
|
- `DEFAULT_TIMEOUT`, `DEFAULT_PER_PAGE` — HTTP client defaults
|
||||||
- `MAX_RETRIES`, `RETRY_BACKOFF_BASE`, `RETRY_STATUS_CODES` — retry config
|
- `MAX_RETRIES`, `RETRY_BACKOFF_BASE`, `RETRY_STATUS_CODES` — retry config
|
||||||
@@ -103,7 +104,7 @@ Custom exception hierarchy:
|
|||||||
### `i18n.py`
|
### `i18n.py`
|
||||||
|
|
||||||
Simple i18n system using a JSON translations file (`translations.json`).
|
Simple i18n system using a JSON translations file (`translations.json`).
|
||||||
Supports five languages: `en`, `bg`, `de`, `ru`, `zh`. The `_()` function
|
Supports six languages: `en`, `bg`, `de`, `pl`, `ru`, `zh`. The `_()` function
|
||||||
wraps user-facing strings for translation.
|
wraps user-facing strings for translation.
|
||||||
|
|
||||||
Projects can extend translations by setting `DEVX_TRANSLATIONS_PATH` to a
|
Projects can extend translations by setting `DEVX_TRANSLATIONS_PATH` to a
|
||||||
@@ -122,7 +123,9 @@ exponential backoff (2s, 4s, 8s).
|
|||||||
- Labels (list, create, add to issues)
|
- Labels (list, create, add to issues)
|
||||||
- Issues (create, list)
|
- Issues (create, list)
|
||||||
- Pull requests (get commits, merge, create review)
|
- Pull requests (get commits, merge, create review)
|
||||||
- Releases (list)
|
- Releases (list, create idempotent)
|
||||||
|
- Actions (list runs, list jobs, get job logs)
|
||||||
|
- Actions variables (get, set idempotent)
|
||||||
- Wiki pages (list, fetch, create, update, delete)
|
- Wiki pages (list, fetch, create, update, delete)
|
||||||
|
|
||||||
**`VikunjaClient`** — Vikunja REST API wrapper:
|
**`VikunjaClient`** — Vikunja REST API wrapper:
|
||||||
@@ -206,7 +209,7 @@ a layered rule system configured in `pyproject.toml` under
|
|||||||
4. **Default**: user-facing (safe default — any unknown file triggers release)
|
4. **Default**: user-facing (safe default — any unknown file triggers release)
|
||||||
|
|
||||||
Also supports custom tags (orthogonal to release impact) for CI conditional
|
Also supports custom tags (orthogonal to release impact) for CI conditional
|
||||||
execution (e.g., `ansible` tag to trigger molecule tests).
|
execution (for example, `ansible` tag to trigger molecule tests).
|
||||||
|
|
||||||
### `pr_review.py`
|
### `pr_review.py`
|
||||||
|
|
||||||
@@ -309,7 +312,7 @@ from `devx.api_clients`, `devx.config`, and `devx.gitea_cli`.
|
|||||||
### `setup.py`
|
### `setup.py`
|
||||||
|
|
||||||
Project setup: installs Python dependencies (editable mode with extras),
|
Project setup: installs Python dependencies (editable mode with extras),
|
||||||
Ansible Galaxy collections (if `ansible/requirements.yml` exists), pre-commit
|
Ansible Galaxy collections (if `ansible/requirements.yml` exists in the target repo), pre-commit
|
||||||
hooks (pre-commit, commit-msg, pre-push), and configures the `tea` CLI login
|
hooks (pre-commit, commit-msg, pre-push), and configures the `tea` CLI login
|
||||||
profile from `.env`. Supports `--extras` to specify dependency groups,
|
profile from `.env`. Supports `--extras` to specify dependency groups,
|
||||||
`--no-pre-commit` to skip hook installation, and `--no-tea-login` to skip tea
|
`--no-pre-commit` to skip hook installation, and `--no-tea-login` to skip tea
|
||||||
@@ -329,13 +332,22 @@ total suite time must not exceed `--max-seconds` (default: 10s), and no
|
|||||||
individual test may exceed `--max-single-seconds` (default: 0.5s, 0 to
|
individual test may exceed `--max-single-seconds` (default: 0.5s, 0 to
|
||||||
disable). Runs `make test-unit` with `PYTEST_ADDOPTS=--durations=0`.
|
disable). Runs `make test-unit` with `PYTEST_ADDOPTS=--durations=0`.
|
||||||
|
|
||||||
|
### `check_test_isolation.py`
|
||||||
|
|
||||||
|
Pytest plugin (auto-discovered via `pytest11` entry point) that
|
||||||
|
statically analyzes test files for un-hermetic patterns causing slow
|
||||||
|
or flaky tests: unpatched `subprocess.run`/`time.sleep` calls, known
|
||||||
|
subprocess-spawning helpers called without `@patch`, and excessive
|
||||||
|
loop iterations (>100). Also available as a standalone CLI for CI
|
||||||
|
gates and pre-commit hooks. See ADR-0001 for design rationale.
|
||||||
|
|
||||||
### `configure_repo.py`
|
### `configure_repo.py`
|
||||||
|
|
||||||
Configures repository branch protection and labels via the Gitea REST API.
|
Configures repository branch protection and labels via the Gitea REST API.
|
||||||
Sets up master branch protection (required status checks, block on rejected
|
Sets up master branch protection (required status checks, block on rejected
|
||||||
reviews, block on outdated branch) and creates standard labels. Status check
|
reviews, block on outdated branch) and creates standard labels. Status check
|
||||||
contexts are read from `DEVX_STATUS_CHECKS` or default to
|
contexts are read from `DEVX_STATUS_CHECKS` or default to
|
||||||
`CI / quality (pull_request)`.
|
`CI / validate (pull_request)`.
|
||||||
|
|
||||||
### `generate_badges.py`
|
### `generate_badges.py`
|
||||||
|
|
||||||
@@ -432,14 +444,14 @@ v2 failures. Supports loading custom platforms from a JSON file.
|
|||||||
3. **Tool modules** (`devx.tools.*`) may import from `devx.api_clients`,
|
3. **Tool modules** (`devx.tools.*`) may import from `devx.api_clients`,
|
||||||
`devx.config`, `devx.gitea_cli`
|
`devx.config`, `devx.gitea_cli`
|
||||||
4. **Cross-module imports** within `devx.ci.*` or `devx.tools.*` are allowed
|
4. **Cross-module imports** within `devx.ci.*` or `devx.tools.*` are allowed
|
||||||
but must be documented (e.g., `release.py` imports from
|
but must be documented (for example, `release.py` imports from
|
||||||
`classify_changes.py`)
|
`classify_changes.py`)
|
||||||
|
|
||||||
## Data flow
|
## Data flow
|
||||||
|
|
||||||
### PR lifecycle
|
### PR lifecycle
|
||||||
|
|
||||||
```
|
```text
|
||||||
Developer creates Vikunja task (DEVX-N)
|
Developer creates Vikunja task (DEVX-N)
|
||||||
│
|
│
|
||||||
▼
|
▼
|
||||||
@@ -454,13 +466,14 @@ Developer pushes and creates PR (title: "DEVX-N: <vikunja task title>")
|
|||||||
▼
|
▼
|
||||||
CI workflow (ci.yml) triggers:
|
CI workflow (ci.yml) triggers:
|
||||||
│
|
│
|
||||||
├── quality (lint, tests, coverage, test speed, doc coverage,
|
├── validate (single job: quality + detect-changes +
|
||||||
│ translation check, dependency scan, workflow dry-run)
|
│ release-dry-run + pr-review + pre-merge validation)
|
||||||
│
|
│ ├── quality steps (lint, tests, coverage, test speed, doc coverage,
|
||||||
├── detect-changes (classify_changes.py → user-facing or workflow-only)
|
│ │ translation check, dependency scan, workflow dry-run)
|
||||||
│ └── if user-facing → release-dry-run (release.py --dry-run)
|
│ ├── detect-changes (classify_changes.py → user-facing or workflow-only)
|
||||||
│
|
│ │ └── if user-facing → release-dry-run (release.py --dry-run)
|
||||||
├── pr-review (pr_review.py → posts COMMENT or REQUEST_CHANGES)
|
│ ├── pre-merge validation (check_auto_merge_ready.py)
|
||||||
|
│ └── pr-review (pr_review.py → posts COMMENT or REQUEST_CHANGES)
|
||||||
│
|
│
|
||||||
└── auto-merge (auto_merge.py)
|
└── auto-merge (auto_merge.py)
|
||||||
├── validate PR title format
|
├── validate PR title format
|
||||||
@@ -475,56 +488,60 @@ CI workflow (ci.yml) triggers:
|
|||||||
|
|
||||||
### Post-merge flow
|
### Post-merge flow
|
||||||
|
|
||||||
```
|
```text
|
||||||
Push to master (squash-merge commit: "DEVX-N <conventional commit>")
|
Push to master (squash-merge commit: "DEVX-N <conventional commit>")
|
||||||
│
|
│
|
||||||
▼
|
▼
|
||||||
Post-merge workflow (post-merge.yml) triggers:
|
Post-merge workflow (post-merge.yml) triggers:
|
||||||
│
|
│
|
||||||
├── detect-type (detect_release_commit.py)
|
├── detect-and-configure (single job)
|
||||||
│ └── is-release? → skip all jobs except badges
|
│ ├── configure-repo (configure_repo.py)
|
||||||
|
│ ├── detect-type (detect_release_commit.py)
|
||||||
|
│ │ └── is-release? → skip all steps except badges
|
||||||
|
│ └── validate-commit-msg (validate_commit_msg.py --branch master)
|
||||||
│
|
│
|
||||||
├── validate-commit-msg (validate_commit_msg.py --branch master)
|
└── release-and-maintain (needs detect-and-configure)
|
||||||
│
|
├── release (release.py) [skip if release commit or workflow-only]
|
||||||
├── release (release.py)
|
│ ├── classify_changes.py → skip if workflow-only
|
||||||
│ ├── classify_changes.py → skip if workflow-only
|
│ ├── git-cliff → calculate next version
|
||||||
│ ├── git-cliff → calculate next version
|
│ ├── update __version__ in __init__.py
|
||||||
│ ├── update __version__ in __init__.py
|
│ ├── update CHANGELOG.md
|
||||||
│ ├── update CHANGELOG.md
|
│ ├── run make lint-ruff && make pytest-cov
|
||||||
│ ├── run make lint-ruff && make pytest-cov
|
│ ├── commit "release: vX.Y.Z [skip ci]"
|
||||||
│ ├── commit "release: vX.Y.Z [skip ci]"
|
│ ├── create annotated tag vX.Y.Z
|
||||||
│ ├── create annotated tag vX.Y.Z
|
│ └── push commit + tag to master
|
||||||
│ └── push commit + tag to master
|
│ │
|
||||||
│ │
|
│ ▼
|
||||||
│ ▼
|
│ publish (publish.py) [if release created a tag]
|
||||||
│ Tag push triggers publish workflow (see below)
|
│ ├── build package (python -m build)
|
||||||
│
|
│ ├── publish to Gitea PyPI registry (twine upload)
|
||||||
├── sync-wiki (sync_wiki.py --strict)
|
│ │ OR publish to standard PyPI (if PYPI_TOKEN set)
|
||||||
│ └── sync docs/ to Gitea wiki with integrity check
|
│ │ OR skip publish (if --skip-build)
|
||||||
│
|
│ └── create Gitea release with git-cliff notes
|
||||||
├── badges (push_badges.py) [ALWAYS runs, even on release commits]
|
│
|
||||||
│ ├── fetch latest master
|
├── sync-wiki (sync_wiki.py --strict) [skip if automated]
|
||||||
│ ├── generate_badges.py → SVG files
|
│ └── sync docs/ to Gitea wiki with integrity check
|
||||||
│ ├── push to orphan badges branch
|
│
|
||||||
│ └── update README.md + docs/index.md with cache-busting URLs
|
├── vikunja (post_merge.py) [skip if automated]
|
||||||
│
|
│ ├── extract task ID from commit message
|
||||||
├── vikunja (post_merge.py)
|
│ ├── mark Vikunja task as done
|
||||||
│ ├── extract task ID from commit message
|
│ └── post comment with merge SHA
|
||||||
│ ├── mark Vikunja task as done
|
│
|
||||||
│ └── post comment with merge SHA
|
└── badges (push_badges.py) [ALWAYS runs, even on release commits]
|
||||||
│
|
├── fetch latest master
|
||||||
└── configure-repo (configure_repo.py)
|
├── generate_badges.py → SVG files
|
||||||
└── ensure branch protection and labels
|
├── push to orphan badges branch
|
||||||
|
└── update README.md + docs/index.md with cache-busting URLs
|
||||||
```
|
```
|
||||||
|
|
||||||
### Publish flow
|
### Publish flow
|
||||||
|
|
||||||
```
|
```text
|
||||||
Tag push (vX.Y.Z) triggers publish workflow (publish.yml):
|
Within release-and-maintain job (after release step creates a tag):
|
||||||
│
|
│
|
||||||
▼
|
|
||||||
├── install build, twine, git-cliff, tea
|
├── install build, twine, git-cliff, tea
|
||||||
├── configure tea login
|
├── configure tea login
|
||||||
|
├── checkout release tag
|
||||||
│
|
│
|
||||||
└── publish (publish.py)
|
└── publish (publish.py)
|
||||||
├── build package (python -m build)
|
├── build package (python -m build)
|
||||||
@@ -536,7 +553,7 @@ Tag push (vX.Y.Z) triggers publish workflow (publish.yml):
|
|||||||
|
|
||||||
### Badge generation flow
|
### Badge generation flow
|
||||||
|
|
||||||
```
|
```text
|
||||||
push_badges.py:
|
push_badges.py:
|
||||||
│
|
│
|
||||||
├── fetch_latest_master() → git fetch + reset --hard origin/master
|
├── fetch_latest_master() → git fetch + reset --hard origin/master
|
||||||
|
|||||||
+151
-113
@@ -1,32 +1,29 @@
|
|||||||
# CI/CD Workflow
|
# CI/CD Workflow
|
||||||
|
|
||||||
devx uses Gitea Actions for CI/CD automation. Three workflows implement a
|
devx uses Gitea Actions for CI/CD automation. Two workflows implement a
|
||||||
complete pipeline: pull request validation, post-merge release automation, and
|
complete pipeline: pull request validation and post-merge release
|
||||||
tag-triggered publishing.
|
automation (including publishing).
|
||||||
|
|
||||||
## Workflow overview
|
## Workflow overview
|
||||||
|
|
||||||
```
|
```text
|
||||||
PR opened/synchronized ──► CI (ci.yml)
|
PR opened/synchronized ──► CI (ci.yml)
|
||||||
│ ├── quality
|
│ ├── validate (quality + detect-changes +
|
||||||
│ ├── detect-changes
|
│ │ release-dry-run + pr-review +
|
||||||
│ ├── release-dry-run (if user-facing)
|
│ │ pre-merge validation)
|
||||||
│ ├── pr-review
|
|
||||||
│ └── auto-merge ──► squash-merge to master
|
│ └── auto-merge ──► squash-merge to master
|
||||||
│ │
|
│ │
|
||||||
▼ ▼
|
▼ ▼
|
||||||
Push to master ──► Post-merge (post-merge.yml)
|
Push to master ──► Post-merge (post-merge.yml)
|
||||||
├── detect-type
|
├── detect-and-configure (detect-type +
|
||||||
├── validate-commit-msg
|
│ validate-commit-msg +
|
||||||
├── release ──► tag vX.Y.Z
|
│ configure-repo)
|
||||||
├── sync-wiki │
|
└── release-and-maintain
|
||||||
├── badges │
|
├── release ──► tag vX.Y.Z
|
||||||
├── vikunja │
|
├── publish ──► Gitea PyPI registry + Gitea release
|
||||||
└── configure-repo │
|
├── sync-wiki
|
||||||
│
|
├── vikunja
|
||||||
▼
|
└── badges (always runs)
|
||||||
Tag push (v*) ──► Publish (publish.yml)
|
|
||||||
└── publish ──► Gitea PyPI registry + Gitea release
|
|
||||||
```
|
```
|
||||||
|
|
||||||
## CI workflow (`ci.yml`)
|
## CI workflow (`ci.yml`)
|
||||||
@@ -35,9 +32,15 @@ Runs on pull requests (opened and synchronize) and manual dispatch.
|
|||||||
|
|
||||||
### Jobs
|
### Jobs
|
||||||
|
|
||||||
#### `quality`
|
#### `validate`
|
||||||
|
|
||||||
The main quality gate. Runs on every PR:
|
The single validation job. Consolidates the former `quality`,
|
||||||
|
`detect-changes`, `release-dry-run`, `pr-review`, and `pre-merge-check`
|
||||||
|
jobs into one job to save checkout+setup overhead. Runs on every PR.
|
||||||
|
|
||||||
|
**Quality steps**
|
||||||
|
|
||||||
|
The main quality gate:
|
||||||
|
|
||||||
1. **Lint all** — ruff check, ruff format check, pyright, bandit, actionlint
|
1. **Lint all** — ruff check, ruff format check, pyright, bandit, actionlint
|
||||||
(via `make lint-all`)
|
(via `make lint-all`)
|
||||||
@@ -52,21 +55,21 @@ The main quality gate. Runs on every PR:
|
|||||||
7. **Workflow dry-run validation** — `make workflow-dryrun` via act_runner
|
7. **Workflow dry-run validation** — `make workflow-dryrun` via act_runner
|
||||||
(best-effort, skipped if act_runner is not installed)
|
(best-effort, skipped if act_runner is not installed)
|
||||||
|
|
||||||
#### `detect-changes`
|
**`detect-changes` step**
|
||||||
|
|
||||||
Classifies changes between `origin/master` and the PR head as user-facing or
|
Classifies changes between `origin/master` and the PR head as user-facing or
|
||||||
workflow-only using `python -m devx.ci.classify_changes --github-output`.
|
workflow-only using `python -m devx.ci.classify_changes --github-output`.
|
||||||
Writes `user-facing-changed=true|false` to the job output for use by
|
Writes `user-facing-changed=true|false` to the job output for use by
|
||||||
downstream jobs.
|
downstream steps.
|
||||||
|
|
||||||
#### `release-dry-run`
|
**`release-dry-run` step**
|
||||||
|
|
||||||
Depends on `quality` and `detect-changes`. Only runs if user-facing changes
|
Only runs if the detect-changes step detected user-facing changes. Runs
|
||||||
are detected. Runs `python -m devx.ci.release --dry-run` to validate that
|
`python -m devx.ci.release --dry-run` to validate that the release script
|
||||||
the release script can calculate the next version and generate the changelog
|
can calculate the next version and generate the changelog without making
|
||||||
without making changes. Non-blocking (uses `|| true`).
|
changes. Non-blocking (uses `|| true`).
|
||||||
|
|
||||||
#### `pr-review`
|
**`pr-review` step**
|
||||||
|
|
||||||
Runs on every pull request. Executes `python -m devx.ci.pr_review` with the
|
Runs on every pull request. Executes `python -m devx.ci.pr_review` with the
|
||||||
PR number and repository. Fetches the PR diff via the Gitea API and runs
|
PR number and repository. Fetches the PR diff via the Gitea API and runs
|
||||||
@@ -87,13 +90,26 @@ Checks performed:
|
|||||||
7. Test coverage — source changes must include test updates
|
7. Test coverage — source changes must include test updates
|
||||||
8. Commit conventions — conventional commit format on PR commits
|
8. Commit conventions — conventional commit format on PR commits
|
||||||
|
|
||||||
|
**Pre-merge validation step**
|
||||||
|
|
||||||
|
Runs on every pull request. Executes
|
||||||
|
`python -m devx.ci.check_auto_merge_ready` with the branch name, PR title,
|
||||||
|
repository, and PR number. Validates auto-merge preconditions before the
|
||||||
|
`auto-merge` job runs:
|
||||||
|
|
||||||
|
1. **Branch name** — must contain a valid task ID (for example,
|
||||||
|
`DEVX-12-fix-foo` → `DEVX-12`)
|
||||||
|
2. **PR title format** — must be `{PREFIX}-N: <vikunja task title>`
|
||||||
|
3. **Vikunja task** — must exist and the title must match the PR title
|
||||||
|
4. **Branch state** — must not be behind master
|
||||||
|
|
||||||
#### `auto-merge`
|
#### `auto-merge`
|
||||||
|
|
||||||
Depends on `quality`, `detect-changes`, and `pr-review`. The final job in the
|
Depends on `validate`. The final job in the CI workflow. Runs
|
||||||
CI workflow. Runs `python -m devx.ci.auto_merge` with the branch name, PR
|
`python -m devx.ci.auto_merge` with the branch name, PR title, repository,
|
||||||
title, repository, and PR number:
|
and PR number:
|
||||||
|
|
||||||
1. **Read task ID** from branch name (e.g., `DEVX-12-fix-foo` → `DEVX-12`)
|
1. **Read task ID** from branch name (for example, `DEVX-12-fix-foo` → `DEVX-12`)
|
||||||
2. **Validate PR title format** — must be `{PREFIX}-N: <vikunja task title>`
|
2. **Validate PR title format** — must be `{PREFIX}-N: <vikunja task title>`
|
||||||
3. **Validate PR title matches Vikunja task** — fetches the Vikunja task and
|
3. **Validate PR title matches Vikunja task** — fetches the Vikunja task and
|
||||||
compares the title
|
compares the title
|
||||||
@@ -107,8 +123,9 @@ The merge commit push to master triggers the post-merge workflow.
|
|||||||
|
|
||||||
### Smart CI: user-facing vs workflow-only changes
|
### Smart CI: user-facing vs workflow-only changes
|
||||||
|
|
||||||
Not all changes require a new release. The `detect-changes` job classifies
|
Not all changes require a new release. The `detect-changes` step in the
|
||||||
changes using `python -m devx.ci.classify_changes`:
|
`validate` job classifies changes using
|
||||||
|
`python -m devx.ci.classify_changes`:
|
||||||
|
|
||||||
**Workflow-only paths** (infrastructure — no release needed):
|
**Workflow-only paths** (infrastructure — no release needed):
|
||||||
- `.gitea/**` — Gitea Actions workflows
|
- `.gitea/**` — Gitea Actions workflows
|
||||||
@@ -137,55 +154,90 @@ Rule priority (first match wins):
|
|||||||
|
|
||||||
## Post-merge workflow (`post-merge.yml`)
|
## Post-merge workflow (`post-merge.yml`)
|
||||||
|
|
||||||
Runs on every push to master. A single workflow with conditional jobs
|
Runs on every push to master. Consolidated into 2 jobs (from 7) to reduce
|
||||||
replaces separate workflows for release, wiki sync, badges, and Vikunja task
|
runner overhead: `detect-and-configure` (detect-type + validate-commit-msg +
|
||||||
updates.
|
configure-repo) and `release-and-maintain` (release + publish + sync-wiki +
|
||||||
|
badges + vikunja). Individual steps within `release-and-maintain` are
|
||||||
|
conditional on the `detect-and-configure` job's outputs.
|
||||||
|
|
||||||
### Job dependency graph
|
### Job dependency graph
|
||||||
|
|
||||||
```
|
```text
|
||||||
detect-type ──┬── validate-commit-msg (skip if release commit)
|
detect-and-configure
|
||||||
├── release (skip if release commit)
|
├── configure-repo (independent, skip if release commit)
|
||||||
│ │
|
├── detect-type → is-release? is-automated?
|
||||||
│ ├── sync-wiki (needs release)
|
└── validate-commit-msg (skip if release commit)
|
||||||
│ ├── badges (needs release, ALWAYS runs)
|
│
|
||||||
│ └── vikunja (needs release)
|
▼
|
||||||
└── configure-repo (independent, skip if release commit)
|
release-and-maintain (needs detect-and-configure)
|
||||||
|
├── release (skip if release commit or workflow-only)
|
||||||
|
│ └── publish (if release created a tag)
|
||||||
|
├── sync-wiki (skip if automated)
|
||||||
|
├── vikunja (skip if automated)
|
||||||
|
└── badges (always runs)
|
||||||
```
|
```
|
||||||
|
|
||||||
`sync-wiki` and `vikunja` depend on `release` succeeding so that the wiki and
|
`sync-wiki` and `vikunja` run only on non-automated commits (that is, real PR
|
||||||
task tracker are only updated when the code is actually released. If release
|
merges) so that the wiki and task tracker are only updated when a human
|
||||||
fails, they are skipped to avoid leaving the wiki or Vikunja in an
|
change lands. They skip on release commits and automated commits.
|
||||||
inconsistent state.
|
|
||||||
|
|
||||||
The `badges` job uses `if: always()` with no is-release condition so it runs
|
The `badges` step always runs (even on release commits) so badges (tests,
|
||||||
on every push to master, including release commits. This ensures badges
|
coverage, version, etc.) are always current. It runs last so it picks up
|
||||||
(tests, coverage, version, etc.) are always current.
|
any version bump the release step created.
|
||||||
|
|
||||||
When `release` creates a `release: vX.Y.Z` commit, the release commit's
|
When `release` creates a `release: vX.Y.Z` commit, the release commit's
|
||||||
post-merge run still updates badges (the version badge picks up the new
|
post-merge run still updates badges (the version badge picks up the new
|
||||||
version). Other jobs skip. The tag push triggers `publish.yml`.
|
version). Other steps skip. The `publish` step builds and publishes the
|
||||||
|
package to the Gitea PyPI registry within the same `release-and-maintain`
|
||||||
|
job (it checks out the release tag).
|
||||||
|
|
||||||
### Post-merge jobs
|
### Post-merge jobs
|
||||||
|
|
||||||
#### `detect-type`
|
#### `detect-and-configure`
|
||||||
|
|
||||||
|
The first post-merge job. Consolidates the former `detect-type`,
|
||||||
|
`validate-commit-msg`, and `configure-repo` jobs. Outputs `is-release`,
|
||||||
|
`is-automated`, and `user-facing-changed` for the `release-and-maintain`
|
||||||
|
job.
|
||||||
|
|
||||||
|
**`detect-type` step**
|
||||||
|
|
||||||
Checks if the latest commit is a release commit (`release: vX.Y.Z [skip ci]`)
|
Checks if the latest commit is a release commit (`release: vX.Y.Z [skip ci]`)
|
||||||
using `python -m devx.ci.detect_release_commit`. Writes `is-release=true` or
|
using `python -m devx.ci.detect_release_commit`. Writes `is-release=true` or
|
||||||
`is-release=false` to the job output. All subsequent jobs use this to
|
`is-release=false` (and `is-automated`) to the job output. The
|
||||||
conditionally skip for release commits.
|
`release-and-maintain` job uses these to conditionally skip steps for
|
||||||
|
release commits.
|
||||||
|
|
||||||
#### `validate-commit-msg`
|
**`validate-commit-msg` step**
|
||||||
|
|
||||||
Depends on `detect-type`. Skips for release commits. Validates the latest
|
Skips for release/automated commits. Validates the latest commit message
|
||||||
commit message using `python -m devx.ci.validate_commit_msg --branch master`.
|
using `python -m devx.ci.validate_commit_msg --branch master`. On master,
|
||||||
On master, commits must follow `{PREFIX}-N: <conventional commit>` format
|
commits must follow `{PREFIX}-N: <conventional commit>` format (added by
|
||||||
(added by auto-merge).
|
auto-merge).
|
||||||
|
|
||||||
#### `release`
|
**`configure-repo` step**
|
||||||
|
|
||||||
Depends on `detect-type`. Skips for release commits. The core release
|
Ensures branch protection and labels are configured using
|
||||||
automation job. Runs `python -m devx.ci.release`:
|
`python -m devx.tools.configure_repo --repo <name> --owner <owner>`:
|
||||||
|
|
||||||
|
- Sets up master branch protection (required status checks, block on rejected
|
||||||
|
reviews, block on outdated branch)
|
||||||
|
- Creates standard labels
|
||||||
|
- Status check contexts read from `DEVX_STATUS_CHECKS` or default to
|
||||||
|
`CI / validate (pull_request)`
|
||||||
|
|
||||||
|
On failure, the `notify_failure` step creates a Gitea issue.
|
||||||
|
|
||||||
|
#### `release-and-maintain`
|
||||||
|
|
||||||
|
Depends on `detect-and-configure`. The second post-merge job. Consolidates
|
||||||
|
the former `release`, `publish`, `sync-wiki`, `badges`, and `vikunja` jobs.
|
||||||
|
Individual steps are conditional on the `detect-and-configure` job's outputs.
|
||||||
|
|
||||||
|
**`release` step**
|
||||||
|
|
||||||
|
Skips for release commits and workflow-only changes. The core release
|
||||||
|
automation step. Runs `python -m devx.ci.release`:
|
||||||
|
|
||||||
1. **Classify changes** — calls `classify_changes.py` to check for user-facing
|
1. **Classify changes** — calls `classify_changes.py` to check for user-facing
|
||||||
changes. If only infrastructure files changed, exits without releasing.
|
changes. If only infrastructure files changed, exits without releasing.
|
||||||
@@ -205,7 +257,7 @@ automation job. Runs `python -m devx.ci.release`:
|
|||||||
8. **Push** — pushes both the commit and tag to master
|
8. **Push** — pushes both the commit and tag to master
|
||||||
|
|
||||||
The script is idempotent: if there are no new conventional commits since the
|
The script is idempotent: if there are no new conventional commits since the
|
||||||
last tag, it exits without doing anything. If the tag already exists (e.g.,
|
last tag, it exits without doing anything. If the tag already exists (for example,
|
||||||
from a partial previous run), it skips tag creation and only pushes.
|
from a partial previous run), it skips tag creation and only pushes.
|
||||||
|
|
||||||
**Tag consistency**: Before releasing, the script fetches remote tags and
|
**Tag consistency**: Before releasing, the script fetches remote tags and
|
||||||
@@ -225,11 +277,10 @@ tag/version/commit alignment.
|
|||||||
On failure, the `notify_failure` step creates a Gitea issue via
|
On failure, the `notify_failure` step creates a Gitea issue via
|
||||||
`python -m devx.ci.notify_failure`.
|
`python -m devx.ci.notify_failure`.
|
||||||
|
|
||||||
#### `sync-wiki`
|
**`sync-wiki` step**
|
||||||
|
|
||||||
Depends on `detect-type` and `release`. Skips for release commits. Syncs
|
Skips for automated commits. Syncs documentation from `docs/` to the Gitea
|
||||||
documentation from `docs/` to the Gitea wiki using
|
wiki using `python -m devx.ci.sync_wiki --repo <owner/repo> --strict`:
|
||||||
`python -m devx.ci.sync_wiki --repo <owner/repo> --strict`:
|
|
||||||
|
|
||||||
1. Reads `docs/mapping.json` to map file paths to wiki page titles
|
1. Reads `docs/mapping.json` to map file paths to wiki page titles
|
||||||
2. Lists existing wiki pages via the Gitea API
|
2. Lists existing wiki pages via the Gitea API
|
||||||
@@ -243,15 +294,14 @@ deleted).
|
|||||||
|
|
||||||
On failure, the `notify_failure` step creates a Gitea issue.
|
On failure, the `notify_failure` step creates a Gitea issue.
|
||||||
|
|
||||||
#### `badges`
|
**`badges` step**
|
||||||
|
|
||||||
Depends on `detect-type` and `release`. Uses `if: always()` so it runs on
|
Always runs (even on release commits). Generates and pushes quality badges
|
||||||
every push to master, including release commits. Generates and pushes quality
|
using `python -m devx.ci.push_badges`:
|
||||||
badges using `python -m devx.ci.push_badges`:
|
|
||||||
|
|
||||||
1. **Fetch latest master** — `git fetch origin master && git reset --hard
|
1. **Fetch latest master** — `git fetch origin master && git reset --hard
|
||||||
origin/master` (ensures the version badge reflects the current state,
|
origin/master` (ensures the version badge reflects the current state,
|
||||||
even if the release job just pushed a new version)
|
even if the release step recently pushed a new version)
|
||||||
2. **Generate badges** — calls `devx.tools.generate_badges` which runs
|
2. **Generate badges** — calls `devx.tools.generate_badges` which runs
|
||||||
pytest-cov, doc-coverage, lint checks, and version extraction, then writes
|
pytest-cov, doc-coverage, lint checks, and version extraction, then writes
|
||||||
SVG files: `coverage.svg`, `tests.svg`, `docs.svg`, `quality.svg`,
|
SVG files: `coverage.svg`, `tests.svg`, `docs.svg`, `quality.svg`,
|
||||||
@@ -268,11 +318,10 @@ and waits 10s between attempts).
|
|||||||
|
|
||||||
On failure, the `notify_failure` step creates a Gitea issue.
|
On failure, the `notify_failure` step creates a Gitea issue.
|
||||||
|
|
||||||
#### `vikunja`
|
**`vikunja` step**
|
||||||
|
|
||||||
Depends on `detect-type` and `release`. Skips for release commits. Updates
|
Skips for automated commits. Updates the Vikunja task after a merge using
|
||||||
the Vikunja task after a merge using `python -m devx.ci.post_merge --git-sha
|
`python -m devx.ci.post_merge --git-sha <sha>`:
|
||||||
<sha>`:
|
|
||||||
|
|
||||||
1. Extracts the task ID from the first line of the commit message
|
1. Extracts the task ID from the first line of the commit message
|
||||||
2. Marks the corresponding Vikunja task as done
|
2. Marks the corresponding Vikunja task as done
|
||||||
@@ -280,26 +329,11 @@ the Vikunja task after a merge using `python -m devx.ci.post_merge --git-sha
|
|||||||
|
|
||||||
On failure, the `notify_failure` step creates a Gitea issue.
|
On failure, the `notify_failure` step creates a Gitea issue.
|
||||||
|
|
||||||
#### `configure-repo`
|
**`publish` step**
|
||||||
|
|
||||||
Depends on `detect-type`. Skips for release commits. Ensures branch
|
Only runs if the `release` step created a tag. Builds and publishes the
|
||||||
protection and labels are configured using
|
package within the same `release-and-maintain` job (checks out the release
|
||||||
`python -m devx.tools.configure_repo --repo <name> --owner <owner>`:
|
tag). Runs `python -m devx.ci.publish <tag> <owner/repo>`:
|
||||||
|
|
||||||
- Sets up master branch protection (required status checks, block on rejected
|
|
||||||
reviews, block on outdated branch)
|
|
||||||
- Creates standard labels
|
|
||||||
- Status check contexts read from `DEVX_STATUS_CHECKS` or default to
|
|
||||||
`CI / quality (pull_request)`
|
|
||||||
|
|
||||||
On failure, the `notify_failure` step creates a Gitea issue.
|
|
||||||
|
|
||||||
## Publish workflow (`publish.yml`)
|
|
||||||
|
|
||||||
Runs on tag pushes matching `v*`. Triggered by the `release` job in the
|
|
||||||
post-merge workflow when it creates and pushes a new version tag.
|
|
||||||
|
|
||||||
### Job: `publish`
|
|
||||||
|
|
||||||
1. **Install dependencies** — build, twine, requests, python-dotenv, click,
|
1. **Install dependencies** — build, twine, requests, python-dotenv, click,
|
||||||
and the project itself
|
and the project itself
|
||||||
@@ -329,7 +363,7 @@ On failure, the `notify_failure` step creates a Gitea issue.
|
|||||||
### `auto_merge.py`
|
### `auto_merge.py`
|
||||||
|
|
||||||
Auto-merge PR when all CI checks pass. Reads task ID from the branch name
|
Auto-merge PR when all CI checks pass. Reads task ID from the branch name
|
||||||
(e.g., `DEVX-12-fix-foo` → `DEVX-12`). Validates PR title format, checks the
|
(for example, `DEVX-12-fix-foo` → `DEVX-12`). Validates PR title format, checks the
|
||||||
Vikunja task exists and the title matches, extracts the conventional commit
|
Vikunja task exists and the title matches, extracts the conventional commit
|
||||||
message from PR commits, and squash-merges with
|
message from PR commits, and squash-merges with
|
||||||
`{PREFIX}-N <conventional commit>` title.
|
`{PREFIX}-N <conventional commit>` title.
|
||||||
@@ -518,25 +552,29 @@ The complete release process from PR to published package:
|
|||||||
1. **PR merged** — `auto-merge` squash-merges the PR to master with
|
1. **PR merged** — `auto-merge` squash-merges the PR to master with
|
||||||
`{PREFIX}-N <conventional commit>` title
|
`{PREFIX}-N <conventional commit>` title
|
||||||
2. **Post-merge triggers** — the merge push triggers `post-merge.yml`
|
2. **Post-merge triggers** — the merge push triggers `post-merge.yml`
|
||||||
3. **detect-type** — confirms the commit is not a release commit
|
3. **detect-and-configure** — detects release commit, validates commit
|
||||||
4. **release** — `release.py` calculates the next version, updates files,
|
message, and ensures branch protection/labels
|
||||||
runs tests, commits `release: vX.Y.Z [skip ci]`, creates tag `vX.Y.Z`,
|
4. **release** (step in `release-and-maintain`) — `release.py` calculates
|
||||||
and pushes to master
|
the next version, updates files, runs tests, commits
|
||||||
5. **Tag push triggers publish** — the tag push triggers `publish.yml`
|
`release: vX.Y.Z [skip ci]`, creates tag `vX.Y.Z`, and pushes to master
|
||||||
6. **publish** — `publish.py` builds the package, publishes to the Gitea PyPI
|
5. **publish** (step in `release-and-maintain`) — `publish.py` builds the
|
||||||
registry, and creates a Gitea release with git-cliff notes
|
package, publishes to the Gitea PyPI registry, and creates a Gitea
|
||||||
7. **sync-wiki** — documentation is synced to the Gitea wiki
|
release with git-cliff notes (checks out the release tag within the
|
||||||
8. **badges** — quality badges are regenerated and pushed to the `badges`
|
same job)
|
||||||
branch; README and docs/index.md are updated with cache-busting URLs
|
6. **sync-wiki** (step in `release-and-maintain`) — documentation is synced
|
||||||
9. **vikunja** — the corresponding Vikunja task is marked as done
|
to the Gitea wiki
|
||||||
10. **configure-repo** — branch protection and labels are ensured
|
7. **vikunja** (step in `release-and-maintain`) — the corresponding Vikunja
|
||||||
|
task is marked as done
|
||||||
|
8. **badges** (step in `release-and-maintain`) — quality badges are
|
||||||
|
regenerated and pushed to the `badges` branch; README and docs/index.md
|
||||||
|
are updated with cache-busting URLs
|
||||||
|
|
||||||
The release commit's post-merge run skips all jobs except `badges` (which
|
The release commit's post-merge run skips all steps except `badges` (which
|
||||||
picks up the new version number). This prevents infinite loops.
|
picks up the new version number). This prevents infinite loops.
|
||||||
|
|
||||||
## Failure handling
|
## Failure handling
|
||||||
|
|
||||||
Every job in the post-merge and publish workflows has a `notify_failure` step
|
Every job in the CI and post-merge workflows has a `notify_failure` step
|
||||||
that runs `if: failure()`. This creates a Gitea issue with the workflow name,
|
that runs `if: failure()`. This creates a Gitea issue with the workflow name,
|
||||||
run ID, and commit SHA, ensuring failures that would otherwise go unnoticed
|
run ID, and commit SHA, ensuring failures that would otherwise go unnoticed
|
||||||
in the Actions tab are surfaced as issues. The issue is created via the tea
|
in the Actions tab are surfaced as issues. The issue is created via the tea
|
||||||
|
|||||||
@@ -334,6 +334,35 @@ devx tools check-test-speed --max-seconds 10
|
|||||||
devx tools check-test-speed --max-seconds 4 --max-single-seconds 0.5
|
devx tools check-test-speed --max-seconds 4 --max-single-seconds 0.5
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### `devx tools check-test-isolation`
|
||||||
|
|
||||||
|
Statically analyze test files for un-hermetic patterns that cause slow
|
||||||
|
or flaky tests. Also available as a **pytest plugin** (auto-discovered
|
||||||
|
via the `pytest11` entry point when devx is installed — runs
|
||||||
|
automatically on every `pytest` invocation).
|
||||||
|
|
||||||
|
Detected patterns:
|
||||||
|
|
||||||
|
- **unpatched-subprocess**: `subprocess.run/call/Popen/check_call/check_output`
|
||||||
|
called in a test function without `@patch`
|
||||||
|
- **unpatched-sleep**: `time.sleep` called without `@patch`
|
||||||
|
- **unpatched-helper**: known subprocess-spawning helpers (`update_doc_versions`,
|
||||||
|
`run_cmd`, `run_tests`) called without `@patch` or patching their internal deps
|
||||||
|
- **excessive-iterations**: `for _ in range(N)` where N > 100
|
||||||
|
|
||||||
|
```bash
|
||||||
|
devx tools check-test-isolation
|
||||||
|
devx tools check-test-isolation --test-path tests/ --strict
|
||||||
|
devx tools check-test-isolation --categories unpatched-subprocess,unpatched-sleep
|
||||||
|
devx tools check-test-isolation --max-loop-iterations 50
|
||||||
|
```
|
||||||
|
|
||||||
|
Pytest plugin options (automatic when devx is installed):
|
||||||
|
|
||||||
|
- `--strict-test-isolation` — fail the test run on violations
|
||||||
|
- `--no-test-isolation` — disable analysis for this run
|
||||||
|
- `--test-isolation-max-loop N` — max iterations per loop (default: 100)
|
||||||
|
|
||||||
### `devx tools configure-repo`
|
### `devx tools configure-repo`
|
||||||
|
|
||||||
Configure repository: branch protection and labels via the Gitea REST API.
|
Configure repository: branch protection and labels via the Gitea REST API.
|
||||||
@@ -405,7 +434,7 @@ devx tools install-tools --list # list status
|
|||||||
### `devx tools setup`
|
### `devx tools setup`
|
||||||
|
|
||||||
Project setup: install Python dependencies (editable mode with extras),
|
Project setup: install Python dependencies (editable mode with extras),
|
||||||
Ansible Galaxy collections (if `ansible/requirements.yml` exists), pre-commit
|
Ansible Galaxy collections (if `ansible/requirements.yml` exists in the target repo), pre-commit
|
||||||
hooks (pre-commit, commit-msg, pre-push), and configure the tea CLI login
|
hooks (pre-commit, commit-msg, pre-push), and configure the tea CLI login
|
||||||
profile from `.env`.
|
profile from `.env`.
|
||||||
|
|
||||||
@@ -421,6 +450,35 @@ Options:
|
|||||||
- `--no-pre-commit` — skip pre-commit hook installation
|
- `--no-pre-commit` — skip pre-commit hook installation
|
||||||
- `--no-tea-login` — skip tea CLI login configuration
|
- `--no-tea-login` — skip tea CLI login configuration
|
||||||
|
|
||||||
|
### `devx tools rebase`
|
||||||
|
|
||||||
|
Rebase the current branch onto `origin/master` and force-push with
|
||||||
|
`--force-with-lease`. Checks if the branch is behind master first —
|
||||||
|
if up-to-date, exits without doing anything.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
devx tools rebase # rebase + force-push
|
||||||
|
devx tools rebase -- --no-push # rebase locally only
|
||||||
|
```
|
||||||
|
|
||||||
|
Options (pass after `--`):
|
||||||
|
- `--no-push` — rebase locally without pushing
|
||||||
|
|
||||||
|
### `devx tools pr-rebase`
|
||||||
|
|
||||||
|
Rebase a pull request's head branch onto master via the Gitea API
|
||||||
|
(server-side). This triggers a new `pull_request synchronize` event,
|
||||||
|
which starts a new CI run. Useful when you don't have the branch
|
||||||
|
checked out locally.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
devx tools pr-rebase -- --pr 42 # rebase PR #42
|
||||||
|
devx tools pr-rebase # auto-detect PR from current branch
|
||||||
|
```
|
||||||
|
|
||||||
|
Options (pass after `--`):
|
||||||
|
- `--pr <N>` — PR number (auto-detected from current branch if omitted)
|
||||||
|
|
||||||
## Molecule Commands
|
## Molecule Commands
|
||||||
|
|
||||||
Molecule commands require the `molecule` extra (`pip install devx[molecule]`).
|
Molecule commands require the `molecule` extra (`pip install devx[molecule]`).
|
||||||
|
|||||||
@@ -48,12 +48,12 @@ Add devx to your `pyproject.toml`:
|
|||||||
```toml
|
```toml
|
||||||
[project]
|
[project]
|
||||||
dependencies = [
|
dependencies = [
|
||||||
"devx>=0.26.0",
|
"devx>=0.42.0",
|
||||||
]
|
]
|
||||||
|
|
||||||
[project.optional-dependencies]
|
[project.optional-dependencies]
|
||||||
dev = [
|
dev = [
|
||||||
"devx[dev]>=0.26.0",
|
"devx>=0.42.0",
|
||||||
]
|
]
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -72,7 +72,7 @@ tea CLI, etc.) and configure pre-commit hooks.
|
|||||||
|
|
||||||
devx expects a `docs/` directory with at minimum:
|
devx expects a `docs/` directory with at minimum:
|
||||||
|
|
||||||
```
|
```text
|
||||||
docs/
|
docs/
|
||||||
├── index.md # Documentation home page
|
├── index.md # Documentation home page
|
||||||
├── mapping.json # Wiki page title mappings
|
├── mapping.json # Wiki page title mappings
|
||||||
@@ -115,8 +115,8 @@ Add `[tool.devx]` section to `pyproject.toml` for project-specific config:
|
|||||||
vikunja_project_id = 6
|
vikunja_project_id = 6
|
||||||
|
|
||||||
[tool.devx.classify]
|
[tool.devx.classify]
|
||||||
# File patterns that are workflow-only (no release needed)
|
# File patterns that are infrastructure (no release needed)
|
||||||
workflow_only = [
|
infrastructure = [
|
||||||
".gitea/**",
|
".gitea/**",
|
||||||
"docs/**",
|
"docs/**",
|
||||||
"tests/**",
|
"tests/**",
|
||||||
|
|||||||
+11
-3
@@ -1,7 +1,15 @@
|
|||||||
#!/usr/bin/env bash
|
#!/usr/bin/env bash
|
||||||
# pre-commit hook: fail if unit tests are too slow.
|
# pre-commit hook: fast local quality gates that shift-left CI checks.
|
||||||
# Checks both total suite time (10s) and per-test time (0.5s).
|
# Runs test speed, translation completeness, and test isolation checks.
|
||||||
# Aligned with CI (ci.yml uses same thresholds).
|
# All of these run in CI — failing here saves a round-trip.
|
||||||
set -e
|
set -e
|
||||||
export PYTHONPATH=src
|
export PYTHONPATH=src
|
||||||
|
|
||||||
|
# Test speed: total suite < 4s, individual tests < 0.5s
|
||||||
python3 -m devx.tools.check_test_speed --max-seconds 4 --max-single-seconds 0.5
|
python3 -m devx.tools.check_test_speed --max-seconds 4 --max-single-seconds 0.5
|
||||||
|
|
||||||
|
# Translation completeness: missing keys, dead keys, missing languages
|
||||||
|
python3 -m devx.ci.check_translations
|
||||||
|
|
||||||
|
# Test isolation: unpatched subprocess/time.sleep in test functions
|
||||||
|
python3 -m devx.tools.check_test_isolation --test-path tests/
|
||||||
|
|||||||
+33
-7
@@ -25,6 +25,12 @@ dependencies = [
|
|||||||
[project.scripts]
|
[project.scripts]
|
||||||
devx = "devx.cli:cli"
|
devx = "devx.cli:cli"
|
||||||
|
|
||||||
|
# Pytest plugin — auto-discovered by pytest when devx is installed.
|
||||||
|
# Runs static analysis on test files during every pytest invocation
|
||||||
|
# to detect un-hermetic patterns (unpatched subprocess, time.sleep, etc.)
|
||||||
|
[project.entry-points.pytest11]
|
||||||
|
devx_test_isolation = "devx.tools.check_test_isolation"
|
||||||
|
|
||||||
[tool.setuptools.dynamic]
|
[tool.setuptools.dynamic]
|
||||||
version = {attr = "devx.__version__"}
|
version = {attr = "devx.__version__"}
|
||||||
|
|
||||||
@@ -37,7 +43,7 @@ ci = [
|
|||||||
]
|
]
|
||||||
# Lint and type-checking tools (quality job, badge generation)
|
# Lint and type-checking tools (quality job, badge generation)
|
||||||
lint = [
|
lint = [
|
||||||
"ruff==0.15.20",
|
"ruff==0.15.21",
|
||||||
"pyright==1.1.411",
|
"pyright==1.1.411",
|
||||||
"bandit==1.9.4",
|
"bandit==1.9.4",
|
||||||
"pip-audit==2.10.1",
|
"pip-audit==2.10.1",
|
||||||
@@ -45,20 +51,20 @@ lint = [
|
|||||||
]
|
]
|
||||||
# Release tools (build + publish to PyPI/Gitea registry)
|
# Release tools (build + publish to PyPI/Gitea registry)
|
||||||
release = [
|
release = [
|
||||||
"build==1.5.0",
|
"build==1.5.1",
|
||||||
"twine==6.2.0",
|
"twine==6.2.0",
|
||||||
]
|
]
|
||||||
# Molecule testing (for projects with Ansible roles)
|
# Molecule testing (for projects with Ansible roles)
|
||||||
molecule = [
|
molecule = [
|
||||||
"molecule==26.4.0",
|
"molecule==26.6.0",
|
||||||
"molecule-docker==2.1.0",
|
"molecule-docker==2.1.0",
|
||||||
"ansible-lint==26.4.0",
|
"ansible-lint==26.6.0",
|
||||||
"ansible-core==2.21.1",
|
"ansible-core==2.21.1",
|
||||||
]
|
]
|
||||||
# Deploy tools (for infra staging/production deployments)
|
# Deploy tools (for infra staging/production deployments)
|
||||||
deploy = [
|
deploy = [
|
||||||
"ansible-core==2.21.1",
|
"ansible-core==2.21.1",
|
||||||
"boto3==1.43.36",
|
"boto3==1.43.37",
|
||||||
"docker==7.1.0",
|
"docker==7.1.0",
|
||||||
"jinja2==3.1.6",
|
"jinja2==3.1.6",
|
||||||
"pyyaml==6.0.3",
|
"pyyaml==6.0.3",
|
||||||
@@ -67,7 +73,7 @@ deploy = [
|
|||||||
# Full dev environment (local development)
|
# Full dev environment (local development)
|
||||||
dev = [
|
dev = [
|
||||||
"devx[ci,lint,release,molecule]",
|
"devx[ci,lint,release,molecule]",
|
||||||
"build==1.5.0",
|
"build==1.5.1",
|
||||||
"twine==6.2.0",
|
"twine==6.2.0",
|
||||||
]
|
]
|
||||||
|
|
||||||
@@ -80,11 +86,25 @@ devx = ["translations.json", "make/*.mak"]
|
|||||||
[tool.pytest.ini_options]
|
[tool.pytest.ini_options]
|
||||||
testpaths = ["tests"]
|
testpaths = ["tests"]
|
||||||
pythonpath = ["src"]
|
pythonpath = ["src"]
|
||||||
addopts = "--cov=src/devx --cov-report=term-missing --cov-fail-under=100"
|
addopts = "--cov=src/devx --cov-report=term-missing --cov-fail-under=100 -p no:devx_test_isolation"
|
||||||
markers = [
|
markers = [
|
||||||
"integration: marks tests as integration tests (not counted in coverage)",
|
"integration: marks tests as integration tests (not counted in coverage)",
|
||||||
]
|
]
|
||||||
|
|
||||||
|
[tool.coverage.run]
|
||||||
|
# The test isolation pytest plugin (check_test_isolation.py) is loaded
|
||||||
|
# by pytest before coverage instrumentation starts. Coverage config below
|
||||||
|
# excludes decorator lines and pragma-marked code from the coverage check.
|
||||||
|
branch = false
|
||||||
|
|
||||||
|
[tool.coverage.report]
|
||||||
|
exclude_lines = [
|
||||||
|
"pragma: no cover",
|
||||||
|
"if __name__ == .__main__",
|
||||||
|
# Click decorator lines are executed at import time, before coverage
|
||||||
|
"@click\\.command|@click\\.option|@click\\.argument",
|
||||||
|
]
|
||||||
|
|
||||||
[tool.ruff]
|
[tool.ruff]
|
||||||
target-version = "py312"
|
target-version = "py312"
|
||||||
line-length = 120
|
line-length = 120
|
||||||
@@ -121,6 +141,12 @@ vikunja_project_id = 8
|
|||||||
repo_owner = "oblachno-oss"
|
repo_owner = "oblachno-oss"
|
||||||
repo_name = "devx"
|
repo_name = "devx"
|
||||||
|
|
||||||
|
[tool.devx.check_agent_docs]
|
||||||
|
skip_ref_prefixes = [
|
||||||
|
"src/myproject/",
|
||||||
|
"ansible/requirements.yml",
|
||||||
|
]
|
||||||
|
|
||||||
# 3. infrastructure (DEFAULT_INFRASTRUCTURE + project-specific patterns)
|
# 3. infrastructure (DEFAULT_INFRASTRUCTURE + project-specific patterns)
|
||||||
# 4. Default: user-facing (safe)
|
# 4. Default: user-facing (safe)
|
||||||
[tool.devx.classify]
|
[tool.devx.classify]
|
||||||
|
|||||||
@@ -1,3 +1,3 @@
|
|||||||
"""devx — reusable development and CI/CD tools for oblachno-oss projects."""
|
"""devx — reusable development and CI/CD tools for oblachno-oss projects."""
|
||||||
|
|
||||||
__version__ = "0.27.3"
|
__version__ = "0.42.0"
|
||||||
|
|||||||
@@ -194,6 +194,19 @@ class GiteaClient:
|
|||||||
payload = {"Do": "squash", "MergeTitleField": merge_title}
|
payload = {"Do": "squash", "MergeTitleField": merge_title}
|
||||||
self._request("POST", f"/pulls/{pr_number}/merge", json=payload)
|
self._request("POST", f"/pulls/{pr_number}/merge", json=payload)
|
||||||
|
|
||||||
|
def update_pr_branch(self, pr_number: str | int, style: str = "rebase") -> None:
|
||||||
|
"""Update PR head branch by merging/rebasing the base branch into it.
|
||||||
|
|
||||||
|
Uses the Gitea API ``POST /pulls/{index}/update?style=rebase`` endpoint.
|
||||||
|
This rebases the PR's head branch onto the latest base branch server-side,
|
||||||
|
triggering a ``pull_request synchronize`` event that starts a new CI run.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
pr_number: PR number.
|
||||||
|
style: Update method — ``"rebase"`` (default) or ``"merge"``.
|
||||||
|
"""
|
||||||
|
self._request("POST", f"/pulls/{pr_number}/update", params={"style": style})
|
||||||
|
|
||||||
def get_commit_status(self, sha: str) -> list[dict[str, Any]]:
|
def get_commit_status(self, sha: str) -> list[dict[str, Any]]:
|
||||||
"""Fetch all status check contexts reported for a commit.
|
"""Fetch all status check contexts reported for a commit.
|
||||||
|
|
||||||
@@ -359,6 +372,36 @@ class GiteaClient:
|
|||||||
r = self._request("GET", f"/actions/jobs/{job_id}/logs")
|
r = self._request("GET", f"/actions/jobs/{job_id}/logs")
|
||||||
return r.text
|
return r.text
|
||||||
|
|
||||||
|
# -- actions variables (repo-level) --
|
||||||
|
|
||||||
|
def get_repo_variable(self, name: str) -> str | None:
|
||||||
|
"""Read a Gitea Actions repository variable.
|
||||||
|
|
||||||
|
Returns the variable value, or ``None`` if the variable is not set.
|
||||||
|
Raises :class:`APIError` on other HTTP errors.
|
||||||
|
"""
|
||||||
|
try:
|
||||||
|
r = self._request("GET", f"/actions/variables/{name}")
|
||||||
|
return r.json().get("value")
|
||||||
|
except APIError as e:
|
||||||
|
if e.status == 404:
|
||||||
|
return None
|
||||||
|
raise
|
||||||
|
|
||||||
|
def set_repo_variable(self, name: str, value: str) -> None:
|
||||||
|
"""Create or update a Gitea Actions repository variable (idempotent).
|
||||||
|
|
||||||
|
Tries PUT first (update); if the variable doesn't exist (404),
|
||||||
|
creates it via POST. Gitea 1.26.x does not support PATCH for
|
||||||
|
action variables.
|
||||||
|
"""
|
||||||
|
try:
|
||||||
|
self._request("PUT", f"/actions/variables/{name}", json={"value": value})
|
||||||
|
except APIError as e:
|
||||||
|
if e.status != 404:
|
||||||
|
raise
|
||||||
|
self._request("POST", f"/actions/variables/{name}", json={"value": value})
|
||||||
|
|
||||||
|
|
||||||
class VikunjaClient:
|
class VikunjaClient:
|
||||||
"""Low-level Vikunja REST API client with connection pooling."""
|
"""Low-level Vikunja REST API client with connection pooling."""
|
||||||
|
|||||||
+50
-21
@@ -17,10 +17,9 @@ This allows the PR title to be a human-friendly Vikunja task title
|
|||||||
while the squashed commit follows conventional commits.
|
while the squashed commit follows conventional commits.
|
||||||
|
|
||||||
Usage:
|
Usage:
|
||||||
CI_GITEA_TOKEN=<token> python3 -m devx.ci.auto_merge <branch> <pr_title> <repo> <pr_number>
|
CI_GITEA_API_TOKEN=<token> VIKUNJA_TOKEN=<token> python3 -m devx.ci.auto_merge <branch> <pr_title> <repo> <pr_number>
|
||||||
"""
|
"""
|
||||||
|
|
||||||
import os
|
|
||||||
import re
|
import re
|
||||||
from pathlib import Path
|
from pathlib import Path
|
||||||
from typing import Any
|
from typing import Any
|
||||||
@@ -40,6 +39,10 @@ from devx.config import (
|
|||||||
)
|
)
|
||||||
from devx.exceptions import APIError
|
from devx.exceptions import APIError
|
||||||
from devx.i18n import _
|
from devx.i18n import _
|
||||||
|
from devx.tokens import get_ci_token, get_vikunja_token
|
||||||
|
|
||||||
|
# Strip leading task ID prefix (e.g. "DEVX-12: " or "OBL-INFRA-364: ") from commit subjects.
|
||||||
|
_TASK_ID_PREFIX_RE = re.compile(rf"^{TASK_PREFIX}-\d+:\s*")
|
||||||
|
|
||||||
TASKID_FILE = ".taskid" # Deprecated, kept for backward-compat warnings
|
TASKID_FILE = ".taskid" # Deprecated, kept for backward-compat warnings
|
||||||
PR_TITLE_RE = re.compile(rf"^{TASK_PREFIX}-\d+:\s+.+")
|
PR_TITLE_RE = re.compile(rf"^{TASK_PREFIX}-\d+:\s+.+")
|
||||||
@@ -112,9 +115,12 @@ def get_vikunja_task_title(task_id: str) -> str:
|
|||||||
|
|
||||||
Raises ClickException if VIKUNJA_TOKEN is not set or the task is not found.
|
Raises ClickException if VIKUNJA_TOKEN is not set or the task is not found.
|
||||||
"""
|
"""
|
||||||
token = os.environ.get("VIKUNJA_TOKEN", "")
|
try:
|
||||||
if not token:
|
token = get_vikunja_token()
|
||||||
raise click.ClickException(_("VIKUNJA_TOKEN is not set. This is required in CI to validate PR titles."))
|
except click.ClickException:
|
||||||
|
raise click.ClickException(
|
||||||
|
_("VIKUNJA_TOKEN is not set. This is required in CI to validate PR titles.")
|
||||||
|
) from None
|
||||||
client = VikunjaClient(VIKUNJA_API_URL, token)
|
client = VikunjaClient(VIKUNJA_API_URL, token)
|
||||||
page = 1
|
page = 1
|
||||||
while True:
|
while True:
|
||||||
@@ -168,19 +174,23 @@ def extract_conventional_msg(commits: list[dict[str, Any]]) -> str:
|
|||||||
for commit in reversed(commits):
|
for commit in reversed(commits):
|
||||||
commit_info = commit.get("commit", {})
|
commit_info = commit.get("commit", {})
|
||||||
message = str(commit_info.get("message", "") if isinstance(commit_info, dict) else "").split("\n")[0]
|
message = str(commit_info.get("message", "") if isinstance(commit_info, dict) else "").split("\n")[0]
|
||||||
m = CONVENTIONAL_RE.match(message)
|
# Strip any leading task ID prefix (e.g. "OBL-INFRA-364: fix: ...") so
|
||||||
|
# conventional commit matching works on the remainder.
|
||||||
|
stripped = _TASK_ID_PREFIX_RE.sub("", message)
|
||||||
|
m = CONVENTIONAL_RE.match(stripped)
|
||||||
if m:
|
if m:
|
||||||
prefix = m.group(1).split("(")[0].strip() # e.g. "feat" from "feat(scope)"
|
prefix = m.group(1).split("(")[0].strip() # e.g. "feat" from "feat(scope)"
|
||||||
score = priority.get(prefix, 0)
|
score = priority.get(prefix, 0)
|
||||||
if score > best_score:
|
if score > best_score:
|
||||||
best_score = score
|
best_score = score
|
||||||
best_msg = message
|
best_msg = stripped
|
||||||
if best_msg:
|
if best_msg:
|
||||||
return best_msg
|
return best_msg
|
||||||
# Fallback: use the newest commit's first line
|
# Fallback: use the newest commit's first line (strip task ID prefix if present)
|
||||||
if commits:
|
if commits:
|
||||||
commit_info = commits[-1].get("commit", {})
|
commit_info = commits[-1].get("commit", {})
|
||||||
return str(commit_info.get("message", "") if isinstance(commit_info, dict) else "").split("\n")[0]
|
raw = str(commit_info.get("message", "") if isinstance(commit_info, dict) else "").split("\n")[0]
|
||||||
|
return _TASK_ID_PREFIX_RE.sub("", raw)
|
||||||
return ""
|
return ""
|
||||||
|
|
||||||
|
|
||||||
@@ -190,9 +200,10 @@ def extract_conventional_msg(commits: list[dict[str, Any]]) -> str:
|
|||||||
@click.argument("repo")
|
@click.argument("repo")
|
||||||
@click.argument("pr_number")
|
@click.argument("pr_number")
|
||||||
def main(branch: str, pr_title: str, repo: str, pr_number: str) -> None:
|
def main(branch: str, pr_title: str, repo: str, pr_number: str) -> None:
|
||||||
token = os.environ.get("CI_GITEA_TOKEN", "")
|
try:
|
||||||
if not token:
|
token = get_ci_token()
|
||||||
raise click.ClickException(_("ERROR: CI_GITEA_TOKEN is not set."))
|
except click.ClickException:
|
||||||
|
raise click.ClickException(_("ERROR: CI_GITEA_TOKEN is not set.")) from None
|
||||||
|
|
||||||
# Validate PR number is an integer
|
# Validate PR number is an integer
|
||||||
try:
|
try:
|
||||||
@@ -231,17 +242,35 @@ def main(branch: str, pr_title: str, repo: str, pr_number: str) -> None:
|
|||||||
client.merge_pr(pr_num, merge_title)
|
client.merge_pr(pr_num, merge_title)
|
||||||
except APIError as e:
|
except APIError as e:
|
||||||
if e.status == 405 and "behind" in e.message.lower():
|
if e.status == 405 and "behind" in e.message.lower():
|
||||||
# Head branch is behind master — do NOT auto-rebase.
|
# Head branch is behind master. Auto-rebase via Gitea API.
|
||||||
# Auto-rebasing creates a feedback loop: the force-push triggers
|
# This triggers a new pull_request synchronize event → new CI run.
|
||||||
# a new pull_request synchronize event, which starts a new CI run,
|
# The next auto-merge attempt will find the branch up-to-date and
|
||||||
# which runs auto-merge again, which rebases again, etc.
|
# merge successfully. This is NOT an infinite loop: the rebase
|
||||||
raise click.ClickException(
|
# resolves the "behind" condition, so the next run merges.
|
||||||
|
# If another PR merges in between, the branch may fall behind
|
||||||
|
# again, but the process converges as PRs stop merging.
|
||||||
|
click.echo(
|
||||||
_(
|
_(
|
||||||
"Branch is behind master. Rebase manually:\n"
|
"Branch is behind master. Auto-rebasing via Gitea API...\n"
|
||||||
" git fetch origin master && git rebase origin/master && git push --force-with-lease\n"
|
"A new CI run will start automatically after the rebase.\n"
|
||||||
"Then re-add the ready-to-merge label.",
|
"The next auto-merge attempt will merge this PR.",
|
||||||
)
|
)
|
||||||
) from None
|
)
|
||||||
|
try:
|
||||||
|
client.update_pr_branch(pr_num, style="rebase")
|
||||||
|
except APIError as rebase_err:
|
||||||
|
raise click.ClickException(
|
||||||
|
_(
|
||||||
|
"Auto-rebase failed with HTTP {status}: {message}\n"
|
||||||
|
"Rebase manually:\n"
|
||||||
|
" git fetch origin master && git rebase origin/master && git push --force-with-lease\n"
|
||||||
|
"Then re-add the ready-to-merge label.",
|
||||||
|
status=rebase_err.status,
|
||||||
|
message=rebase_err.message,
|
||||||
|
)
|
||||||
|
) from None
|
||||||
|
# Exit cleanly — the rebase triggers a new CI run that will retry.
|
||||||
|
return
|
||||||
else:
|
else:
|
||||||
raise click.ClickException(
|
raise click.ClickException(
|
||||||
_(
|
_(
|
||||||
|
|||||||
@@ -15,7 +15,7 @@ Exit code 1 = NOT ready — fix issues before pushing.
|
|||||||
|
|
||||||
Usage::
|
Usage::
|
||||||
|
|
||||||
# CI (with VIKUNJA_TOKEN and CI_GITEA_TOKEN):
|
# CI (with VIKUNJA_TOKEN and CI_GITEA_API_TOKEN):
|
||||||
python3 -m devx.ci.check_auto_merge_ready \\
|
python3 -m devx.ci.check_auto_merge_ready \\
|
||||||
--branch "$HEAD_REF" \\
|
--branch "$HEAD_REF" \\
|
||||||
--pr-title "$PR_TITLE" \\
|
--pr-title "$PR_TITLE" \\
|
||||||
@@ -34,13 +34,12 @@ skipped (with a warning) — this allows local pre-push hooks to run
|
|||||||
without CI secrets. In CI, the token is always set and the check is
|
without CI secrets. In CI, the token is always set and the check is
|
||||||
mandatory.
|
mandatory.
|
||||||
|
|
||||||
If ``CI_GITEA_TOKEN`` is not set and ``--pr-number`` is not provided, only
|
If ``CI_GITEA_API_TOKEN`` is not set and ``--pr-number`` is not provided, only
|
||||||
branch-name and PR-title-format checks run (local mode).
|
branch-name and PR-title-format checks run (local mode).
|
||||||
"""
|
"""
|
||||||
|
|
||||||
from __future__ import annotations
|
from __future__ import annotations
|
||||||
|
|
||||||
import os
|
|
||||||
import subprocess # nosec B404
|
import subprocess # nosec B404
|
||||||
|
|
||||||
import click
|
import click
|
||||||
@@ -55,6 +54,7 @@ from devx.config import (
|
|||||||
)
|
)
|
||||||
from devx.exceptions import APIError
|
from devx.exceptions import APIError
|
||||||
from devx.i18n import _
|
from devx.i18n import _
|
||||||
|
from devx.tokens import get_ci_token, get_vikunja_token
|
||||||
|
|
||||||
load_dotenv()
|
load_dotenv()
|
||||||
|
|
||||||
@@ -99,10 +99,13 @@ def is_branch_behind_master(branch: str) -> bool:
|
|||||||
def get_pr_title_from_gitea(repo: str, pr_number: int) -> str | None:
|
def get_pr_title_from_gitea(repo: str, pr_number: int) -> str | None:
|
||||||
"""Fetch the PR title from the Gitea API.
|
"""Fetch the PR title from the Gitea API.
|
||||||
|
|
||||||
Returns ``None`` if ``CI_GITEA_TOKEN`` is not set or the PR cannot be fetched.
|
Returns ``None`` if no token is set or the PR cannot be fetched.
|
||||||
"""
|
"""
|
||||||
token = os.environ.get("CI_GITEA_TOKEN", "")
|
try:
|
||||||
if not token or "/" not in repo:
|
token = get_ci_token()
|
||||||
|
except click.ClickException:
|
||||||
|
return None
|
||||||
|
if "/" not in repo:
|
||||||
return None
|
return None
|
||||||
owner, repo_name = repo.split("/", 1)
|
owner, repo_name = repo.split("/", 1)
|
||||||
client = GiteaClient(GITEA_API_URL, token, owner, repo_name)
|
client = GiteaClient(GITEA_API_URL, token, owner, repo_name)
|
||||||
@@ -120,8 +123,9 @@ def get_vikunja_title_optional(task_id: str) -> str | None:
|
|||||||
raise when ``VIKUNJA_TOKEN`` is missing — it returns ``None`` so the
|
raise when ``VIKUNJA_TOKEN`` is missing — it returns ``None`` so the
|
||||||
caller can skip the check in local mode.
|
caller can skip the check in local mode.
|
||||||
"""
|
"""
|
||||||
token = os.environ.get("VIKUNJA_TOKEN", "")
|
try:
|
||||||
if not token:
|
token = get_vikunja_token()
|
||||||
|
except click.ClickException:
|
||||||
return None
|
return None
|
||||||
client = VikunjaClient(VIKUNJA_API_URL, token)
|
client = VikunjaClient(VIKUNJA_API_URL, token)
|
||||||
from devx.config import DEFAULT_PER_PAGE
|
from devx.config import DEFAULT_PER_PAGE
|
||||||
@@ -221,7 +225,11 @@ def cli(
|
|||||||
if not skip_vikunja:
|
if not skip_vikunja:
|
||||||
vikunja_title = get_vikunja_title_optional(task_id)
|
vikunja_title = get_vikunja_title_optional(task_id)
|
||||||
if vikunja_title is None:
|
if vikunja_title is None:
|
||||||
token_set = bool(os.environ.get("VIKUNJA_TOKEN", ""))
|
try:
|
||||||
|
get_vikunja_token()
|
||||||
|
token_set = True
|
||||||
|
except click.ClickException:
|
||||||
|
token_set = False
|
||||||
if token_set:
|
if token_set:
|
||||||
errors.append(
|
errors.append(
|
||||||
_(
|
_(
|
||||||
@@ -233,17 +241,33 @@ def cli(
|
|||||||
else:
|
else:
|
||||||
click.echo("[pre-merge-check] WARNING: VIKUNJA_TOKEN not set — skipping Vikunja title match check.")
|
click.echo("[pre-merge-check] WARNING: VIKUNJA_TOKEN not set — skipping Vikunja title match check.")
|
||||||
else:
|
else:
|
||||||
expected = f"{task_id}: {vikunja_title}"
|
# Defensive check: warn if the Vikunja task title already includes
|
||||||
if pr_title != expected:
|
# the task ID prefix. The expected PR title is
|
||||||
|
# f"{task_id}: {vikunja_title}" — if vikunja_title already starts
|
||||||
|
# with "{task_id}:", the PR title will have a double prefix.
|
||||||
|
if vikunja_title.startswith(f"{task_id}:"):
|
||||||
errors.append(
|
errors.append(
|
||||||
_(
|
_(
|
||||||
"PR title does not match Vikunja task title.\n Expected: {expected}\n Got: {title}",
|
"Vikunja task title '{title}' starts with '{prefix}:'. "
|
||||||
expected=expected,
|
"The task title should NOT include the '{prefix}' prefix — "
|
||||||
title=pr_title,
|
"it is automatically added to the PR title. "
|
||||||
|
"Update the Vikunja task title to remove the prefix.",
|
||||||
|
title=vikunja_title,
|
||||||
|
prefix=task_id,
|
||||||
),
|
),
|
||||||
)
|
)
|
||||||
else:
|
else:
|
||||||
click.echo(f"[pre-merge-check] Vikunja title match OK: {expected}")
|
expected = f"{task_id}: {vikunja_title}"
|
||||||
|
if pr_title != expected:
|
||||||
|
errors.append(
|
||||||
|
_(
|
||||||
|
"PR title does not match Vikunja task title.\n Expected: {expected}\n Got: {title}",
|
||||||
|
expected=expected,
|
||||||
|
title=pr_title,
|
||||||
|
),
|
||||||
|
)
|
||||||
|
else:
|
||||||
|
click.echo(f"[pre-merge-check] Vikunja title match OK: {expected}")
|
||||||
|
|
||||||
# 6. Branch behind master (skip if --skip-behind-check)
|
# 6. Branch behind master (skip if --skip-behind-check)
|
||||||
if not skip_behind_check:
|
if not skip_behind_check:
|
||||||
|
|||||||
@@ -185,7 +185,7 @@ def main(translations: tuple[Path, ...], source_dir: str | None) -> None:
|
|||||||
# Try common locations
|
# Try common locations
|
||||||
candidates = [
|
candidates = [
|
||||||
root / "src" / "devx" / "translations.json",
|
root / "src" / "devx" / "translations.json",
|
||||||
root / "src" / "gitea_runner_manager" / "translations.json",
|
root / "src" / "grm" / "translations.json",
|
||||||
]
|
]
|
||||||
# Also search for any translations.json in src/
|
# Also search for any translations.json in src/
|
||||||
for match in root.glob("src/*/translations.json"):
|
for match in root.glob("src/*/translations.json"):
|
||||||
|
|||||||
@@ -1,7 +1,10 @@
|
|||||||
#!/usr/bin/env python3
|
#!/usr/bin/env python3
|
||||||
"""Detect whether the latest git commit is a release commit.
|
"""Detect whether the latest git commit is an automated CI commit.
|
||||||
|
|
||||||
Release commits have the format ``release: vX.Y.Z``.
|
Release commits have the format ``release: vX.Y.Z``.
|
||||||
|
Badge commits have the format ``chore: update badge URLs ... [skip ci]``.
|
||||||
|
Both are generated by CI and should skip post-merge jobs.
|
||||||
|
|
||||||
This script writes ``is-release=true`` or ``is-release=false`` to
|
This script writes ``is-release=true`` or ``is-release=false`` to
|
||||||
``$GITHUB_OUTPUT`` for use in CI workflow conditionals.
|
``$GITHUB_OUTPUT`` for use in CI workflow conditionals.
|
||||||
|
|
||||||
@@ -21,6 +24,7 @@ from devx.ci._shared import write_github_output
|
|||||||
from devx.i18n import _
|
from devx.i18n import _
|
||||||
|
|
||||||
RELEASE_RE = re.compile(r"^release: v\d+\.\d+\.\d+")
|
RELEASE_RE = re.compile(r"^release: v\d+\.\d+\.\d+")
|
||||||
|
BADGE_RE = re.compile(r"^chore: update badge URLs.*\[skip ci\]")
|
||||||
|
|
||||||
|
|
||||||
def get_commit_message() -> str:
|
def get_commit_message() -> str:
|
||||||
@@ -41,15 +45,29 @@ def is_release_commit(message: str) -> bool:
|
|||||||
return bool(RELEASE_RE.match(message))
|
return bool(RELEASE_RE.match(message))
|
||||||
|
|
||||||
|
|
||||||
|
def is_badge_commit(message: str) -> bool:
|
||||||
|
"""Check if a commit message matches the badge commit format."""
|
||||||
|
return bool(BADGE_RE.match(message))
|
||||||
|
|
||||||
|
|
||||||
|
def is_automated_commit(message: str) -> bool:
|
||||||
|
"""Check if a commit is an automated CI commit (release or badge)."""
|
||||||
|
return is_release_commit(message) or is_badge_commit(message)
|
||||||
|
|
||||||
|
|
||||||
@click.command()
|
@click.command()
|
||||||
def main() -> None:
|
def main() -> None:
|
||||||
"""Detect if the latest commit is a release commit and set GITHUB_OUTPUT."""
|
"""Detect if the latest commit is an automated CI commit and set GITHUB_OUTPUT."""
|
||||||
msg = get_commit_message()
|
msg = get_commit_message()
|
||||||
click.echo(_("Commit message: {msg}", msg=msg))
|
click.echo(_("Commit message: {msg}", msg=msg))
|
||||||
is_release = is_release_commit(msg)
|
is_release = is_release_commit(msg)
|
||||||
|
is_automated = is_automated_commit(msg)
|
||||||
write_github_output("is-release", "true" if is_release else "false")
|
write_github_output("is-release", "true" if is_release else "false")
|
||||||
|
write_github_output("is-automated", "true" if is_automated else "false")
|
||||||
if is_release:
|
if is_release:
|
||||||
click.echo(_("Release commit — skipping all post-merge jobs."))
|
click.echo(_("Release commit — skipping all post-merge jobs."))
|
||||||
|
elif is_automated:
|
||||||
|
click.echo(_("Automated CI commit (badge) — skipping post-merge jobs."))
|
||||||
else:
|
else:
|
||||||
click.echo(_("Regular merge commit — running all post-merge jobs."))
|
click.echo(_("Regular merge commit — running all post-merge jobs."))
|
||||||
|
|
||||||
|
|||||||
@@ -31,6 +31,7 @@ import requests
|
|||||||
|
|
||||||
from devx.config import GITEA_API_URL, REPO_NAME, REPO_OWNER
|
from devx.config import GITEA_API_URL, REPO_NAME, REPO_OWNER
|
||||||
from devx.i18n import _
|
from devx.i18n import _
|
||||||
|
from devx.tokens import get_ci_token
|
||||||
|
|
||||||
DEFAULT_MAX_RUNNERS = 3
|
DEFAULT_MAX_RUNNERS = 3
|
||||||
|
|
||||||
@@ -96,7 +97,7 @@ def query_runners(api_url: str, token: str, owner: str, repo: str) -> int:
|
|||||||
return total
|
return total
|
||||||
|
|
||||||
|
|
||||||
def get_runner_count(api_url: str, token: str, owner: str, repo: str) -> int:
|
def get_runner_count(api_url: str, token: str | None, owner: str, repo: str) -> int:
|
||||||
"""Determine the number of available runners.
|
"""Determine the number of available runners.
|
||||||
|
|
||||||
Tries the Gitea API first, then falls back to env vars, then default.
|
Tries the Gitea API first, then falls back to env vars, then default.
|
||||||
@@ -152,7 +153,10 @@ def main(
|
|||||||
output_indices: bool,
|
output_indices: bool,
|
||||||
github_output: bool,
|
github_output: bool,
|
||||||
) -> None:
|
) -> None:
|
||||||
token = os.environ.get("CI_GITEA_TOKEN", "")
|
try:
|
||||||
|
token = get_ci_token()
|
||||||
|
except click.ClickException:
|
||||||
|
token = None
|
||||||
|
|
||||||
if owner is None:
|
if owner is None:
|
||||||
owner = os.environ.get("DEVX_REPO_OWNER", "") or REPO_OWNER
|
owner = os.environ.get("DEVX_REPO_OWNER", "") or REPO_OWNER
|
||||||
|
|||||||
@@ -7,7 +7,7 @@ ordering, then assigned to *max_runners* groups using LPT (Longest
|
|||||||
Processing Time first) scheduling.
|
Processing Time first) scheduling.
|
||||||
|
|
||||||
Each item is a string (e.g. an Ansible ``--limit`` pattern like
|
Each item is a string (e.g. an Ansible ``--limit`` pattern like
|
||||||
``observability`` or ``infra-314-vm``). Optionally, items can be objects
|
``observability`` or ``customer-1-vm``). Optionally, items can be objects
|
||||||
with ``{"id": "...", "weight": N}`` to provide explicit weights.
|
with ``{"id": "...", "weight": N}`` to provide explicit weights.
|
||||||
|
|
||||||
The assigned group for *runner_index* is written to ``$GITHUB_ENV`` as
|
The assigned group for *runner_index* is written to ``$GITHUB_ENV`` as
|
||||||
@@ -15,7 +15,7 @@ The assigned group for *runner_index* is written to ``$GITHUB_ENV`` as
|
|||||||
|
|
||||||
Usage::
|
Usage::
|
||||||
|
|
||||||
echo '["observability", "infra-314-vm"]' | \\
|
echo '["observability", "customer-1-vm"]' | \\
|
||||||
python3 -m devx.ci.distribute_items \\
|
python3 -m devx.ci.distribute_items \\
|
||||||
--runner-index 1 --max-runners 3 \\
|
--runner-index 1 --max-runners 3 \\
|
||||||
--github-env --skip-if-excess
|
--github-env --skip-if-excess
|
||||||
|
|||||||
@@ -21,6 +21,7 @@ from pathlib import Path
|
|||||||
|
|
||||||
import click
|
import click
|
||||||
|
|
||||||
|
from devx.config import _load_pyproject_devx
|
||||||
from devx.i18n import _
|
from devx.i18n import _
|
||||||
|
|
||||||
# Default to the current working directory (consuming repo's root)
|
# Default to the current working directory (consuming repo's root)
|
||||||
@@ -71,12 +72,30 @@ def extract_cli_commands(source_dir: Path) -> list[str]:
|
|||||||
# Matches @cli.command, @ci.command, @tools.command, @molecule.command
|
# Matches @cli.command, @ci.command, @tools.command, @molecule.command
|
||||||
for match in re.finditer(r"@\w+\.command\b", content):
|
for match in re.finditer(r"@\w+\.command\b", content):
|
||||||
# Check for explicit name="..." in the decorator arguments
|
# Check for explicit name="..." in the decorator arguments
|
||||||
decorator_end = content.find(")", match.start())
|
# Use a balanced paren search to find the end of the decorator
|
||||||
|
# (handles nested parens like @cli.command(help=_("...")))
|
||||||
|
depth = 0
|
||||||
|
decorator_end = match.start()
|
||||||
|
for i in range(match.start(), len(content)):
|
||||||
|
if content[i] == "(":
|
||||||
|
depth += 1
|
||||||
|
elif content[i] == ")":
|
||||||
|
depth -= 1
|
||||||
|
if depth == 0:
|
||||||
|
decorator_end = i
|
||||||
|
break
|
||||||
decorator_text = content[match.start() : decorator_end + 1]
|
decorator_text = content[match.start() : decorator_end + 1]
|
||||||
name_match = re.search(r'["\']([^"\']+)["\']', decorator_text)
|
# Look for explicit name="..." parameter (not help=, not other kwargs)
|
||||||
|
name_match = re.search(r'\bname\s*=\s*["\']([^"\']+)["\']', decorator_text)
|
||||||
if name_match:
|
if name_match:
|
||||||
commands.append(name_match.group(1))
|
commands.append(name_match.group(1))
|
||||||
continue
|
continue
|
||||||
|
# Look for a positional string argument (e.g. @cli.command("my-cmd"))
|
||||||
|
# but skip if the only strings are in help= or other keyword args
|
||||||
|
positional_match = re.search(r'@\w+\.command\s*\(\s*["\']([^"\']+)["\']', decorator_text)
|
||||||
|
if positional_match:
|
||||||
|
commands.append(positional_match.group(1))
|
||||||
|
continue
|
||||||
# Find the next def statement after this decorator
|
# Find the next def statement after this decorator
|
||||||
after = content[decorator_end:]
|
after = content[decorator_end:]
|
||||||
def_match = re.search(r"def\s+(\w+)\s*\(", after)
|
def_match = re.search(r"def\s+(\w+)\s*\(", after)
|
||||||
@@ -106,16 +125,38 @@ def check_module_documented(module: str, docs_content: str) -> bool:
|
|||||||
@click.command()
|
@click.command()
|
||||||
@click.option("--docs-dir", default=None, help="Path to the docs directory (default: ./docs).")
|
@click.option("--docs-dir", default=None, help="Path to the docs directory (default: ./docs).")
|
||||||
@click.option("--source-dir", default=None, help="Path to the source directory (default: auto-detect from src/).")
|
@click.option("--source-dir", default=None, help="Path to the source directory (default: auto-detect from src/).")
|
||||||
|
@click.option(
|
||||||
|
"--ci-scripts-dir",
|
||||||
|
default=None,
|
||||||
|
help=(
|
||||||
|
"Path to CI scripts directory (default: auto-detect from src/ci/). "
|
||||||
|
"Set to empty string to skip CI script checks."
|
||||||
|
),
|
||||||
|
)
|
||||||
@click.option(
|
@click.option(
|
||||||
"--fail-on-missing",
|
"--fail-on-missing",
|
||||||
is_flag=True,
|
is_flag=True,
|
||||||
default=False,
|
default=False,
|
||||||
help="Exit with non-zero status if any documentation is missing.",
|
help="Exit with non-zero status if any documentation is missing.",
|
||||||
)
|
)
|
||||||
def main(docs_dir: str | None, source_dir: str | None, fail_on_missing: bool) -> None:
|
def main(docs_dir: str | None, source_dir: str | None, ci_scripts_dir: str | None, fail_on_missing: bool) -> None:
|
||||||
root = Path.cwd()
|
root = Path.cwd()
|
||||||
docs_path = Path(docs_dir) if docs_dir else root / "docs"
|
docs_path = Path(docs_dir) if docs_dir else root / "docs"
|
||||||
|
|
||||||
|
# Read [tool.devx.doc_coverage] config from pyproject.toml
|
||||||
|
devx_cfg = _load_pyproject_devx()
|
||||||
|
doc_cov_cfg_raw: object = devx_cfg.get("doc_coverage", {}) if isinstance(devx_cfg, dict) else {}
|
||||||
|
doc_cov_cfg: dict[str, object] = doc_cov_cfg_raw if isinstance(doc_cov_cfg_raw, dict) else {}
|
||||||
|
|
||||||
|
# CLI args override config; config overrides defaults
|
||||||
|
if ci_scripts_dir is None and "ci_scripts_dir" in doc_cov_cfg:
|
||||||
|
ci_scripts_dir = str(doc_cov_cfg["ci_scripts_dir"])
|
||||||
|
if docs_dir is None and "docs_dir" in doc_cov_cfg:
|
||||||
|
docs_dir = str(doc_cov_cfg["docs_dir"])
|
||||||
|
docs_path = Path(docs_dir)
|
||||||
|
if source_dir is None and "source_dir" in doc_cov_cfg:
|
||||||
|
source_dir = str(doc_cov_cfg["source_dir"])
|
||||||
|
|
||||||
# Auto-detect source directory
|
# Auto-detect source directory
|
||||||
if source_dir:
|
if source_dir:
|
||||||
src_path = Path(source_dir)
|
src_path = Path(source_dir)
|
||||||
@@ -166,13 +207,27 @@ def main(docs_dir: str | None, source_dir: str | None, fail_on_missing: bool) ->
|
|||||||
missing.append(f"Module: {module}")
|
missing.append(f"Module: {module}")
|
||||||
|
|
||||||
# Check CI scripts in ci-cd-workflow.md
|
# Check CI scripts in ci-cd-workflow.md
|
||||||
# Auto-detect CI scripts from ci/ subdirectory
|
# Auto-detect CI scripts from ci/ subdirectory, or use explicit config
|
||||||
click.echo(_("\nChecking CI script documentation in ci-cd-workflow.md..."))
|
click.echo(_("\nChecking CI script documentation in ci-cd-workflow.md..."))
|
||||||
ci_dir = src_path / "ci" if src_path.name != "ci" else src_path
|
if ci_scripts_dir is not None:
|
||||||
if ci_dir.exists():
|
# Explicit config — empty string means skip CI script checks
|
||||||
detected_scripts = sorted(f.name for f in ci_dir.glob("*.py") if f.name != "__init__.py")
|
if ci_scripts_dir == "":
|
||||||
|
detected_scripts = []
|
||||||
|
else:
|
||||||
|
ci_dir = Path(ci_scripts_dir)
|
||||||
|
if ci_dir.exists():
|
||||||
|
detected_scripts = sorted(f.name for f in ci_dir.glob("*.py") if f.name != "__init__.py")
|
||||||
|
else:
|
||||||
|
detected_scripts = []
|
||||||
else:
|
else:
|
||||||
detected_scripts = REQUIRED_SCRIPTS
|
# Auto-detect from src_path/ci/
|
||||||
|
ci_dir = src_path / "ci" if src_path.name != "ci" else src_path
|
||||||
|
if ci_dir.exists():
|
||||||
|
detected_scripts = sorted(f.name for f in ci_dir.glob("*.py") if f.name != "__init__.py")
|
||||||
|
else:
|
||||||
|
# No ci/ directory found — skip CI script checks rather than falling back
|
||||||
|
# to REQUIRED_SCRIPTS (which is devx-specific)
|
||||||
|
detected_scripts = []
|
||||||
total += len(detected_scripts)
|
total += len(detected_scripts)
|
||||||
ci_docs = ci_cd_file.read_text() if ci_cd_file.exists() else ""
|
ci_docs = ci_cd_file.read_text() if ci_cd_file.exists() else ""
|
||||||
for script in detected_scripts:
|
for script in detected_scripts:
|
||||||
|
|||||||
@@ -17,7 +17,7 @@ Usage::
|
|||||||
|
|
||||||
Environment variables:
|
Environment variables:
|
||||||
GITEA_URL Base URL of the Gitea instance.
|
GITEA_URL Base URL of the Gitea instance.
|
||||||
CI_GITEA_TOKEN API token with repo access.
|
CI_GITEA_API_TOKEN API token with repo access (CI_GITEA_TOKEN accepted for legacy).
|
||||||
RUN_ID Workflow run ID (GITHUB_RUN_ID).
|
RUN_ID Workflow run ID (GITHUB_RUN_ID).
|
||||||
JOB_NAME Base job name (GITHUB_JOB), e.g. "integration-tests".
|
JOB_NAME Base job name (GITHUB_JOB), e.g. "integration-tests".
|
||||||
MATRIX_INDEX Current matrix index (runner-index).
|
MATRIX_INDEX Current matrix index (runner-index).
|
||||||
@@ -41,6 +41,7 @@ from devx.i18n import _
|
|||||||
from devx.molecule.molecule_ci_guard import (
|
from devx.molecule.molecule_ci_guard import (
|
||||||
poll_for_other_failures,
|
poll_for_other_failures,
|
||||||
)
|
)
|
||||||
|
from devx.tokens import get_ci_token
|
||||||
|
|
||||||
POLL_INTERVAL = 10
|
POLL_INTERVAL = 10
|
||||||
|
|
||||||
@@ -50,7 +51,10 @@ POLL_INTERVAL = 10
|
|||||||
def cli(pytest_args: tuple[str, ...]) -> None:
|
def cli(pytest_args: tuple[str, ...]) -> None:
|
||||||
"""Run pytest with cross-runner failure detection."""
|
"""Run pytest with cross-runner failure detection."""
|
||||||
gitea_url = os.environ.get("GITEA_URL", "")
|
gitea_url = os.environ.get("GITEA_URL", "")
|
||||||
token = os.environ.get("CI_GITEA_TOKEN", "")
|
try:
|
||||||
|
token = get_ci_token()
|
||||||
|
except click.ClickException:
|
||||||
|
token = None
|
||||||
run_id = int(os.environ.get("RUN_ID", "0"))
|
run_id = int(os.environ.get("RUN_ID", "0"))
|
||||||
job_name = os.environ.get("JOB_NAME", "integration-tests")
|
job_name = os.environ.get("JOB_NAME", "integration-tests")
|
||||||
current_index = int(os.environ.get("MATRIX_INDEX", "0"))
|
current_index = int(os.environ.get("MATRIX_INDEX", "0"))
|
||||||
|
|||||||
+174
-2
@@ -7,6 +7,12 @@ Checks performed (all configurable via pyproject.toml ``[tool.devx.docs]``):
|
|||||||
- **Broken internal links**: relative paths and anchors in markdown files
|
- **Broken internal links**: relative paths and anchors in markdown files
|
||||||
must resolve to actual files and headings.
|
must resolve to actual files and headings.
|
||||||
- **Heading hierarchy**: no skipping heading levels (e.g., ``#`` → ``###``).
|
- **Heading hierarchy**: no skipping heading levels (e.g., ``#`` → ``###``).
|
||||||
|
- **Single H1**: each markdown file should have at most one H1 heading.
|
||||||
|
- **Max heading depth**: headings should not exceed H4 (configurable).
|
||||||
|
- **Max line length**: lines should not exceed 120 characters (configurable).
|
||||||
|
- **Code block language**: fenced code blocks should specify a language.
|
||||||
|
- **Orphan docs**: docs not linked from index.md or mapping.json (warning).
|
||||||
|
- **Mapping completeness**: all docs/*.md should be in mapping.json (warning).
|
||||||
- **TODO/FIXME**: flags leftover TODO/FIXME markers in documentation.
|
- **TODO/FIXME**: flags leftover TODO/FIXME markers in documentation.
|
||||||
- **Stale docs**: files not modified in >180 days (warning only).
|
- **Stale docs**: files not modified in >180 days (warning only).
|
||||||
- **Trailing whitespace**: lines should not end with whitespace.
|
- **Trailing whitespace**: lines should not end with whitespace.
|
||||||
@@ -49,6 +55,15 @@ REQUIRED_DOC_FILES = ["index.md"]
|
|||||||
# Maximum age for docs before they're considered stale (days)
|
# Maximum age for docs before they're considered stale (days)
|
||||||
STALE_THRESHOLD_DAYS = 180
|
STALE_THRESHOLD_DAYS = 180
|
||||||
|
|
||||||
|
# Maximum heading depth (H4 by default)
|
||||||
|
MAX_HEADING_DEPTH = 4
|
||||||
|
|
||||||
|
# Maximum line length
|
||||||
|
MAX_LINE_LENGTH = 120
|
||||||
|
|
||||||
|
# Code block without language: ``` followed by optional whitespace only
|
||||||
|
_CODE_BLOCK_NO_LANG_RE = re.compile(r"^```[ \t]*$", re.MULTILINE)
|
||||||
|
|
||||||
# Files excluded from duplicate heading checks (auto-generated or structured
|
# Files excluded from duplicate heading checks (auto-generated or structured
|
||||||
# with repeated subsections under different parent sections)
|
# with repeated subsections under different parent sections)
|
||||||
DUPLICATE_HEADING_EXCLUDES = {
|
DUPLICATE_HEADING_EXCLUDES = {
|
||||||
@@ -70,6 +85,7 @@ _EXCLUDE_DIRS = {
|
|||||||
".pytest_cache",
|
".pytest_cache",
|
||||||
".devin",
|
".devin",
|
||||||
".terraform",
|
".terraform",
|
||||||
|
".vale",
|
||||||
"site-packages",
|
"site-packages",
|
||||||
"dist-info",
|
"dist-info",
|
||||||
}
|
}
|
||||||
@@ -318,6 +334,120 @@ def check_duplicate_headings(root: Path) -> list[str]:
|
|||||||
return issues
|
return issues
|
||||||
|
|
||||||
|
|
||||||
|
def check_single_h1(root: Path) -> list[str]:
|
||||||
|
"""Check that each markdown file has at most one H1 heading."""
|
||||||
|
issues: list[str] = []
|
||||||
|
md_files = [f for f in root.rglob("*.md") if not any(part in _EXCLUDE_DIRS for part in f.parts)]
|
||||||
|
|
||||||
|
for md_file in md_files:
|
||||||
|
rel_path = md_file.relative_to(root)
|
||||||
|
if md_file.name in DUPLICATE_HEADING_EXCLUDES:
|
||||||
|
continue
|
||||||
|
content = strip_code_blocks(md_file.read_text(encoding="utf-8"))
|
||||||
|
h1_count = len(re.findall(r"^#\s+", content, re.MULTILINE))
|
||||||
|
if h1_count > 1:
|
||||||
|
issues.append(f"{rel_path}: {h1_count} H1 headings — should have at most 1")
|
||||||
|
|
||||||
|
return issues
|
||||||
|
|
||||||
|
|
||||||
|
def check_max_heading_depth(root: Path) -> list[str]:
|
||||||
|
"""Check that headings don't exceed MAX_HEADING_DEPTH."""
|
||||||
|
issues: list[str] = []
|
||||||
|
md_files = [f for f in root.rglob("*.md") if not any(part in _EXCLUDE_DIRS for part in f.parts)]
|
||||||
|
|
||||||
|
for md_file in md_files:
|
||||||
|
rel_path = md_file.relative_to(root)
|
||||||
|
content = strip_code_blocks(md_file.read_text(encoding="utf-8"))
|
||||||
|
for match in re.finditer(r"^(#{1,6})\s+", content, re.MULTILINE):
|
||||||
|
level = len(match.group(1))
|
||||||
|
if level > MAX_HEADING_DEPTH:
|
||||||
|
line_num = content[: match.start()].count("\n") + 1
|
||||||
|
issues.append(f"{rel_path}:{line_num}: heading depth H{level} exceeds max H{MAX_HEADING_DEPTH}")
|
||||||
|
|
||||||
|
return issues
|
||||||
|
|
||||||
|
|
||||||
|
def check_line_length(root: Path) -> list[str]:
|
||||||
|
"""Check that no lines exceed MAX_LINE_LENGTH characters."""
|
||||||
|
issues: list[str] = []
|
||||||
|
md_files = [f for f in root.rglob("*.md") if not any(part in _EXCLUDE_DIRS for part in f.parts)]
|
||||||
|
|
||||||
|
for md_file in md_files:
|
||||||
|
rel_path = md_file.relative_to(root)
|
||||||
|
content = md_file.read_text(encoding="utf-8")
|
||||||
|
for i, line in enumerate(content.splitlines(), 1):
|
||||||
|
if len(line) > MAX_LINE_LENGTH:
|
||||||
|
issues.append(f"{rel_path}:{i}: line too long ({len(line)} > {MAX_LINE_LENGTH} chars)")
|
||||||
|
|
||||||
|
return issues
|
||||||
|
|
||||||
|
|
||||||
|
def check_code_block_languages(root: Path) -> list[str]:
|
||||||
|
"""Check that fenced code blocks specify a language."""
|
||||||
|
issues: list[str] = []
|
||||||
|
md_files = [f for f in root.rglob("*.md") if not any(part in _EXCLUDE_DIRS for part in f.parts)]
|
||||||
|
|
||||||
|
for md_file in md_files:
|
||||||
|
rel_path = md_file.relative_to(root)
|
||||||
|
content = md_file.read_text(encoding="utf-8")
|
||||||
|
in_code_block = False
|
||||||
|
for i, line in enumerate(content.splitlines(), 1):
|
||||||
|
stripped = line.strip()
|
||||||
|
if stripped.startswith("```"):
|
||||||
|
if not in_code_block:
|
||||||
|
# Opening fence — check for language
|
||||||
|
if _CODE_BLOCK_NO_LANG_RE.match(line):
|
||||||
|
issues.append(f"{rel_path}:{i}: code block without language specifier")
|
||||||
|
in_code_block = True
|
||||||
|
else:
|
||||||
|
# Closing fence
|
||||||
|
in_code_block = False
|
||||||
|
|
||||||
|
return issues
|
||||||
|
|
||||||
|
|
||||||
|
def check_orphan_docs(root: Path, docs_dir: Path) -> list[str]:
|
||||||
|
"""Check for docs not linked from index.md or mapping.json (warnings)."""
|
||||||
|
issues: list[str] = []
|
||||||
|
if not docs_dir.is_dir():
|
||||||
|
return issues
|
||||||
|
|
||||||
|
# Collect all referenced files from index.md and mapping.json
|
||||||
|
referenced: set[str] = set()
|
||||||
|
index_file = docs_dir / "index.md"
|
||||||
|
if index_file.exists():
|
||||||
|
content = index_file.read_text(encoding="utf-8")
|
||||||
|
for match in _LINK_RE.finditer(content):
|
||||||
|
url = match.group(2).strip()
|
||||||
|
if not url.startswith(("http://", "https://", "mailto:")):
|
||||||
|
referenced.add(url.split("#")[0])
|
||||||
|
|
||||||
|
mapping_file = docs_dir / "mapping.json"
|
||||||
|
if mapping_file.exists():
|
||||||
|
try:
|
||||||
|
mapping = json.loads(mapping_file.read_text(encoding="utf-8"))
|
||||||
|
if isinstance(mapping, dict):
|
||||||
|
# Add both keys (filenames) and values (wiki page names)
|
||||||
|
for k, v in mapping.items():
|
||||||
|
if isinstance(k, str):
|
||||||
|
referenced.add(k)
|
||||||
|
if isinstance(v, str):
|
||||||
|
referenced.add(v)
|
||||||
|
except (json.JSONDecodeError, AttributeError):
|
||||||
|
pass
|
||||||
|
|
||||||
|
# Check each doc file
|
||||||
|
for md_file in sorted(docs_dir.rglob("*.md")):
|
||||||
|
if md_file.name == "index.md":
|
||||||
|
continue
|
||||||
|
rel_path = md_file.relative_to(docs_dir).as_posix()
|
||||||
|
if rel_path not in referenced and md_file.name not in referenced:
|
||||||
|
issues.append(f"docs/{rel_path}: orphan doc — not linked from index.md or mapping.json")
|
||||||
|
|
||||||
|
return issues
|
||||||
|
|
||||||
|
|
||||||
@click.command()
|
@click.command()
|
||||||
@click.option("--root", default=".", help="Repository root directory.")
|
@click.option("--root", default=".", help="Repository root directory.")
|
||||||
@click.option("--docs-dir", default=None, help="Docs directory (default: <root>/docs).")
|
@click.option("--docs-dir", default=None, help="Docs directory (default: <root>/docs).")
|
||||||
@@ -327,6 +457,11 @@ def check_duplicate_headings(root: Path) -> list[str]:
|
|||||||
@click.option("--check-stale/--no-check-stale", default=False, help="Check for stale docs.")
|
@click.option("--check-stale/--no-check-stale", default=False, help="Check for stale docs.")
|
||||||
@click.option("--check-trailing/--no-check-trailing", default=True, help="Check trailing whitespace.")
|
@click.option("--check-trailing/--no-check-trailing", default=True, help="Check trailing whitespace.")
|
||||||
@click.option("--check-duplicates/--no-check-duplicates", default=True, help="Check duplicate headings.")
|
@click.option("--check-duplicates/--no-check-duplicates", default=True, help="Check duplicate headings.")
|
||||||
|
@click.option("--check-single-h1/--no-check-single-h1", "single_h1", default=True, help="Check single H1 per file.")
|
||||||
|
@click.option("--check-depth/--no-check-depth", "depth", default=True, help="Check max heading depth.")
|
||||||
|
@click.option("--check-line-length/--no-check-line-length", "line_length", default=True, help="Check line length.")
|
||||||
|
@click.option("--check-code-lang/--no-check-code-lang", "code_lang", default=True, help="Check code block languages.")
|
||||||
|
@click.option("--check-orphans/--no-check-orphans", "orphans", default=False, help="Check for orphan docs (warnings).")
|
||||||
@click.option("--fix", is_flag=True, default=False, help="Auto-fix trailing whitespace.")
|
@click.option("--fix", is_flag=True, default=False, help="Auto-fix trailing whitespace.")
|
||||||
def main(
|
def main(
|
||||||
root: str,
|
root: str,
|
||||||
@@ -337,6 +472,11 @@ def main(
|
|||||||
check_stale: bool,
|
check_stale: bool,
|
||||||
check_trailing: bool,
|
check_trailing: bool,
|
||||||
check_duplicates: bool,
|
check_duplicates: bool,
|
||||||
|
single_h1: bool,
|
||||||
|
depth: bool,
|
||||||
|
line_length: bool,
|
||||||
|
code_lang: bool,
|
||||||
|
orphans: bool,
|
||||||
fix: bool,
|
fix: bool,
|
||||||
) -> None:
|
) -> None:
|
||||||
"""Lint documentation files for structure, links, and quality."""
|
"""Lint documentation files for structure, links, and quality."""
|
||||||
@@ -369,6 +509,31 @@ def main(
|
|||||||
click.echo(_("Checking duplicate headings..."))
|
click.echo(_("Checking duplicate headings..."))
|
||||||
all_issues.extend(check_duplicate_headings(root_path))
|
all_issues.extend(check_duplicate_headings(root_path))
|
||||||
|
|
||||||
|
# Single H1
|
||||||
|
if single_h1:
|
||||||
|
click.echo(_("Checking single H1 per file..."))
|
||||||
|
all_issues.extend(check_single_h1(root_path))
|
||||||
|
|
||||||
|
# Max heading depth
|
||||||
|
if depth:
|
||||||
|
click.echo(_("Checking max heading depth..."))
|
||||||
|
all_issues.extend(check_max_heading_depth(root_path))
|
||||||
|
|
||||||
|
# Line length (warnings — badge URLs and tables can exceed 120)
|
||||||
|
if line_length:
|
||||||
|
click.echo(_("Checking line length..."))
|
||||||
|
ll_issues = check_line_length(root_path)
|
||||||
|
for issue in ll_issues[:10]: # Show first 10 only
|
||||||
|
click.echo(f" WARN: {issue}")
|
||||||
|
if len(ll_issues) > 10:
|
||||||
|
click.echo(_(" ... and {n} more", n=len(ll_issues) - 10))
|
||||||
|
click.echo(_(" {n} long lines found (warnings only)", n=len(ll_issues)))
|
||||||
|
|
||||||
|
# Code block languages
|
||||||
|
if code_lang:
|
||||||
|
click.echo(_("Checking code block languages..."))
|
||||||
|
all_issues.extend(check_code_block_languages(root_path))
|
||||||
|
|
||||||
# TODO/FIXME
|
# TODO/FIXME
|
||||||
if check_todo:
|
if check_todo:
|
||||||
click.echo(_("Checking for TODO/FIXME markers..."))
|
click.echo(_("Checking for TODO/FIXME markers..."))
|
||||||
@@ -391,15 +556,22 @@ def main(
|
|||||||
else:
|
else:
|
||||||
all_issues.extend(ws_issues)
|
all_issues.extend(ws_issues)
|
||||||
|
|
||||||
# Stale docs
|
# Stale docs (warnings)
|
||||||
if check_stale:
|
if check_stale:
|
||||||
click.echo(_("Checking for stale docs..."))
|
click.echo(_("Checking for stale docs..."))
|
||||||
stale = check_stale_docs(root_path)
|
stale = check_stale_docs(root_path)
|
||||||
for issue in stale:
|
for issue in stale:
|
||||||
click.echo(f" WARN: {issue}")
|
click.echo(f" WARN: {issue}")
|
||||||
# Stale docs are warnings, not errors
|
|
||||||
click.echo(_(" {n} stale docs found (warnings only)", n=len(stale)))
|
click.echo(_(" {n} stale docs found (warnings only)", n=len(stale)))
|
||||||
|
|
||||||
|
# Orphan docs (warnings)
|
||||||
|
if orphans:
|
||||||
|
click.echo(_("Checking for orphan docs..."))
|
||||||
|
orphan_issues = check_orphan_docs(root_path, docs_path)
|
||||||
|
for issue in orphan_issues:
|
||||||
|
click.echo(f" WARN: {issue}")
|
||||||
|
click.echo(_(" {n} orphan docs found (warnings only)", n=len(orphan_issues)))
|
||||||
|
|
||||||
# Report
|
# Report
|
||||||
click.echo(f"\n{'=' * 60}")
|
click.echo(f"\n{'=' * 60}")
|
||||||
if all_issues:
|
if all_issues:
|
||||||
|
|||||||
@@ -6,7 +6,7 @@ otherwise go unnoticed in the Actions tab. Uses the ``tea`` Gitea CLI
|
|||||||
for issue creation — tea must be installed and configured.
|
for issue creation — tea must be installed and configured.
|
||||||
|
|
||||||
Usage:
|
Usage:
|
||||||
CI_GITEA_TOKEN=<token> python3 -m devx.ci.notify_failure \
|
CI_GITEA_API_TOKEN=<token> python3 -m devx.ci.notify_failure \
|
||||||
--repo <owner/repo> \
|
--repo <owner/repo> \
|
||||||
--run-id <run_id> \
|
--run-id <run_id> \
|
||||||
--workflow <workflow_name> \
|
--workflow <workflow_name> \
|
||||||
@@ -14,14 +14,13 @@ Usage:
|
|||||||
--auto-login
|
--auto-login
|
||||||
|
|
||||||
With ``--auto-login``, the script configures the tea CLI login profile
|
With ``--auto-login``, the script configures the tea CLI login profile
|
||||||
from ``CI_GITEA_TOKEN`` and ``DEVX_GITEA_API_URL`` before creating the issue,
|
from the CI API token and ``DEVX_GITEA_API_URL`` before creating the issue,
|
||||||
eliminating the need for a separate ``tea login add`` step in the workflow.
|
eliminating the need for a separate ``tea login add`` step in the workflow.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
from __future__ import annotations
|
from __future__ import annotations
|
||||||
|
|
||||||
import logging
|
import logging
|
||||||
import os
|
|
||||||
|
|
||||||
import click
|
import click
|
||||||
from dotenv import load_dotenv # pyright: ignore[reportMissingImports,reportUnknownVariableType]
|
from dotenv import load_dotenv # pyright: ignore[reportMissingImports,reportUnknownVariableType]
|
||||||
@@ -29,6 +28,7 @@ from dotenv import load_dotenv # pyright: ignore[reportMissingImports,reportUnk
|
|||||||
from devx.config import GITEA_API_URL
|
from devx.config import GITEA_API_URL
|
||||||
from devx.gitea_cli import TeaCLI, TeaCLIError, configure_tea_login
|
from devx.gitea_cli import TeaCLI, TeaCLIError, configure_tea_login
|
||||||
from devx.i18n import _
|
from devx.i18n import _
|
||||||
|
from devx.tokens import get_ci_token
|
||||||
|
|
||||||
load_dotenv()
|
load_dotenv()
|
||||||
|
|
||||||
@@ -74,9 +74,10 @@ def _create_issue_via_tea(repo: str, title: str, body: str) -> int:
|
|||||||
help="Configure tea CLI login from CI_GITEA_TOKEN before creating the issue.",
|
help="Configure tea CLI login from CI_GITEA_TOKEN before creating the issue.",
|
||||||
)
|
)
|
||||||
def main(repo: str, run_id: str, workflow: str, commit: str, auto_login: bool) -> None:
|
def main(repo: str, run_id: str, workflow: str, commit: str, auto_login: bool) -> None:
|
||||||
token = os.environ.get("CI_GITEA_TOKEN", "")
|
try:
|
||||||
if not token:
|
get_ci_token()
|
||||||
raise click.ClickException(_("ERROR: CI_GITEA_TOKEN is not set."))
|
except click.ClickException:
|
||||||
|
raise click.ClickException(_("ERROR: CI_GITEA_TOKEN is not set.")) from None
|
||||||
|
|
||||||
if auto_login:
|
if auto_login:
|
||||||
configure_tea_login()
|
configure_tea_login()
|
||||||
|
|||||||
@@ -5,7 +5,6 @@ Usage:
|
|||||||
VIKUNJA_TOKEN=<token> python3 -m devx.ci.post_merge <commit_msg> [--commit-sha <sha>]
|
VIKUNJA_TOKEN=<token> python3 -m devx.ci.post_merge <commit_msg> [--commit-sha <sha>]
|
||||||
"""
|
"""
|
||||||
|
|
||||||
import os
|
|
||||||
import re
|
import re
|
||||||
import subprocess # nosec B404
|
import subprocess # nosec B404
|
||||||
|
|
||||||
@@ -17,6 +16,7 @@ from devx.ci._shared import extract_task_id as _extract_task_id
|
|||||||
from devx.config import DEFAULT_PER_PAGE, TASK_PREFIX, VIKUNJA_API_URL, VIKUNJA_PROJECT_ID
|
from devx.config import DEFAULT_PER_PAGE, TASK_PREFIX, VIKUNJA_API_URL, VIKUNJA_PROJECT_ID
|
||||||
from devx.exceptions import APIError
|
from devx.exceptions import APIError
|
||||||
from devx.i18n import _
|
from devx.i18n import _
|
||||||
|
from devx.tokens import get_vikunja_token
|
||||||
|
|
||||||
load_dotenv()
|
load_dotenv()
|
||||||
|
|
||||||
@@ -127,9 +127,10 @@ def main(commit_msg: str | None, commit_sha: str, from_git: bool, git_sha: str)
|
|||||||
commit_sha = _get_git_commit_sha()
|
commit_sha = _get_git_commit_sha()
|
||||||
if not commit_msg:
|
if not commit_msg:
|
||||||
raise click.ClickException("commit_msg argument is required (or use --from-git or --git-sha)")
|
raise click.ClickException("commit_msg argument is required (or use --from-git or --git-sha)")
|
||||||
token = os.environ.get("VIKUNJA_TOKEN", "")
|
try:
|
||||||
if not token:
|
token = get_vikunja_token()
|
||||||
raise click.ClickException(_("ERROR: VIKUNJA_TOKEN is not set."))
|
except click.ClickException:
|
||||||
|
raise click.ClickException(_("ERROR: VIKUNJA_TOKEN is not set.")) from None
|
||||||
|
|
||||||
task_id = extract_task_id(commit_msg)
|
task_id = extract_task_id(commit_msg)
|
||||||
if not task_id:
|
if not task_id:
|
||||||
|
|||||||
@@ -17,7 +17,7 @@ Checks performed:
|
|||||||
8. Commit conventions — conventional commit format on branch commits
|
8. Commit conventions — conventional commit format on branch commits
|
||||||
|
|
||||||
Usage:
|
Usage:
|
||||||
CI_GITEA_TOKEN=<token> python3 -m devx.ci.pr_review <pr_number> <owner/repo>
|
CI_GITEA_API_TOKEN=<token> [REVIEWER_GITEA_API_TOKEN=<token>] python3 -m devx.ci.pr_review <pr_number> <owner/repo>
|
||||||
"""
|
"""
|
||||||
|
|
||||||
from __future__ import annotations
|
from __future__ import annotations
|
||||||
@@ -34,6 +34,7 @@ from devx.api_clients import GiteaClient
|
|||||||
from devx.config import GITEA_API_URL
|
from devx.config import GITEA_API_URL
|
||||||
from devx.exceptions import APIError
|
from devx.exceptions import APIError
|
||||||
from devx.i18n import _
|
from devx.i18n import _
|
||||||
|
from devx.tokens import get_ci_token, get_reviewer_token
|
||||||
|
|
||||||
load_dotenv()
|
load_dotenv()
|
||||||
|
|
||||||
@@ -548,8 +549,14 @@ def _post_manual_review(
|
|||||||
checklist_confirmed: bool,
|
checklist_confirmed: bool,
|
||||||
checklist_categories: str | None,
|
checklist_categories: str | None,
|
||||||
dry_run: bool,
|
dry_run: bool,
|
||||||
|
owner: str | None = None,
|
||||||
|
repo_name: str | None = None,
|
||||||
) -> None:
|
) -> None:
|
||||||
"""Post a manual review with validation for APPROVE events."""
|
"""Post a manual review with validation for APPROVE events.
|
||||||
|
|
||||||
|
When self-approval is rejected (reviewer token belongs to PR author),
|
||||||
|
falls back to the CI token (different user) if available.
|
||||||
|
"""
|
||||||
if not body or len(body) < 50:
|
if not body or len(body) < 50:
|
||||||
raise click.ClickException(_("Review body must be at least 50 characters."))
|
raise click.ClickException(_("Review body must be at least 50 characters."))
|
||||||
|
|
||||||
@@ -585,8 +592,20 @@ def _post_manual_review(
|
|||||||
review = client.create_review(pr_number, event=event, body=body)
|
review = client.create_review(pr_number, event=event, body=body)
|
||||||
except APIError as e:
|
except APIError as e:
|
||||||
if "approve" in e.message.lower() or "422" in str(e.status):
|
if "approve" in e.message.lower() or "422" in str(e.status):
|
||||||
click.echo(_("Note: Self-approval not allowed. Posting COMMENT instead."))
|
# Self-approval not allowed (reviewer token belongs to PR author).
|
||||||
review = client.create_review(pr_number, event="COMMENT", body=body)
|
# Fall back to CI token (different user) if available.
|
||||||
|
ci_token = os.environ.get("CI_GITEA_API_TOKEN", "").strip()
|
||||||
|
if ci_token and owner and repo_name:
|
||||||
|
click.echo(_("Note: Self-approval not allowed with reviewer token. Retrying with CI token."))
|
||||||
|
ci_client = GiteaClient(GITEA_API_URL, ci_token, owner, repo_name)
|
||||||
|
try:
|
||||||
|
review = ci_client.create_review(pr_number, event=event, body=body)
|
||||||
|
except APIError:
|
||||||
|
click.echo(_("Note: CI token also cannot approve. Posting COMMENT instead."))
|
||||||
|
review = client.create_review(pr_number, event="COMMENT", body=body)
|
||||||
|
else:
|
||||||
|
click.echo(_("Note: Self-approval not allowed. Posting COMMENT instead."))
|
||||||
|
review = client.create_review(pr_number, event="COMMENT", body=body)
|
||||||
else:
|
else:
|
||||||
raise
|
raise
|
||||||
review_id = review.get("id", "?")
|
review_id = review.get("id", "?")
|
||||||
@@ -636,15 +655,26 @@ def main(
|
|||||||
Without --event: runs automated checks and posts COMMENT/REQUEST_CHANGES.
|
Without --event: runs automated checks and posts COMMENT/REQUEST_CHANGES.
|
||||||
With --event: posts a manual review (skips automated checks).
|
With --event: posts a manual review (skips automated checks).
|
||||||
"""
|
"""
|
||||||
token = os.environ.get("CI_GITEA_TOKEN", "")
|
try:
|
||||||
if not token:
|
token = get_reviewer_token() if (event and event.upper() == "APPROVE") else get_ci_token()
|
||||||
raise click.ClickException(_("ERROR: CI_GITEA_TOKEN is not set."))
|
except click.ClickException:
|
||||||
|
raise click.ClickException(_("ERROR: CI_GITEA_TOKEN is not set.")) from None
|
||||||
|
|
||||||
owner, repo_name = repo.split("/")
|
owner, repo_name = repo.split("/")
|
||||||
client = GiteaClient(GITEA_API_URL, token, owner, repo_name)
|
client = GiteaClient(GITEA_API_URL, token, owner, repo_name)
|
||||||
|
|
||||||
if event is not None:
|
if event is not None:
|
||||||
_post_manual_review(client, pr_number, event.upper(), body, checklist_confirmed, checklist_categories, dry_run)
|
_post_manual_review(
|
||||||
|
client,
|
||||||
|
pr_number,
|
||||||
|
event.upper(),
|
||||||
|
body,
|
||||||
|
checklist_confirmed,
|
||||||
|
checklist_categories,
|
||||||
|
dry_run,
|
||||||
|
owner=owner,
|
||||||
|
repo_name=repo_name,
|
||||||
|
)
|
||||||
return
|
return
|
||||||
|
|
||||||
result = run_review(client, pr_number)
|
result = run_review(client, pr_number)
|
||||||
|
|||||||
@@ -9,14 +9,14 @@ Publishing destinations (checked in order):
|
|||||||
``DEVX_PYPI_REGISTRY_URL`` env var is set, or ``GITEA_API_URL``
|
``DEVX_PYPI_REGISTRY_URL`` env var is set, or ``GITEA_API_URL``
|
||||||
is converted to a packages URL). Uses ``twine upload
|
is converted to a packages URL). Uses ``twine upload
|
||||||
--repository-url <url> -u <token> -p <token>`` with the
|
--repository-url <url> -u <token> -p <token>`` with the
|
||||||
``CI_GITEA_TOKEN`` as both username and password.
|
CI API token as both username and password.
|
||||||
2. **Standard PyPI** — if ``PYPI_TOKEN`` is set. Uses the standard
|
2. **Standard PyPI** — if ``PYPI_TOKEN`` is set. Uses the standard
|
||||||
``twine upload -u __token__ -p <token>`` flow.
|
``twine upload -u __token__ -p <token>`` flow.
|
||||||
3. **Skip** — if neither is configured, only the Gitea release is created.
|
3. **Skip** — if neither is configured, only the Gitea release is created.
|
||||||
|
|
||||||
Usage:
|
Usage:
|
||||||
CI_GITEA_TOKEN=<token> [PYPI_TOKEN=<token>] python3 -m devx.ci.publish <tag> <repo>
|
CI_GITEA_API_TOKEN=<token> [PYPI_TOKEN=<token>] python3 -m devx.ci.publish <tag> <repo>
|
||||||
CI_GITEA_TOKEN=<token> python3 -m devx.ci.publish <tag> <repo> --registry-url https://git.example.com/api/packages/owner/pypi
|
CI_GITEA_API_TOKEN=<token> python3 -m devx.ci.publish <tag> <repo> --registry-url https://git.example.com/api/packages/owner/pypi
|
||||||
"""
|
"""
|
||||||
|
|
||||||
import os
|
import os
|
||||||
@@ -31,6 +31,7 @@ from dotenv import load_dotenv # pyright: ignore[reportMissingImports,reportUnk
|
|||||||
from devx.config import GITEA_API_URL, REPO_OWNER
|
from devx.config import GITEA_API_URL, REPO_OWNER
|
||||||
from devx.gitea_cli import TeaCLI, TeaCLIError, configure_tea_login
|
from devx.gitea_cli import TeaCLI, TeaCLIError, configure_tea_login
|
||||||
from devx.i18n import _
|
from devx.i18n import _
|
||||||
|
from devx.tokens import get_ci_token
|
||||||
|
|
||||||
load_dotenv()
|
load_dotenv()
|
||||||
|
|
||||||
@@ -253,9 +254,10 @@ def main(
|
|||||||
|
|
||||||
if not tag:
|
if not tag:
|
||||||
raise click.ClickException(_("Tag is required (or use --from-tag)."))
|
raise click.ClickException(_("Tag is required (or use --from-tag)."))
|
||||||
gitea_token = os.environ.get("CI_GITEA_TOKEN", "")
|
try:
|
||||||
if not gitea_token:
|
gitea_token = get_ci_token()
|
||||||
raise click.ClickException(_("ERROR: CI_GITEA_TOKEN is not set."))
|
except click.ClickException:
|
||||||
|
raise click.ClickException(_("ERROR: CI_GITEA_TOKEN is not set.")) from None
|
||||||
|
|
||||||
pypi_token = os.environ.get("PYPI_TOKEN", "")
|
pypi_token = os.environ.get("PYPI_TOKEN", "")
|
||||||
|
|
||||||
|
|||||||
@@ -87,19 +87,26 @@ def push_to_badges_branch(badges_dir: str) -> str:
|
|||||||
|
|
||||||
Returns the commit SHA of the pushed badges branch.
|
Returns the commit SHA of the pushed badges branch.
|
||||||
"""
|
"""
|
||||||
|
import shutil
|
||||||
|
|
||||||
_run(["git", "config", "user.name", "gitea-actions-bot"]) # nosec B607
|
_run(["git", "config", "user.name", "gitea-actions-bot"]) # nosec B607
|
||||||
_run(["git", "config", "user.email", "actions@oblachno.fyi"]) # nosec B607
|
_run(["git", "config", "user.email", "actions@oblachno.fyi"]) # nosec B607
|
||||||
_run(["git", "checkout", "--orphan", "badges"]) # nosec B607
|
_run(["git", "checkout", "--orphan", "badges"]) # nosec B607
|
||||||
_run(["git", "rm", "-rf", "."]) # nosec B607
|
_run(["git", "rm", "-rf", "."]) # nosec B607
|
||||||
|
# Remove untracked files/dirs left behind, but preserve .badges/ for copy below
|
||||||
|
_run(["git", "clean", "-fdx", "-e", ".git", "-e", badges_dir]) # nosec B607
|
||||||
|
|
||||||
# Copy badge files to root
|
# Copy badge files to root
|
||||||
import shutil
|
|
||||||
|
|
||||||
for svg in Path(badges_dir).glob("*.svg"):
|
for svg in Path(badges_dir).glob("*.svg"):
|
||||||
shutil.copy2(svg, Path.cwd() / svg.name)
|
shutil.copy2(svg, Path.cwd() / svg.name)
|
||||||
|
|
||||||
_run(["git", "add", "./*.svg"]) # nosec B607
|
_run(["git", "add", "./*.svg"]) # nosec B607
|
||||||
_run(["git", "commit", "--no-verify", "-m", "Update badges [skip ci]"]) # nosec B607
|
# Commit even if no changes (ensures badges branch always exists)
|
||||||
|
result = _run_capture(["git", "diff", "--cached", "--name-only"]) # nosec B607
|
||||||
|
if result.stdout.strip():
|
||||||
|
_run(["git", "commit", "--no-verify", "-m", "Update badges [skip ci]"]) # nosec B607
|
||||||
|
else:
|
||||||
|
click.echo(_("No badge changes — skipping commit"))
|
||||||
_run(["git", "push", "origin", "badges", "--force"]) # nosec B607
|
_run(["git", "push", "origin", "badges", "--force"]) # nosec B607
|
||||||
click.echo(_("Badges pushed to badges branch"))
|
click.echo(_("Badges pushed to badges branch"))
|
||||||
|
|
||||||
@@ -135,6 +142,22 @@ def update_readme_with_badge_sha(badges_sha: str, repo_root: Path | None = None)
|
|||||||
_run(["git", "fetch", "origin", "master"]) # nosec B607
|
_run(["git", "fetch", "origin", "master"]) # nosec B607
|
||||||
_run(["git", "reset", "--hard", "origin/master"]) # nosec B607
|
_run(["git", "reset", "--hard", "origin/master"]) # nosec B607
|
||||||
|
|
||||||
|
# Verify version badge matches current __version__
|
||||||
|
from devx.tools.generate_badges import detect_package_name, read_version
|
||||||
|
|
||||||
|
pkg = detect_package_name(root)
|
||||||
|
current_version = read_version(root) if pkg else "unknown"
|
||||||
|
version_svg = Path(".badges") / "version.svg"
|
||||||
|
if version_svg.exists():
|
||||||
|
svg_content = version_svg.read_text()
|
||||||
|
if current_version != "unknown" and f"v{current_version}" not in svg_content:
|
||||||
|
click.echo(
|
||||||
|
_(
|
||||||
|
"WARNING: Version badge shows stale version (expected v{version}) — regenerating",
|
||||||
|
version=current_version,
|
||||||
|
)
|
||||||
|
)
|
||||||
|
|
||||||
updated_any = False
|
updated_any = False
|
||||||
for filename in FILES_WITH_BADGE_URLS:
|
for filename in FILES_WITH_BADGE_URLS:
|
||||||
filepath = root / filename
|
filepath = root / filename
|
||||||
|
|||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user