Public Access
Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
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 | ||
|
|
587d3a6ca4 | ||
|
|
9d75e408ae | ||
|
|
412bbea01d | ||
|
|
ce5ce33a12 | ||
|
|
0fae419584 | ||
|
|
70b011d4a6 | ||
|
|
a5c16a92df | ||
|
|
e6f022ae96 | ||
|
|
1a27983750 | ||
|
|
5d7ed62b34 | ||
|
|
ee80c27631 | ||
|
|
98b1659579 | ||
|
|
c12d9abc6d | ||
|
|
40a65cb0a6 | ||
|
|
1a89738dd4 | ||
|
|
9e604ea2c7 | ||
|
|
4bb50bed58 | ||
|
|
5bb9dce530 | ||
|
|
73662a3bf0 | ||
|
|
a1e87b1905 | ||
|
|
d8d0ad04a2 | ||
|
|
e836c09088 | ||
|
|
507436b134 |
@@ -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.
|
||||||
@@ -5,7 +5,9 @@ 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
|
||||||
#
|
#
|
||||||
# The workflow builds 3 tier images in sequence:
|
# The workflow builds 3 tier images in sequence:
|
||||||
@@ -15,12 +17,10 @@ name: Build Images
|
|||||||
# 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:
|
||||||
@@ -49,7 +49,11 @@ jobs:
|
|||||||
|
|
||||||
build-and-push:
|
build-and-push:
|
||||||
needs: [detect-type]
|
needs: [detect-type]
|
||||||
if: needs.detect-type.outputs.is-release == 'false'
|
if: >-
|
||||||
|
needs.detect-type.outputs.is-release == 'false' && (
|
||||||
|
github.event_name == 'workflow_dispatch' ||
|
||||||
|
(github.event_name == 'workflow_run' && github.event.workflow_run.conclusion == 'success')
|
||||||
|
)
|
||||||
runs-on: docker
|
runs-on: docker
|
||||||
timeout-minutes: 30
|
timeout-minutes: 30
|
||||||
steps:
|
steps:
|
||||||
|
|||||||
+32
-14
@@ -19,41 +19,44 @@ jobs:
|
|||||||
run: make setup-image
|
run: make setup-image
|
||||||
- name: Lint all
|
- name: Lint all
|
||||||
run: |
|
run: |
|
||||||
. .venv/bin/activate
|
. .venv/bin/activate 2>/dev/null || true
|
||||||
export PATH="$HOME/.local/bin:$PATH"
|
export PATH="$HOME/.local/bin:$PATH"
|
||||||
make lint-all
|
make lint-all
|
||||||
- name: Unit tests with 100% coverage
|
- name: Unit tests with 100% coverage
|
||||||
run: |
|
run: |
|
||||||
. .venv/bin/activate
|
. .venv/bin/activate 2>/dev/null || true
|
||||||
make pytest-cov
|
make pytest-cov
|
||||||
- name: Check unit test speed
|
- name: Check unit test speed
|
||||||
env:
|
env:
|
||||||
PYTHONPATH: src
|
PYTHONPATH: src
|
||||||
run: |
|
run: |
|
||||||
. .venv/bin/activate
|
. .venv/bin/activate 2>/dev/null || true
|
||||||
python3 -m devx.tools.check_test_speed --max-seconds 4 --max-single-seconds 0.5
|
python3 -m devx.tools.check_test_speed --max-seconds 6 --max-single-seconds 0.5
|
||||||
- name: Documentation coverage check
|
- name: Documentation gate (coverage + stale refs + lint + version refs + prose)
|
||||||
env:
|
env:
|
||||||
PYTHONPATH: src
|
PYTHONPATH: src
|
||||||
|
DEVX_DOC_COVERAGE_STRICT: "1"
|
||||||
|
DEVX_VALE_LEVEL: warning
|
||||||
run: |
|
run: |
|
||||||
. .venv/bin/activate
|
. .venv/bin/activate 2>/dev/null || true
|
||||||
python3 -m devx.ci.doc_coverage --fail-on-missing
|
export PATH="$HOME/.local/bin:$PATH"
|
||||||
|
make devx-docs-check
|
||||||
- name: Translation completeness check
|
- name: Translation completeness check
|
||||||
env:
|
env:
|
||||||
PYTHONPATH: src
|
PYTHONPATH: src
|
||||||
run: |
|
run: |
|
||||||
. .venv/bin/activate
|
. .venv/bin/activate 2>/dev/null || true
|
||||||
python3 -m devx.ci.check_translations
|
python3 -m devx.ci.check_translations
|
||||||
- name: Dependency security scan
|
- name: Dependency security scan
|
||||||
run: |
|
run: |
|
||||||
. .venv/bin/activate
|
. .venv/bin/activate 2>/dev/null || true
|
||||||
# Install pip in venv if missing (needed by pip-audit)
|
# Install pip in venv if missing (needed by pip-audit)
|
||||||
.venv/bin/python -m ensurepip 2>/dev/null || true
|
.venv/bin/python -m ensurepip 2>/dev/null || true
|
||||||
PIPAPI_PYTHON_LOCATION=$PWD/.venv/bin/python \
|
PIPAPI_PYTHON_LOCATION=$PWD/.venv/bin/python \
|
||||||
pip-audit --desc --skip-editable 2>&1 || true
|
pip-audit --desc --skip-editable 2>&1 || true
|
||||||
- name: Workflow dry-run validation
|
- name: Workflow dry-run validation
|
||||||
run: |
|
run: |
|
||||||
. .venv/bin/activate
|
. .venv/bin/activate 2>/dev/null || true
|
||||||
export PATH="$HOME/.local/bin:$PATH"
|
export PATH="$HOME/.local/bin:$PATH"
|
||||||
# Best-effort: only runs if act_runner is installed
|
# Best-effort: only runs if act_runner is installed
|
||||||
if command -v act_runner >/dev/null 2>&1; then
|
if command -v act_runner >/dev/null 2>&1; then
|
||||||
@@ -82,7 +85,7 @@ jobs:
|
|||||||
env:
|
env:
|
||||||
PYTHONPATH: src
|
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 }}" \
|
||||||
@@ -109,7 +112,7 @@ jobs:
|
|||||||
env:
|
env:
|
||||||
PYTHONPATH: src
|
PYTHONPATH: src
|
||||||
run: |
|
run: |
|
||||||
. .venv/bin/activate
|
. .venv/bin/activate 2>/dev/null || true
|
||||||
export PATH="$HOME/.local/bin:$PATH"
|
export PATH="$HOME/.local/bin:$PATH"
|
||||||
python3 -m devx.ci.release --dry-run
|
python3 -m devx.ci.release --dry-run
|
||||||
|
|
||||||
@@ -131,7 +134,7 @@ jobs:
|
|||||||
PYTHONPATH: src
|
PYTHONPATH: src
|
||||||
run: |
|
run: |
|
||||||
set -euo pipefail
|
set -euo pipefail
|
||||||
. .venv/bin/activate
|
. .venv/bin/activate 2>/dev/null || true
|
||||||
python3 -m devx.ci.pr_review \
|
python3 -m devx.ci.pr_review \
|
||||||
"${{ github.event.number }}" \
|
"${{ github.event.number }}" \
|
||||||
"${{ github.repository }}"
|
"${{ github.repository }}"
|
||||||
@@ -160,6 +163,21 @@ jobs:
|
|||||||
token: ${{ secrets.CI_GITEA_TOKEN }}
|
token: ${{ secrets.CI_GITEA_TOKEN }}
|
||||||
- name: Set up environment
|
- name: Set up environment
|
||||||
run: make setup-image
|
run: make setup-image
|
||||||
|
- name: Post approval review
|
||||||
|
env:
|
||||||
|
CI_GITEA_TOKEN: ${{ secrets.REVIEW_GITEA_TOKEN }}
|
||||||
|
PR_NUMBER: ${{ github.event.number }}
|
||||||
|
REPOSITORY: ${{ github.repository }}
|
||||||
|
PYTHONPATH: src
|
||||||
|
run: |
|
||||||
|
. .venv/bin/activate 2>/dev/null || true
|
||||||
|
python3 -m devx.ci.pr_review \
|
||||||
|
"$PR_NUMBER" \
|
||||||
|
"$REPOSITORY" \
|
||||||
|
--event APPROVE \
|
||||||
|
--checklist-confirmed \
|
||||||
|
--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)."
|
||||||
- name: Squash merge with task ID
|
- name: Squash merge with task ID
|
||||||
env:
|
env:
|
||||||
CI_GITEA_TOKEN: ${{ secrets.CI_GITEA_TOKEN }}
|
CI_GITEA_TOKEN: ${{ secrets.CI_GITEA_TOKEN }}
|
||||||
@@ -171,7 +189,7 @@ jobs:
|
|||||||
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" \
|
||||||
|
|||||||
@@ -8,7 +8,8 @@ name: Post-merge
|
|||||||
# detect-type ──┬── validate-commit-msg (skip if release commit)
|
# detect-type ──┬── validate-commit-msg (skip if release commit)
|
||||||
# ├── release (skip if release commit)
|
# ├── release (skip if release commit)
|
||||||
# │ └── publish (needs release — builds & publishes to PyPI)
|
# │ └── publish (needs release — builds & publishes to PyPI)
|
||||||
# ├── badges (ALWAYS runs — even on release commits)
|
# ├── badges (needs release — ALWAYS runs, waits for release
|
||||||
|
# │ so version badge picks up new __version__)
|
||||||
# ├── configure-repo (independent — skip if release commit)
|
# ├── configure-repo (independent — skip if release commit)
|
||||||
# ├── sync-wiki (skip if release commit — runs for ALL merges)
|
# ├── sync-wiki (skip if release commit — runs for ALL merges)
|
||||||
# └── vikunja (skip if release commit — runs for ALL merges)
|
# └── vikunja (skip if release commit — runs for ALL merges)
|
||||||
@@ -17,9 +18,10 @@ name: Post-merge
|
|||||||
# release succeeds. This ensures the wiki and task tracker are updated
|
# release succeeds. This ensures the wiki and task tracker are updated
|
||||||
# even for infrastructure-only changes (docs, CI config, etc.).
|
# even for infrastructure-only changes (docs, CI config, etc.).
|
||||||
#
|
#
|
||||||
# The badges job uses `if: always()` with no is-release condition so it
|
# The badges job uses `if: always()` and needs `release` so it waits for
|
||||||
# runs on every push to master, including release commits. This ensures
|
# the release job to complete (whether it ran or was skipped). This ensures
|
||||||
# badges (tests, coverage, version, etc.) are always current.
|
# the version badge always reflects the latest __version__ on master.
|
||||||
|
# Badges run on every push to master, including release commits.
|
||||||
#
|
#
|
||||||
# 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
|
# job (which depends on release) builds and publishes the package to the
|
||||||
@@ -51,7 +53,7 @@ jobs:
|
|||||||
env:
|
env:
|
||||||
PYTHONPATH: src
|
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:
|
validate-commit-msg:
|
||||||
@@ -73,7 +75,7 @@ jobs:
|
|||||||
env:
|
env:
|
||||||
PYTHONPATH: src
|
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
|
||||||
@@ -107,7 +109,7 @@ jobs:
|
|||||||
env:
|
env:
|
||||||
PYTHONPATH: src
|
PYTHONPATH: src
|
||||||
run: |
|
run: |
|
||||||
. .venv/bin/activate
|
. .venv/bin/activate 2>/dev/null || true
|
||||||
export PATH="$HOME/.local/bin:$PATH"
|
export PATH="$HOME/.local/bin:$PATH"
|
||||||
python3 -m devx.ci.release
|
python3 -m devx.ci.release
|
||||||
- name: Notify on failure
|
- name: Notify on failure
|
||||||
@@ -146,7 +148,7 @@ jobs:
|
|||||||
CI_GITEA_TOKEN: ${{ secrets.CI_GITEA_TOKEN }}
|
CI_GITEA_TOKEN: ${{ secrets.CI_GITEA_TOKEN }}
|
||||||
PYTHONPATH: src
|
PYTHONPATH: src
|
||||||
run: |
|
run: |
|
||||||
. .venv/bin/activate
|
. .venv/bin/activate 2>/dev/null || true
|
||||||
export PATH="$HOME/.local/bin:$PATH"
|
export PATH="$HOME/.local/bin:$PATH"
|
||||||
python3 -m devx.ci.publish "${{ needs.release.outputs.tag }}" "${{ github.repository }}" --auto-login
|
python3 -m devx.ci.publish "${{ needs.release.outputs.tag }}" "${{ github.repository }}" --auto-login
|
||||||
- name: Notify on failure
|
- name: Notify on failure
|
||||||
@@ -169,7 +171,10 @@ jobs:
|
|||||||
if: needs.detect-type.outputs.is-release == 'false'
|
if: needs.detect-type.outputs.is-release == 'false'
|
||||||
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: 15
|
||||||
|
concurrency:
|
||||||
|
group: sync-wiki-${{ github.repository }}
|
||||||
|
cancel-in-progress: false
|
||||||
defaults:
|
defaults:
|
||||||
run:
|
run:
|
||||||
shell: bash
|
shell: bash
|
||||||
@@ -184,8 +189,8 @@ jobs:
|
|||||||
CI_GITEA_TOKEN: ${{ secrets.CI_GITEA_TOKEN }}
|
CI_GITEA_TOKEN: ${{ secrets.CI_GITEA_TOKEN }}
|
||||||
PYTHONPATH: src
|
PYTHONPATH: src
|
||||||
run: |
|
run: |
|
||||||
. .venv/bin/activate
|
. .venv/bin/activate 2>/dev/null || true
|
||||||
python3 -m devx.ci.sync_wiki --repo "${{ github.repository }}" --strict
|
python3 -m devx.ci.sync_wiki --repo "${{ github.repository }}" --verify
|
||||||
- name: Notify on failure
|
- name: Notify on failure
|
||||||
if: failure()
|
if: failure()
|
||||||
env:
|
env:
|
||||||
@@ -201,7 +206,7 @@ jobs:
|
|||||||
--auto-login
|
--auto-login
|
||||||
|
|
||||||
badges:
|
badges:
|
||||||
needs: [detect-type]
|
needs: [detect-type, release]
|
||||||
if: always()
|
if: always()
|
||||||
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-quality:latest
|
||||||
@@ -225,7 +230,7 @@ jobs:
|
|||||||
env:
|
env:
|
||||||
PRE_COMMIT_ALLOW_NO_CONFIG: "1"
|
PRE_COMMIT_ALLOW_NO_CONFIG: "1"
|
||||||
run: |
|
run: |
|
||||||
. .venv/bin/activate
|
. .venv/bin/activate 2>/dev/null || true
|
||||||
python3 -m devx.ci.push_badges
|
python3 -m devx.ci.push_badges
|
||||||
- name: Notify on failure
|
- name: Notify on failure
|
||||||
if: failure()
|
if: failure()
|
||||||
@@ -262,7 +267,7 @@ jobs:
|
|||||||
DEVX_VIKUNJA_PROJECT_ID: "8"
|
DEVX_VIKUNJA_PROJECT_ID: "8"
|
||||||
PYTHONPATH: src
|
PYTHONPATH: src
|
||||||
run: |
|
run: |
|
||||||
. .venv/bin/activate
|
. .venv/bin/activate 2>/dev/null || true
|
||||||
python3 -m devx.ci.post_merge --git-sha "${{ github.sha }}"
|
python3 -m devx.ci.post_merge --git-sha "${{ github.sha }}"
|
||||||
- name: Notify on failure
|
- name: Notify on failure
|
||||||
if: failure()
|
if: failure()
|
||||||
@@ -295,9 +300,11 @@ jobs:
|
|||||||
env:
|
env:
|
||||||
CI_GITEA_TOKEN: ${{ secrets.CI_GITEA_TOKEN }}
|
CI_GITEA_TOKEN: ${{ secrets.CI_GITEA_TOKEN }}
|
||||||
PYTHONPATH: src
|
PYTHONPATH: src
|
||||||
|
DEVX_REPO_NAME: devx
|
||||||
|
DEVX_REPO_OWNER: oblachno-oss
|
||||||
run: |
|
run: |
|
||||||
. .venv/bin/activate
|
. .venv/bin/activate 2>/dev/null || true
|
||||||
python3 -m devx.tools.configure_repo --repo devx --owner oblachno-oss
|
python3 -m devx.tools.configure_repo
|
||||||
- name: Notify on failure
|
- name: Notify on failure
|
||||||
if: failure()
|
if: failure()
|
||||||
env:
|
env:
|
||||||
|
|||||||
@@ -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)
|
||||||
@@ -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)
|
||||||
@@ -71,11 +87,13 @@ src/devx/
|
|||||||
│ ├── distribute_items.py # Distribute generic items (VMs, hosts) across parallel runners (LPT)
|
│ ├── distribute_items.py # Distribute generic items (VMs, hosts) across parallel runners (LPT)
|
||||||
│ ├── 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, code blocks, orphans)
|
||||||
├── 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
|
||||||
@@ -83,19 +101,24 @@ 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)
|
||||||
└── 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
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -138,7 +161,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
|
||||||
@@ -203,14 +226,14 @@ After a PR is merged to master, the **post-merge workflow**
|
|||||||
- Pushes both the commit and tag to master
|
- Pushes both the commit and tag to master
|
||||||
|
|
||||||
3. **sync-wiki** — Syncs documentation to the Gitea wiki. Runs for ALL
|
3. **sync-wiki** — Syncs documentation to the Gitea wiki. Runs for ALL
|
||||||
non-release commits (not just when release succeeds), so docs-only
|
non-release commits (not only when release succeeds), so docs-only
|
||||||
changes still update the wiki.
|
changes still update the wiki.
|
||||||
|
|
||||||
4. **badges** — Generates and pushes quality badge SVGs to the `badges` branch.
|
4. **badges** — Generates and pushes quality badge SVGs to the `badges` branch.
|
||||||
Uses `if: always()` so it runs on every push, including release commits.
|
Uses `if: always()` so it runs on every push, including release commits.
|
||||||
|
|
||||||
5. **vikunja** — Marks the corresponding Vikunja task as done. Runs for ALL
|
5. **vikunja** — Marks the corresponding Vikunja task as done. Runs for ALL
|
||||||
non-release commits (not just when release succeeds), so infrastructure-only
|
non-release commits (not only when release succeeds), so infrastructure-only
|
||||||
changes still update the task tracker.
|
changes still update the task tracker.
|
||||||
|
|
||||||
6. **publish** — Runs after release succeeds (needs: release). Builds and
|
6. **publish** — Runs after release succeeds (needs: release). Builds and
|
||||||
@@ -306,14 +329,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
|
||||||
@@ -345,7 +368,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.
|
||||||
|
|
||||||
@@ -363,7 +386,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 |
|
||||||
|
|
||||||
@@ -375,12 +398,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
|
||||||
@@ -515,3 +538,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 (quality, release, publish, wiki sync, image build) |
|
||||||
|
| `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 (quality, release, publish, sync-wiki, 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"`.
|
||||||
|
|
||||||
|
|||||||
+192
@@ -2,6 +2,198 @@
|
|||||||
|
|
||||||
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.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
|
||||||
|
|
||||||
|
### Bug Fixes
|
||||||
|
|
||||||
|
- Retry wiki integrity check on transient API timeout
|
||||||
|
|
||||||
|
## [0.27.2] - 2026-06-29
|
||||||
|
|
||||||
|
### Bug Fixes
|
||||||
|
|
||||||
|
- Retry release push on non-fast-forward with rebase loop
|
||||||
|
|
||||||
|
## [0.27.1] - 2026-06-28
|
||||||
|
|
||||||
|
### Bug Fixes
|
||||||
|
|
||||||
|
- Exclude .devin/.terraform dirs from lint_docs, add duplicate heading excludes
|
||||||
|
|
||||||
|
## [0.27.0] - 2026-06-28
|
||||||
|
|
||||||
|
### Features
|
||||||
|
|
||||||
|
- Add lint_docs tool, fix doc_coverage/check_translations for any repo
|
||||||
|
|
||||||
|
## [0.26.4] - 2026-06-28
|
||||||
|
|
||||||
|
### Bug Fixes
|
||||||
|
|
||||||
|
- Wrap all user-facing strings with _() for i18n completeness
|
||||||
|
|
||||||
|
## [0.26.3] - 2026-06-28
|
||||||
|
|
||||||
|
### Bug Fixes
|
||||||
|
|
||||||
|
- Pin all dependencies to exact versions for reproducibility
|
||||||
|
|
||||||
|
## [0.26.2] - 2026-06-28
|
||||||
|
|
||||||
|
### Bug Fixes
|
||||||
|
|
||||||
|
- Block admin merge override and auto-approve with review token
|
||||||
|
|
||||||
## [0.26.1] - 2026-06-28
|
## [0.26.1] - 2026-06-28
|
||||||
|
|
||||||
### 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
|
||||||
|
.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
|
||||||
@@ -98,6 +105,8 @@ 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 +115,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.37.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.37.0"`) or use a version constraint
|
||||||
> (e.g., `"devx>=0.11.1,<0.12"`).
|
> (for example, `"devx>=0.37.0,<0.38"`).
|
||||||
|
|
||||||
### Optional extras
|
### Optional extras
|
||||||
|
|
||||||
@@ -158,6 +158,9 @@ python -m devx.ci.check_translations --translations path/to/translations.json
|
|||||||
# Documentation coverage check
|
# Documentation coverage check
|
||||||
python -m devx.ci.doc_coverage --fail-on-missing
|
python -m devx.ci.doc_coverage --fail-on-missing
|
||||||
|
|
||||||
|
# Documentation lint (structure, links, headings, TODOs)
|
||||||
|
python -m devx.ci.lint_docs --root .
|
||||||
|
|
||||||
# Validate a commit message
|
# Validate a commit message
|
||||||
python -m devx.ci.validate_commit_msg commit-msg.txt --branch master
|
python -m devx.ci.validate_commit_msg commit-msg.txt --branch master
|
||||||
|
|
||||||
@@ -369,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
|
||||||
@@ -417,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 |
|
||||||
@@ -431,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)
|
||||||
|
|||||||
@@ -13,7 +13,7 @@ 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 \
|
||||||
&& python3 -m devx.tools.install_checkmake
|
&& python3 -m devx.tools.install_checkmake
|
||||||
|
|
||||||
# Install hadolint (Dockerfile linter)
|
# Install hadolint (Dockerfile linter)
|
||||||
|
|||||||
+10
-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.37.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.37.0"` or `"devx>=0.37.0,<0.38"`.
|
||||||
|
|
||||||
### 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.
|
||||||
@@ -158,6 +158,7 @@ for the full configuration reference, PR workflow, and project conventions.
|
|||||||
## Wiki pages
|
## Wiki pages
|
||||||
|
|
||||||
- [Home](Home) — This page
|
- [Home](Home) — This page
|
||||||
|
- [Getting Started](Getting-Started) — Installation, configuration, and quick start guide
|
||||||
- [CLI Commands](CLI-Commands) — Full CLI command documentation with examples
|
- [CLI Commands](CLI-Commands) — Full CLI command documentation with examples
|
||||||
- [Architecture](Architecture) — Package structure, module descriptions, design principles
|
- [Architecture](Architecture) — Package structure, module descriptions, design principles
|
||||||
- [CI/CD Workflow](CI-CD-Workflow) — Pipeline documentation, workflows, and CI scripts
|
- [CI/CD Workflow](CI-CD-Workflow) — Pipeline documentation, workflows, and CI scripts
|
||||||
|
|||||||
@@ -1,5 +1,6 @@
|
|||||||
{
|
{
|
||||||
"index.md": "Home",
|
"index.md": "Home",
|
||||||
|
"user/getting-started.md": "Getting-Started",
|
||||||
"user/cli-commands.md": "CLI-Commands",
|
"user/cli-commands.md": "CLI-Commands",
|
||||||
"tech/architecture.md": "Architecture",
|
"tech/architecture.md": "Architecture",
|
||||||
"tech/ci-cd-workflow.md": "CI-CD-Workflow"
|
"tech/ci-cd-workflow.md": "CI-CD-Workflow"
|
||||||
|
|||||||
+14
-12
@@ -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)
|
||||||
@@ -86,7 +86,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 +103,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 +122,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 +208,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 +311,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
|
||||||
@@ -382,7 +384,7 @@ single-role (4-part) and multi-role (5-part) pair encoding.
|
|||||||
Runs all molecule scenarios on all supported OS platforms sequentially.
|
Runs all molecule scenarios on all supported OS platforms sequentially.
|
||||||
Intended for local development; CI uses the parallel matrix instead.
|
Intended for local development; CI uses the parallel matrix instead.
|
||||||
|
|
||||||
### `discover_runners.py`
|
### `molecule/discover_runners.py`
|
||||||
|
|
||||||
Discovers available Gitea Actions runners for molecule tests. Same logic as
|
Discovers available Gitea Actions runners for molecule tests. Same logic as
|
||||||
`devx.ci.discover_runners` but intended for molecule-specific workflows.
|
`devx.ci.discover_runners` but intended for molecule-specific workflows.
|
||||||
@@ -432,14 +434,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)
|
||||||
│
|
│
|
||||||
▼
|
▼
|
||||||
@@ -475,7 +477,7 @@ 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>")
|
||||||
│
|
│
|
||||||
▼
|
▼
|
||||||
@@ -519,7 +521,7 @@ Post-merge workflow (post-merge.yml) triggers:
|
|||||||
|
|
||||||
### Publish flow
|
### Publish flow
|
||||||
|
|
||||||
```
|
```text
|
||||||
Tag push (vX.Y.Z) triggers publish workflow (publish.yml):
|
Tag push (vX.Y.Z) triggers publish workflow (publish.yml):
|
||||||
│
|
│
|
||||||
▼
|
▼
|
||||||
@@ -536,7 +538,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
|
||||||
|
|||||||
@@ -6,7 +6,7 @@ tag-triggered publishing.
|
|||||||
|
|
||||||
## Workflow overview
|
## Workflow overview
|
||||||
|
|
||||||
```
|
```text
|
||||||
PR opened/synchronized ──► CI (ci.yml)
|
PR opened/synchronized ──► CI (ci.yml)
|
||||||
│ ├── quality
|
│ ├── quality
|
||||||
│ ├── detect-changes
|
│ ├── detect-changes
|
||||||
@@ -93,7 +93,7 @@ Depends on `quality`, `detect-changes`, and `pr-review`. The final job in the
|
|||||||
CI workflow. Runs `python -m devx.ci.auto_merge` with the branch name, PR
|
CI workflow. Runs `python -m devx.ci.auto_merge` with the branch name, PR
|
||||||
title, repository, and PR number:
|
title, repository, 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
|
||||||
@@ -143,7 +143,7 @@ updates.
|
|||||||
|
|
||||||
### Job dependency graph
|
### Job dependency graph
|
||||||
|
|
||||||
```
|
```text
|
||||||
detect-type ──┬── validate-commit-msg (skip if release commit)
|
detect-type ──┬── validate-commit-msg (skip if release commit)
|
||||||
├── release (skip if release commit)
|
├── release (skip if release commit)
|
||||||
│ │
|
│ │
|
||||||
@@ -166,7 +166,7 @@ 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 jobs skip. The tag push triggers `publish.yml`.
|
||||||
|
|
||||||
### Jobs
|
### Post-merge jobs
|
||||||
|
|
||||||
#### `detect-type`
|
#### `detect-type`
|
||||||
|
|
||||||
@@ -205,7 +205,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
|
||||||
@@ -251,7 +251,7 @@ 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 job 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`,
|
||||||
@@ -329,7 +329,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.
|
||||||
|
|||||||
@@ -127,14 +127,37 @@ Click commands from `cli.py` and checks if each has documentation in
|
|||||||
|
|
||||||
```bash
|
```bash
|
||||||
devx ci doc-coverage
|
devx ci doc-coverage
|
||||||
devx ci doc-coverage --docs-dir docs/ --fail-on-missing
|
devx ci doc-coverage --docs-dir docs/ --source-dir src/ --fail-on-missing
|
||||||
```
|
```
|
||||||
|
|
||||||
Options:
|
Options:
|
||||||
- `--docs-dir <dir>` — path to the docs directory (default: `docs/`)
|
- `--docs-dir <dir>` — path to the docs directory (default: `docs/`)
|
||||||
|
- `--source-dir <dir>` — path to the source directory (default: auto-detect)
|
||||||
- `--fail-on-missing` — exit with non-zero status if any documentation is
|
- `--fail-on-missing` — exit with non-zero status if any documentation is
|
||||||
missing
|
missing
|
||||||
|
|
||||||
|
### `devx ci lint-docs`
|
||||||
|
|
||||||
|
Lint documentation files for structure, broken links, heading hierarchy,
|
||||||
|
duplicate headings, TODO/FIXME markers, and trailing whitespace.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
devx ci lint-docs
|
||||||
|
devx ci lint-docs --root . --fix
|
||||||
|
devx ci lint-docs --no-check-links --no-check-stale
|
||||||
|
```
|
||||||
|
|
||||||
|
Options:
|
||||||
|
- `--root <dir>` — repository root directory (default: `.`)
|
||||||
|
- `--docs-dir <dir>` — docs directory (default: `<root>/docs`)
|
||||||
|
- `--check-links/--no-check-links` — check internal links (default: yes)
|
||||||
|
- `--check-headings/--no-check-headings` — check heading hierarchy (default: yes)
|
||||||
|
- `--check-todo/--no-check-todo` — check for TODO/FIXME markers (default: yes)
|
||||||
|
- `--check-stale/--no-check-stale` — check for stale docs (default: no)
|
||||||
|
- `--check-trailing/--no-check-trailing` — check trailing whitespace (default: yes)
|
||||||
|
- `--check-duplicates/--no-check-duplicates` — check duplicate headings (default: yes)
|
||||||
|
- `--fix` — auto-fix trailing whitespace
|
||||||
|
|
||||||
### `devx ci integration-guard`
|
### `devx ci integration-guard`
|
||||||
|
|
||||||
Run pytest with cross-runner failure detection. If any
|
Run pytest with cross-runner failure detection. If any
|
||||||
@@ -382,7 +405,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`.
|
||||||
|
|
||||||
@@ -398,6 +421,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]`).
|
||||||
|
|||||||
@@ -0,0 +1,161 @@
|
|||||||
|
# Getting Started with devx
|
||||||
|
|
||||||
|
This guide walks you through installing devx, configuring it for your project,
|
||||||
|
and setting up a complete CI/CD pipeline.
|
||||||
|
|
||||||
|
## Prerequisites
|
||||||
|
|
||||||
|
- **Python 3.12+**
|
||||||
|
- **A Gitea instance** with Actions enabled
|
||||||
|
- **A Gitea API token** with repo, workflow, and organization scopes
|
||||||
|
- **(Optional) Vikunja API token** for task tracking integration
|
||||||
|
|
||||||
|
## Installation
|
||||||
|
|
||||||
|
devx is published to the Gitea PyPI registry. Configure pip to use it:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Configure Gitea PyPI registry
|
||||||
|
pip config set global.extra-index-url https://git.oblachno.oblachno.fyi/api/packages/oblachno-oss/pypi/simple
|
||||||
|
|
||||||
|
# Install devx
|
||||||
|
pip install devx
|
||||||
|
```
|
||||||
|
|
||||||
|
Or install from source:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
git clone https://git.oblachno.oblachno.fyi/oblachno-oss/devx.git
|
||||||
|
cd devx
|
||||||
|
make setup
|
||||||
|
```
|
||||||
|
|
||||||
|
## Quick Start
|
||||||
|
|
||||||
|
### 1. Configure environment variables
|
||||||
|
|
||||||
|
Create a `.env` file in your project root:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
CI_GITEA_TOKEN=your_gitea_api_token
|
||||||
|
VIKUNJA_TOKEN=your_vikunja_api_token # optional
|
||||||
|
```
|
||||||
|
|
||||||
|
### 2. Add devx to your project
|
||||||
|
|
||||||
|
Add devx to your `pyproject.toml`:
|
||||||
|
|
||||||
|
```toml
|
||||||
|
[project]
|
||||||
|
dependencies = [
|
||||||
|
"devx>=0.37.0",
|
||||||
|
]
|
||||||
|
|
||||||
|
[project.optional-dependencies]
|
||||||
|
dev = [
|
||||||
|
"devx>=0.37.0",
|
||||||
|
]
|
||||||
|
```
|
||||||
|
|
||||||
|
### 3. Set up the Makefile
|
||||||
|
|
||||||
|
devx provides a shared Makefile fragment. Add this to your `Makefile`:
|
||||||
|
|
||||||
|
```makefile
|
||||||
|
include devx.mak
|
||||||
|
```
|
||||||
|
|
||||||
|
Run `devx tools setup` to install all development tools (actionlint, git-cliff,
|
||||||
|
tea CLI, etc.) and configure pre-commit hooks.
|
||||||
|
|
||||||
|
### 4. Create the docs structure
|
||||||
|
|
||||||
|
devx expects a `docs/` directory with at minimum:
|
||||||
|
|
||||||
|
```text
|
||||||
|
docs/
|
||||||
|
├── index.md # Documentation home page
|
||||||
|
├── mapping.json # Wiki page title mappings
|
||||||
|
├── user/ # User-facing documentation
|
||||||
|
│ └── cli-commands.md
|
||||||
|
└── tech/ # Technical documentation
|
||||||
|
├── architecture.md
|
||||||
|
└── ci-cd-workflow.md
|
||||||
|
```
|
||||||
|
|
||||||
|
Example `docs/mapping.json`:
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"index.md": "Home",
|
||||||
|
"user/cli-commands.md": "CLI-Commands",
|
||||||
|
"tech/architecture.md": "Architecture",
|
||||||
|
"tech/ci-cd-workflow.md": "CI-CD-Workflow"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### 5. Set up CI workflows
|
||||||
|
|
||||||
|
Create `.gitea/workflows/ci.yml` and `.gitea/workflows/post-merge.yml` in your
|
||||||
|
project. See the [CI/CD Workflow guide](../tech/ci-cd-workflow.md) for details.
|
||||||
|
|
||||||
|
### 6. Configure release settings
|
||||||
|
|
||||||
|
Add a `cliff.toml` for git-cliff-based versioning:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
devx tools generate-cliff-config
|
||||||
|
```
|
||||||
|
|
||||||
|
Add `[tool.devx]` section to `pyproject.toml` for project-specific config:
|
||||||
|
|
||||||
|
```toml
|
||||||
|
[tool.devx]
|
||||||
|
# Vikunja project ID for task tracking
|
||||||
|
vikunja_project_id = 6
|
||||||
|
|
||||||
|
[tool.devx.classify]
|
||||||
|
# File patterns that are infrastructure (no release needed)
|
||||||
|
infrastructure = [
|
||||||
|
".gitea/**",
|
||||||
|
"docs/**",
|
||||||
|
"tests/**",
|
||||||
|
"AGENTS.md",
|
||||||
|
"README.md",
|
||||||
|
"CHANGELOG.md",
|
||||||
|
]
|
||||||
|
```
|
||||||
|
|
||||||
|
## Available Tools
|
||||||
|
|
||||||
|
### CI/CD Automation (`devx.ci.*`)
|
||||||
|
|
||||||
|
- `devx.ci.release` — Automated semver versioning and tagging
|
||||||
|
- `devx.ci.publish` — Package publishing to Gitea PyPI registry
|
||||||
|
- `devx.ci.auto_merge` — Squash-merge automation with task ID validation
|
||||||
|
- `devx.ci.pr_review` — Automated PR review with inline comments
|
||||||
|
- `devx.ci.classify_changes` — User-facing vs workflow-only change detection
|
||||||
|
- `devx.ci.sync_wiki` — Push docs/ to Gitea wiki
|
||||||
|
- `devx.ci.doc_coverage` — Documentation coverage checker
|
||||||
|
- `devx.ci.lint_docs` — Documentation linter (structure, links, headings)
|
||||||
|
- `devx.ci.check_translations` — i18n translation completeness checker
|
||||||
|
- `devx.ci.notify_failure` — Create Gitea issues on CI failures
|
||||||
|
- `devx.ci.distribute_files` — Parallel test file distribution
|
||||||
|
- `devx.ci.distribute_items` — Parallel item distribution across runners
|
||||||
|
- `devx.ci.discover_runners` — Dynamic runner discovery via Gitea API
|
||||||
|
|
||||||
|
### Development Tools (`devx.tools.*`)
|
||||||
|
|
||||||
|
- `devx.tools.setup` — Environment setup (venv, deps, hooks, tools)
|
||||||
|
- `devx.tools.install_tools` — Install CI/CD tools (actionlint, git-cliff, tea)
|
||||||
|
- `devx.tools.create_task` — Create Vikunja tasks
|
||||||
|
- `devx.tools.create_pr` — Create Gitea PRs with task ID in title
|
||||||
|
- `devx.tools.configure_repo` — Configure branch protection and labels
|
||||||
|
- `devx.tools.generate_badges` — Generate quality badge SVGs
|
||||||
|
- `devx.tools.check_test_speed` — Enforce test execution speed limits
|
||||||
|
|
||||||
|
## Next Steps
|
||||||
|
|
||||||
|
- Read the [CLI Commands reference](cli-commands.md) for all available commands
|
||||||
|
- Read the [Architecture guide](../tech/architecture.md) to understand internals
|
||||||
|
- Read the [CI/CD Workflow guide](../tech/ci-cd-workflow.md) for pipeline details
|
||||||
+34
-26
@@ -13,11 +13,13 @@ classifiers = [
|
|||||||
"Programming Language :: Python :: 3",
|
"Programming Language :: Python :: 3",
|
||||||
"License :: OSI Approved :: GNU General Public License v3 (GPLv3)",
|
"License :: OSI Approved :: GNU General Public License v3 (GPLv3)",
|
||||||
]
|
]
|
||||||
|
# All dependencies are pinned to exact versions for full reproducibility.
|
||||||
|
# Update pinned versions in a dedicated PR with verification.
|
||||||
dependencies = [
|
dependencies = [
|
||||||
"requests>=2.34.2",
|
"requests==2.34.2",
|
||||||
"python-dotenv>=1.2.2",
|
"python-dotenv==1.2.2",
|
||||||
"click>=8.4.1",
|
"click==8.4.2",
|
||||||
"tenacity>=8.2", # retry logic for GiteaClient/VikunjaClient
|
"tenacity==9.1.4", # retry logic for GiteaClient/VikunjaClient
|
||||||
]
|
]
|
||||||
|
|
||||||
[project.scripts]
|
[project.scripts]
|
||||||
@@ -29,44 +31,44 @@ version = {attr = "devx.__version__"}
|
|||||||
[project.optional-dependencies]
|
[project.optional-dependencies]
|
||||||
# Test runners (pytest + coverage + parallel execution)
|
# Test runners (pytest + coverage + parallel execution)
|
||||||
ci = [
|
ci = [
|
||||||
"pytest>=9.1.0",
|
"pytest==9.1.1",
|
||||||
"pytest-cov>=7.1.0",
|
"pytest-cov==7.1.0",
|
||||||
"pytest-xdist>=3.8",
|
"pytest-xdist==3.8.0",
|
||||||
]
|
]
|
||||||
# Lint and type-checking tools (quality job, badge generation)
|
# Lint and type-checking tools (quality job, badge generation)
|
||||||
lint = [
|
lint = [
|
||||||
"ruff>=0.15.17",
|
"ruff==0.15.20",
|
||||||
"pyright>=1.1.410",
|
"pyright==1.1.411",
|
||||||
"bandit>=1.8.2",
|
"bandit==1.9.4",
|
||||||
"pip-audit>=2.10",
|
"pip-audit==2.10.1",
|
||||||
"pre-commit>=4.6.0",
|
"pre-commit==4.6.0",
|
||||||
]
|
]
|
||||||
# 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.0",
|
||||||
"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.4.0",
|
||||||
"molecule-docker>=2.1.0",
|
"molecule-docker==2.1.0",
|
||||||
"ansible-lint>=26.4.0",
|
"ansible-lint==26.4.0",
|
||||||
"ansible-core>=2.15,<2.17",
|
"ansible-core==2.21.1",
|
||||||
]
|
]
|
||||||
# Deploy tools (for infra staging/production deployments)
|
# Deploy tools (for infra staging/production deployments)
|
||||||
deploy = [
|
deploy = [
|
||||||
"ansible-core>=2.15,<2.17",
|
"ansible-core==2.21.1",
|
||||||
"boto3>=1.34",
|
"boto3==1.43.36",
|
||||||
"docker>=7.0",
|
"docker==7.1.0",
|
||||||
"jinja2>=3.1",
|
"jinja2==3.1.6",
|
||||||
"pyyaml>=6.0",
|
"pyyaml==6.0.3",
|
||||||
"cryptography>=41.0",
|
"cryptography==49.0.0",
|
||||||
]
|
]
|
||||||
# Full dev environment (local development)
|
# Full dev environment (local development)
|
||||||
dev = [
|
dev = [
|
||||||
"devx[ci,lint,release,molecule]",
|
"devx[ci,lint,release,molecule]",
|
||||||
"build>=1.3.0",
|
"build==1.5.0",
|
||||||
"twine>=6.2.0",
|
"twine==6.2.0",
|
||||||
]
|
]
|
||||||
|
|
||||||
[tool.setuptools.packages.find]
|
[tool.setuptools.packages.find]
|
||||||
@@ -119,6 +121,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.26.1"
|
__version__ = "0.37.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."""
|
||||||
|
|||||||
+38
-13
@@ -41,6 +41,9 @@ from devx.config import (
|
|||||||
from devx.exceptions import APIError
|
from devx.exceptions import APIError
|
||||||
from devx.i18n import _
|
from devx.i18n import _
|
||||||
|
|
||||||
|
# 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+.+")
|
||||||
|
|
||||||
@@ -168,19 +171,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 ""
|
||||||
|
|
||||||
|
|
||||||
@@ -231,17 +238,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(
|
||||||
_(
|
_(
|
||||||
|
|||||||
@@ -31,11 +31,11 @@ from pathlib import Path
|
|||||||
|
|
||||||
import click
|
import click
|
||||||
|
|
||||||
REPO_ROOT = Path(__file__).resolve().parent.parent.parent.parent
|
REPO_ROOT = Path.cwd()
|
||||||
|
|
||||||
SUPPORTED_LANGS = ("en", "bg", "de", "ru", "zh", "pl")
|
SUPPORTED_LANGS = ("en", "bg", "de", "ru", "zh", "pl")
|
||||||
|
|
||||||
# Default translation set: devx package itself
|
# Default translation set: look for translations.json in the current repo
|
||||||
DEFAULT_TRANS_FILE = REPO_ROOT / "src" / "devx" / "translations.json"
|
DEFAULT_TRANS_FILE = REPO_ROOT / "src" / "devx" / "translations.json"
|
||||||
DEFAULT_SRC_DIR = REPO_ROOT / "src" / "devx"
|
DEFAULT_SRC_DIR = REPO_ROOT / "src" / "devx"
|
||||||
|
|
||||||
@@ -169,20 +169,44 @@ def print_result(result: TranslationCheckResult) -> None:
|
|||||||
"translations",
|
"translations",
|
||||||
multiple=True,
|
multiple=True,
|
||||||
type=click.Path(exists=False, path_type=Path),
|
type=click.Path(exists=False, path_type=Path),
|
||||||
help="Path to a translations JSON file to check (can be repeated). Defaults to src/devx/translations.json.",
|
help="Path to a translations JSON file to check (can be repeated). Auto-detects by default.",
|
||||||
)
|
)
|
||||||
def main(translations: tuple[Path, ...]) -> None:
|
@click.option(
|
||||||
|
"--source-dir",
|
||||||
|
default=None,
|
||||||
|
help="Source directory to scan for _() calls (default: auto-detect).",
|
||||||
|
)
|
||||||
|
def main(translations: tuple[Path, ...], source_dir: str | None) -> None:
|
||||||
"""Check translation files for gaps, dead keys, and missing languages."""
|
"""Check translation files for gaps, dead keys, and missing languages."""
|
||||||
|
results: list[TranslationCheckResult] = []
|
||||||
if not translations:
|
if not translations:
|
||||||
# Default: check the devx package's own translations
|
# Auto-detect translations file in the current repo
|
||||||
results = [
|
root = Path.cwd()
|
||||||
check_translation_set("devx", DEFAULT_SRC_DIR, DEFAULT_TRANS_FILE),
|
# Try common locations
|
||||||
|
candidates = [
|
||||||
|
root / "src" / "devx" / "translations.json",
|
||||||
|
root / "src" / "grm" / "translations.json",
|
||||||
]
|
]
|
||||||
|
# Also search for any translations.json in src/
|
||||||
|
for match in root.glob("src/*/translations.json"):
|
||||||
|
candidates.append(match)
|
||||||
|
|
||||||
|
found = False
|
||||||
|
for candidate in candidates:
|
||||||
|
if candidate.exists():
|
||||||
|
src_dir = Path(source_dir) if source_dir else candidate.parent
|
||||||
|
results.append(check_translation_set(candidate.parent.name, src_dir, candidate))
|
||||||
|
found = True
|
||||||
|
break
|
||||||
|
|
||||||
|
if not found:
|
||||||
|
# No translations file found — this repo doesn't use i18n
|
||||||
|
click.echo("PASS: No translations file found — skipping (repo does not use i18n).")
|
||||||
|
return
|
||||||
else:
|
else:
|
||||||
results = []
|
|
||||||
for trans_file in translations:
|
for trans_file in translations:
|
||||||
# Infer source directory as the parent of the translations file
|
# Infer source directory as the parent of the translations file
|
||||||
src_dir = trans_file.parent
|
src_dir = Path(source_dir) if source_dir else trans_file.parent
|
||||||
name = trans_file.parent.name
|
name = trans_file.parent.name
|
||||||
results.append(check_translation_set(name, src_dir, trans_file))
|
results.append(check_translation_set(name, src_dir, trans_file))
|
||||||
|
|
||||||
|
|||||||
@@ -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.
|
||||||
|
|
||||||
@@ -18,8 +21,10 @@ import subprocess # nosec B404
|
|||||||
import click
|
import click
|
||||||
|
|
||||||
from devx.ci._shared import write_github_output
|
from devx.ci._shared import write_github_output
|
||||||
|
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:
|
||||||
@@ -40,17 +45,31 @@ 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(f"Commit message: {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."))
|
||||||
|
|
||||||
|
|
||||||
if __name__ == "__main__": # pragma: no cover
|
if __name__ == "__main__": # pragma: no cover
|
||||||
|
|||||||
@@ -30,6 +30,7 @@ import click
|
|||||||
import requests
|
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 _
|
||||||
|
|
||||||
DEFAULT_MAX_RUNNERS = 3
|
DEFAULT_MAX_RUNNERS = 3
|
||||||
|
|
||||||
@@ -55,9 +56,9 @@ def query_runners(api_url: str, token: str, owner: str, repo: str) -> int:
|
|||||||
data = r.json()
|
data = r.json()
|
||||||
total += data.get("total_count", 0)
|
total += data.get("total_count", 0)
|
||||||
else:
|
else:
|
||||||
click.echo(f"Warning: repo-level runners query returned HTTP {r.status_code}", err=True)
|
click.echo(_("Warning: repo-level runners query returned HTTP {status}", status=r.status_code), err=True)
|
||||||
except (requests.RequestException, ValueError) as e:
|
except (requests.RequestException, ValueError) as e:
|
||||||
click.echo(f"Warning: repo-level runners query failed: {e}", err=True)
|
click.echo(_("Warning: repo-level runners query failed: {error}", error=e), err=True)
|
||||||
|
|
||||||
# 2. Organization-level runners
|
# 2. Organization-level runners
|
||||||
try:
|
try:
|
||||||
@@ -70,9 +71,9 @@ def query_runners(api_url: str, token: str, owner: str, repo: str) -> int:
|
|||||||
data = r.json()
|
data = r.json()
|
||||||
total += data.get("total_count", 0)
|
total += data.get("total_count", 0)
|
||||||
else:
|
else:
|
||||||
click.echo(f"Warning: org-level runners query returned HTTP {r.status_code}", err=True)
|
click.echo(_("Warning: org-level runners query returned HTTP {status}", status=r.status_code), err=True)
|
||||||
except (requests.RequestException, ValueError) as e:
|
except (requests.RequestException, ValueError) as e:
|
||||||
click.echo(f"Warning: org-level runners query failed: {e}", err=True)
|
click.echo(_("Warning: org-level runners query failed: {error}", error=e), err=True)
|
||||||
|
|
||||||
# 3. Instance-level runners (requires admin scope)
|
# 3. Instance-level runners (requires admin scope)
|
||||||
try:
|
try:
|
||||||
@@ -85,9 +86,12 @@ def query_runners(api_url: str, token: str, owner: str, repo: str) -> int:
|
|||||||
data = r.json()
|
data = r.json()
|
||||||
total += data.get("total_count", 0)
|
total += data.get("total_count", 0)
|
||||||
elif r.status_code != 403: # 403 is expected without admin scope
|
elif r.status_code != 403: # 403 is expected without admin scope
|
||||||
click.echo(f"Warning: instance-level runners query returned HTTP {r.status_code}", err=True)
|
click.echo(
|
||||||
|
_("Warning: instance-level runners query returned HTTP {status}", status=r.status_code),
|
||||||
|
err=True,
|
||||||
|
)
|
||||||
except (requests.RequestException, ValueError) as e:
|
except (requests.RequestException, ValueError) as e:
|
||||||
click.echo(f"Warning: instance-level runners query failed: {e}", err=True)
|
click.echo(_("Warning: instance-level runners query failed: {error}", error=e), err=True)
|
||||||
|
|
||||||
return total
|
return total
|
||||||
|
|
||||||
@@ -165,8 +169,8 @@ def main(
|
|||||||
with open(gh_output, "a", encoding="utf-8") as f: # noqa: PTH123
|
with open(gh_output, "a", encoding="utf-8") as f: # noqa: PTH123
|
||||||
f.write(f"runner-count={count}\n")
|
f.write(f"runner-count={count}\n")
|
||||||
f.write(f"runner-indices={json.dumps(indices)}\n")
|
f.write(f"runner-indices={json.dumps(indices)}\n")
|
||||||
click.echo(f"Runner count: {count}")
|
click.echo(_("Runner count: {count}", count=count))
|
||||||
click.echo(f"Runner indices: {indices}")
|
click.echo(_("Runner indices: {indices}", indices=indices))
|
||||||
return
|
return
|
||||||
|
|
||||||
if output_count:
|
if output_count:
|
||||||
@@ -178,8 +182,8 @@ def main(
|
|||||||
return
|
return
|
||||||
|
|
||||||
# Default: output both as key=value pairs for CI consumption
|
# Default: output both as key=value pairs for CI consumption
|
||||||
click.echo(f"count={count}")
|
click.echo(_("count={count}", count=count))
|
||||||
click.echo(f"indices={json.dumps(indices)}")
|
click.echo(_("indices={indices}", indices=json.dumps(indices)))
|
||||||
|
|
||||||
|
|
||||||
if __name__ == "__main__": # pragma: no cover
|
if __name__ == "__main__": # pragma: no cover
|
||||||
|
|||||||
@@ -102,17 +102,25 @@ def main(pattern: str, runner_index: int | None, max_runners: int, github_env: b
|
|||||||
groups = distribute(files, max_runners)
|
groups = distribute(files, max_runners)
|
||||||
for i, group in enumerate(groups):
|
for i, group in enumerate(groups):
|
||||||
labels = " ".join(group) if group else "(none)"
|
labels = " ".join(group) if group else "(none)"
|
||||||
click.echo(f"Runner {i}: {labels}")
|
click.echo(_("Runner {i}: {labels}", i=i, labels=labels))
|
||||||
return
|
return
|
||||||
|
|
||||||
if skip_if_excess and github_env and runner_index > max_runners:
|
if skip_if_excess and github_env and runner_index > max_runners:
|
||||||
click.echo(f"Skipping — runner index {runner_index} > max runners {max_runners}")
|
click.echo(
|
||||||
|
_(
|
||||||
|
"Skipping — runner index {runner_index} > max runners {max_runners}",
|
||||||
|
runner_index=runner_index,
|
||||||
|
max_runners=max_runners,
|
||||||
|
)
|
||||||
|
)
|
||||||
write_github_env("ASSIGNED_FILES", "")
|
write_github_env("ASSIGNED_FILES", "")
|
||||||
write_github_env("SKIP", "true")
|
write_github_env("SKIP", "true")
|
||||||
return
|
return
|
||||||
|
|
||||||
if runner_index < 1:
|
if runner_index < 1:
|
||||||
raise click.ClickException(f"Runner index {runner_index} is out of range (must be >= 1)")
|
raise click.ClickException(
|
||||||
|
_("Runner index {runner_index} is out of range (must be >= 1)", runner_index=runner_index)
|
||||||
|
)
|
||||||
|
|
||||||
zero_based = runner_index - 1
|
zero_based = runner_index - 1
|
||||||
assigned = files_for_runner(files, zero_based, max_runners)
|
assigned = files_for_runner(files, zero_based, max_runners)
|
||||||
@@ -121,7 +129,7 @@ def main(pattern: str, runner_index: int | None, max_runners: int, github_env: b
|
|||||||
if github_env:
|
if github_env:
|
||||||
write_github_env("ASSIGNED_FILES", encoded)
|
write_github_env("ASSIGNED_FILES", encoded)
|
||||||
write_github_env("SKIP", "false")
|
write_github_env("SKIP", "false")
|
||||||
click.echo(f"Assigned {len(assigned)} files to runner {runner_index}")
|
click.echo(_("Assigned {count} files to runner {runner_index}", count=len(assigned), runner_index=runner_index))
|
||||||
return
|
return
|
||||||
|
|
||||||
click.echo(encoded)
|
click.echo(encoded)
|
||||||
|
|||||||
@@ -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
|
||||||
@@ -162,17 +162,25 @@ def main(
|
|||||||
groups = distribute(items, weights, max_runners)
|
groups = distribute(items, weights, max_runners)
|
||||||
for i, group in enumerate(groups):
|
for i, group in enumerate(groups):
|
||||||
labels = " ".join(group) if group else "(none)"
|
labels = " ".join(group) if group else "(none)"
|
||||||
click.echo(f"Runner {i}: {labels}")
|
click.echo(_("Runner {i}: {labels}", i=i, labels=labels))
|
||||||
return
|
return
|
||||||
|
|
||||||
if skip_if_excess and github_env and runner_index > max_runners:
|
if skip_if_excess and github_env and runner_index > max_runners:
|
||||||
click.echo(f"Skipping — runner index {runner_index} > max runners {max_runners}")
|
click.echo(
|
||||||
|
_(
|
||||||
|
"Skipping — runner index {runner_index} > max runners {max_runners}",
|
||||||
|
runner_index=runner_index,
|
||||||
|
max_runners=max_runners,
|
||||||
|
)
|
||||||
|
)
|
||||||
write_github_env("ASSIGNED_ITEMS", "")
|
write_github_env("ASSIGNED_ITEMS", "")
|
||||||
write_github_env("SKIP", "true")
|
write_github_env("SKIP", "true")
|
||||||
return
|
return
|
||||||
|
|
||||||
if runner_index < 1:
|
if runner_index < 1:
|
||||||
raise click.ClickException(f"Runner index {runner_index} is out of range (must be >= 1)")
|
raise click.ClickException(
|
||||||
|
_("Runner index {runner_index} is out of range (must be >= 1)", runner_index=runner_index)
|
||||||
|
)
|
||||||
|
|
||||||
zero_based = runner_index - 1
|
zero_based = runner_index - 1
|
||||||
assigned = items_for_runner(items, weights, zero_based, max_runners)
|
assigned = items_for_runner(items, weights, zero_based, max_runners)
|
||||||
@@ -181,7 +189,14 @@ def main(
|
|||||||
if github_env:
|
if github_env:
|
||||||
write_github_env("ASSIGNED_ITEMS", encoded)
|
write_github_env("ASSIGNED_ITEMS", encoded)
|
||||||
write_github_env("SKIP", "false")
|
write_github_env("SKIP", "false")
|
||||||
click.echo(f"Assigned {len(assigned)} items to runner {runner_index}: {encoded}")
|
click.echo(
|
||||||
|
_(
|
||||||
|
"Assigned {count} items to runner {runner_index}: {encoded}",
|
||||||
|
count=len(assigned),
|
||||||
|
runner_index=runner_index,
|
||||||
|
encoded=encoded,
|
||||||
|
)
|
||||||
|
)
|
||||||
return
|
return
|
||||||
|
|
||||||
click.echo(encoded)
|
click.echo(encoded)
|
||||||
|
|||||||
+112
-19
@@ -5,8 +5,12 @@ Parses Click commands from the CLI source code and checks if each command
|
|||||||
has corresponding documentation in the wiki/docs. Reports missing
|
has corresponding documentation in the wiki/docs. Reports missing
|
||||||
documentation as warnings and exits with non-zero if coverage is below 100%.
|
documentation as warnings and exits with non-zero if coverage is below 100%.
|
||||||
|
|
||||||
|
By default, checks the current repository's own source and docs directories.
|
||||||
|
When run from the devx package itself (development mode), it checks devx's
|
||||||
|
own files. When installed as a package, it checks the consuming repo's files.
|
||||||
|
|
||||||
Usage:
|
Usage:
|
||||||
python3 -m devx.ci.doc_coverage [--docs-dir docs/] [--fail-on-missing]
|
python3 -m devx.ci.doc_coverage [--docs-dir docs/] [--source-dir src/] [--fail-on-missing]
|
||||||
"""
|
"""
|
||||||
|
|
||||||
from __future__ import annotations
|
from __future__ import annotations
|
||||||
@@ -17,13 +21,15 @@ from pathlib import Path
|
|||||||
|
|
||||||
import click
|
import click
|
||||||
|
|
||||||
|
from devx.config import _load_pyproject_devx
|
||||||
from devx.i18n import _
|
from devx.i18n import _
|
||||||
|
|
||||||
REPO_ROOT = Path(__file__).resolve().parent.parent.parent.parent
|
# Default to the current working directory (consuming repo's root)
|
||||||
|
REPO_ROOT = Path.cwd()
|
||||||
DOCS_DIR = REPO_ROOT / "docs"
|
DOCS_DIR = REPO_ROOT / "docs"
|
||||||
CLI_FILE = REPO_ROOT / "src" / "devx" / "cli.py"
|
|
||||||
|
|
||||||
# Major modules that should be documented in tech/architecture.md
|
# Major modules that should be documented in tech/architecture.md
|
||||||
|
# These are devx-specific; when checking other repos, use --source-dir
|
||||||
REQUIRED_MODULES = [
|
REQUIRED_MODULES = [
|
||||||
"cli.py",
|
"cli.py",
|
||||||
"i18n.py",
|
"i18n.py",
|
||||||
@@ -51,22 +57,45 @@ REQUIRED_SCRIPTS = [
|
|||||||
]
|
]
|
||||||
|
|
||||||
|
|
||||||
def extract_cli_commands() -> list[str]:
|
def extract_cli_commands(source_dir: Path) -> list[str]:
|
||||||
"""Extract command names from the CLI source file."""
|
"""Extract command names from the CLI source file."""
|
||||||
if not CLI_FILE.exists():
|
# Try to find the CLI file in the source directory
|
||||||
|
cli_file = None
|
||||||
|
for candidate in source_dir.rglob("cli.py"):
|
||||||
|
cli_file = candidate
|
||||||
|
break
|
||||||
|
if cli_file is None or not cli_file.exists():
|
||||||
return []
|
return []
|
||||||
content = CLI_FILE.read_text()
|
content = cli_file.read_text()
|
||||||
commands: list[str] = []
|
commands: list[str] = []
|
||||||
# Find all @<group>.command("name") occurrences in the CLI source
|
# Find all @<group>.command("name") occurrences in the CLI source
|
||||||
# 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)
|
||||||
@@ -94,15 +123,52 @@ def check_module_documented(module: str, docs_content: str) -> bool:
|
|||||||
|
|
||||||
|
|
||||||
@click.command()
|
@click.command()
|
||||||
@click.option("--docs-dir", default=str(DOCS_DIR), help="Path to the docs directory.")
|
@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(
|
||||||
|
"--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, 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:
|
||||||
docs_path = Path(docs_dir)
|
root = Path.cwd()
|
||||||
|
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
|
||||||
|
if source_dir:
|
||||||
|
src_path = Path(source_dir)
|
||||||
|
else:
|
||||||
|
# Try common source directories
|
||||||
|
for candidate in [root / "src", root / "scripts"]:
|
||||||
|
if candidate.exists():
|
||||||
|
src_path = candidate
|
||||||
|
break
|
||||||
|
else:
|
||||||
|
src_path = root / "src"
|
||||||
|
|
||||||
cli_commands_file = docs_path / "user" / "cli-commands.md"
|
cli_commands_file = docs_path / "user" / "cli-commands.md"
|
||||||
architecture_file = docs_path / "tech" / "architecture.md"
|
architecture_file = docs_path / "tech" / "architecture.md"
|
||||||
ci_cd_file = docs_path / "tech" / "ci-cd-workflow.md"
|
ci_cd_file = docs_path / "tech" / "ci-cd-workflow.md"
|
||||||
@@ -112,21 +178,28 @@ def main(docs_dir: str, fail_on_missing: bool) -> None:
|
|||||||
|
|
||||||
# Check CLI commands
|
# Check CLI commands
|
||||||
click.echo(_("Checking CLI command documentation..."))
|
click.echo(_("Checking CLI command documentation..."))
|
||||||
commands = extract_cli_commands()
|
commands = extract_cli_commands(src_path)
|
||||||
total += len(commands)
|
total += len(commands)
|
||||||
cli_docs = cli_commands_file.read_text() if cli_commands_file.exists() else ""
|
cli_docs = cli_commands_file.read_text() if cli_commands_file.exists() else ""
|
||||||
for cmd in commands:
|
for cmd in commands:
|
||||||
if check_command_documented(cmd, cli_docs):
|
if check_command_documented(cmd, cli_docs):
|
||||||
click.echo(_(" OK: devx {cmd}", cmd=cmd))
|
click.echo(_(" OK: {cmd}", cmd=cmd))
|
||||||
else:
|
else:
|
||||||
click.echo(_(" MISSING: devx {cmd}", cmd=cmd))
|
click.echo(_(" MISSING: {cmd}", cmd=cmd))
|
||||||
missing.append(f"CLI command: devx {cmd}")
|
missing.append(f"CLI command: {cmd}")
|
||||||
|
|
||||||
# Check modules in architecture.md
|
# Check modules in architecture.md
|
||||||
|
# Auto-detect modules from source directory (top-level only, exclude subdirs)
|
||||||
click.echo(_("\nChecking module documentation in architecture.md..."))
|
click.echo(_("\nChecking module documentation in architecture.md..."))
|
||||||
total += len(REQUIRED_MODULES)
|
if src_path.exists():
|
||||||
|
detected_modules = sorted(
|
||||||
|
f.name for f in src_path.glob("*.py") if f.name != "__init__.py" and f.name != "cli.py"
|
||||||
|
)
|
||||||
|
else:
|
||||||
|
detected_modules = REQUIRED_MODULES
|
||||||
|
total += len(detected_modules)
|
||||||
arch_docs = architecture_file.read_text() if architecture_file.exists() else ""
|
arch_docs = architecture_file.read_text() if architecture_file.exists() else ""
|
||||||
for module in REQUIRED_MODULES:
|
for module in detected_modules:
|
||||||
if check_module_documented(module, arch_docs):
|
if check_module_documented(module, arch_docs):
|
||||||
click.echo(_(" OK: {module}", module=module))
|
click.echo(_(" OK: {module}", module=module))
|
||||||
else:
|
else:
|
||||||
@@ -134,10 +207,30 @@ def main(docs_dir: str, fail_on_missing: bool) -> None:
|
|||||||
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, 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..."))
|
||||||
total += len(REQUIRED_SCRIPTS)
|
if ci_scripts_dir is not None:
|
||||||
|
# Explicit config — empty string means skip CI script checks
|
||||||
|
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:
|
||||||
|
# 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)
|
||||||
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 REQUIRED_SCRIPTS:
|
for script in detected_scripts:
|
||||||
if check_module_documented(script, ci_docs):
|
if check_module_documented(script, ci_docs):
|
||||||
click.echo(_(" OK: {script}", script=script))
|
click.echo(_(" OK: {script}", script=script))
|
||||||
else:
|
else:
|
||||||
|
|||||||
@@ -86,7 +86,7 @@ def cli(pytest_args: tuple[str, ...]) -> None:
|
|||||||
cmd = [sys.executable, "-m", "pytest"]
|
cmd = [sys.executable, "-m", "pytest"]
|
||||||
cmd.extend(pytest_args)
|
cmd.extend(pytest_args)
|
||||||
|
|
||||||
click.echo(f"Running: {' '.join(cmd)}")
|
click.echo(_("Running: {cmd}", cmd=" ".join(cmd)))
|
||||||
|
|
||||||
process = subprocess.Popen( # nosec B603
|
process = subprocess.Popen( # nosec B603
|
||||||
cmd,
|
cmd,
|
||||||
|
|||||||
@@ -0,0 +1,587 @@
|
|||||||
|
#!/usr/bin/env python3
|
||||||
|
"""Lint documentation files for structure, links, and quality.
|
||||||
|
|
||||||
|
Checks performed (all configurable via pyproject.toml ``[tool.devx.docs]``):
|
||||||
|
- **Required files**: README.md, AGENTS.md, CHANGELOG.md must exist.
|
||||||
|
- **Docs structure**: ``docs/index.md`` and ``docs/mapping.json`` must exist.
|
||||||
|
- **Broken internal links**: relative paths and anchors in markdown files
|
||||||
|
must resolve to actual files and headings.
|
||||||
|
- **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.
|
||||||
|
- **Stale docs**: files not modified in >180 days (warning only).
|
||||||
|
- **Trailing whitespace**: lines should not end with whitespace.
|
||||||
|
- **Blank line before headings**: headings should have a blank line before them.
|
||||||
|
|
||||||
|
Usage::
|
||||||
|
|
||||||
|
python3 -m devx.ci.lint_docs
|
||||||
|
python3 -m devx.ci.lint_docs --docs-dir docs/ --root .
|
||||||
|
python3 -m devx.ci.lint_docs --fix # auto-fix trailing whitespace
|
||||||
|
"""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import json
|
||||||
|
import re
|
||||||
|
import sys
|
||||||
|
from datetime import datetime, timedelta
|
||||||
|
from pathlib import Path
|
||||||
|
|
||||||
|
import click
|
||||||
|
|
||||||
|
from devx.i18n import _
|
||||||
|
|
||||||
|
# Heading slug pattern (GitHub-style)
|
||||||
|
_HEADING_RE = re.compile(r"^(#{1,6})\s+(.+?)\s*$", re.MULTILINE)
|
||||||
|
# Markdown link pattern: [text](url)
|
||||||
|
_LINK_RE = re.compile(r"\[([^\]]*)\]\(([^)]+)\)")
|
||||||
|
# Trailing whitespace
|
||||||
|
_TRAILING_WS_RE = re.compile(r"[ \t]+$")
|
||||||
|
# Heading without blank line before
|
||||||
|
_HEADING_NO_BLANK_RE = re.compile(r"([^\n])\n(#{1,6}\s)")
|
||||||
|
|
||||||
|
# Files that must exist in every project
|
||||||
|
REQUIRED_FILES = ["README.md", "AGENTS.md", "CHANGELOG.md"]
|
||||||
|
|
||||||
|
# Files that must exist in docs/
|
||||||
|
REQUIRED_DOC_FILES = ["index.md"]
|
||||||
|
|
||||||
|
# Maximum age for docs before they're considered stale (days)
|
||||||
|
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
|
||||||
|
# with repeated subsections under different parent sections)
|
||||||
|
DUPLICATE_HEADING_EXCLUDES = {
|
||||||
|
"CHANGELOG.md",
|
||||||
|
"incident-response-sso.md",
|
||||||
|
"role-sync-design.md",
|
||||||
|
}
|
||||||
|
|
||||||
|
# TODO/FIXME pattern — matches "TODO:" or "FIXME:" at start of line/after whitespace
|
||||||
|
# Does NOT match references to the word "TODO" in rules/documentation
|
||||||
|
_TODO_RE = re.compile(r"(?m)^\s*(?:>>>?\s*)?(TODO|FIXME|HACK|XXX)\s*:", re.IGNORECASE)
|
||||||
|
|
||||||
|
# Directories excluded from markdown file scanning
|
||||||
|
_EXCLUDE_DIRS = {
|
||||||
|
".venv",
|
||||||
|
".git",
|
||||||
|
"node_modules",
|
||||||
|
"__pycache__",
|
||||||
|
".pytest_cache",
|
||||||
|
".devin",
|
||||||
|
".terraform",
|
||||||
|
".vale",
|
||||||
|
"site-packages",
|
||||||
|
"dist-info",
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
def slugify(text: str) -> str:
|
||||||
|
"""Convert heading text to a GitHub-style slug."""
|
||||||
|
slug = text.lower().strip()
|
||||||
|
slug = re.sub(r"[^\w\s-]", "", slug)
|
||||||
|
slug = re.sub(r"[\s]+", "-", slug)
|
||||||
|
return slug
|
||||||
|
|
||||||
|
|
||||||
|
def strip_code_blocks(content: str) -> str:
|
||||||
|
"""Remove fenced code blocks from markdown content.
|
||||||
|
|
||||||
|
Replaces ```...``` blocks with empty lines so heading detection
|
||||||
|
doesn't pick up # comments inside code blocks.
|
||||||
|
"""
|
||||||
|
result: list[str] = []
|
||||||
|
in_code_block = False
|
||||||
|
for line in content.splitlines():
|
||||||
|
if line.strip().startswith("```"):
|
||||||
|
in_code_block = not in_code_block
|
||||||
|
result.append("")
|
||||||
|
continue
|
||||||
|
if in_code_block:
|
||||||
|
result.append("")
|
||||||
|
continue
|
||||||
|
result.append(line)
|
||||||
|
return "\n".join(result)
|
||||||
|
|
||||||
|
|
||||||
|
def extract_headings(filepath: Path) -> dict[str, int]:
|
||||||
|
"""Extract all headings from a markdown file.
|
||||||
|
|
||||||
|
Returns a dict mapping slug → heading level.
|
||||||
|
"""
|
||||||
|
content = strip_code_blocks(filepath.read_text(encoding="utf-8"))
|
||||||
|
headings: dict[str, int] = {}
|
||||||
|
for match in _HEADING_RE.finditer(content):
|
||||||
|
level = len(match.group(1))
|
||||||
|
text = match.group(2)
|
||||||
|
slug = slugify(text)
|
||||||
|
headings[slug] = level
|
||||||
|
return headings
|
||||||
|
|
||||||
|
|
||||||
|
def extract_links(filepath: Path) -> list[tuple[int, str, str]]:
|
||||||
|
"""Extract all markdown links from a file.
|
||||||
|
|
||||||
|
Returns a list of (line_number, link_text, url) tuples.
|
||||||
|
Includes anchor-only links (#section) for validation.
|
||||||
|
Skips external links (http/https) and mailto.
|
||||||
|
"""
|
||||||
|
content = filepath.read_text(encoding="utf-8")
|
||||||
|
links: list[tuple[int, str, str]] = []
|
||||||
|
for match in _LINK_RE.finditer(content):
|
||||||
|
url = match.group(2).strip()
|
||||||
|
# Skip external links and mailto
|
||||||
|
if url.startswith(("http://", "https://", "mailto:")):
|
||||||
|
continue
|
||||||
|
line_num = content[: match.start()].count("\n") + 1
|
||||||
|
links.append((line_num, match.group(1), url))
|
||||||
|
return links
|
||||||
|
|
||||||
|
|
||||||
|
def check_required_files(root: Path) -> list[str]:
|
||||||
|
"""Check that required files exist."""
|
||||||
|
issues: list[str] = []
|
||||||
|
for filename in REQUIRED_FILES:
|
||||||
|
if not (root / filename).exists():
|
||||||
|
issues.append(f"Missing required file: {filename}")
|
||||||
|
return issues
|
||||||
|
|
||||||
|
|
||||||
|
def check_docs_structure(root: Path, docs_dir: Path) -> list[str]:
|
||||||
|
"""Check that docs directory has required structure."""
|
||||||
|
issues: list[str] = []
|
||||||
|
if not docs_dir.exists():
|
||||||
|
issues.append(f"Docs directory not found: {docs_dir}")
|
||||||
|
return issues
|
||||||
|
for filename in REQUIRED_DOC_FILES:
|
||||||
|
if not (docs_dir / filename).exists():
|
||||||
|
issues.append(f"Missing required doc file: docs/{filename}")
|
||||||
|
mapping_file = docs_dir / "mapping.json"
|
||||||
|
if mapping_file.exists():
|
||||||
|
try:
|
||||||
|
mapping = json.loads(mapping_file.read_text(encoding="utf-8"))
|
||||||
|
if not isinstance(mapping, dict):
|
||||||
|
issues.append("docs/mapping.json must be a JSON object")
|
||||||
|
elif not mapping:
|
||||||
|
issues.append("docs/mapping.json is empty")
|
||||||
|
except json.JSONDecodeError as e:
|
||||||
|
issues.append(f"docs/mapping.json is invalid JSON: {e}")
|
||||||
|
return issues
|
||||||
|
|
||||||
|
|
||||||
|
def check_internal_links(root: Path, docs_dir: Path) -> list[str]:
|
||||||
|
"""Check that all internal links in markdown files resolve."""
|
||||||
|
issues: list[str] = []
|
||||||
|
md_files = list(root.rglob("*.md"))
|
||||||
|
# Exclude .venv, .git, node_modules
|
||||||
|
md_files = [f for f in md_files if not any(part in _EXCLUDE_DIRS for part in f.parts)]
|
||||||
|
|
||||||
|
# Load wiki page names from mapping.json — these are valid link targets
|
||||||
|
wiki_pages: set[str] = set()
|
||||||
|
mapping_file = docs_dir / "mapping.json"
|
||||||
|
if mapping_file.exists():
|
||||||
|
try:
|
||||||
|
mapping = json.loads(mapping_file.read_text(encoding="utf-8"))
|
||||||
|
wiki_pages = set(mapping.values())
|
||||||
|
except (json.JSONDecodeError, AttributeError):
|
||||||
|
pass
|
||||||
|
|
||||||
|
for md_file in md_files:
|
||||||
|
rel_path = md_file.relative_to(root)
|
||||||
|
links = extract_links(md_file)
|
||||||
|
headings = extract_headings(md_file)
|
||||||
|
|
||||||
|
for line_num, _link_text, url in links:
|
||||||
|
# Split into path and anchor
|
||||||
|
if "#" in url:
|
||||||
|
path_part, anchor = url.split("#", 1)
|
||||||
|
else:
|
||||||
|
path_part, anchor = url, ""
|
||||||
|
|
||||||
|
# Skip wiki page references (no file extension, no /, matches mapping.json values)
|
||||||
|
if path_part and "." not in path_part and "/" not in path_part:
|
||||||
|
if path_part in wiki_pages:
|
||||||
|
continue
|
||||||
|
# Also skip if it looks like a wiki page name (CamelCase or hyphenated)
|
||||||
|
# without a file extension — can't verify these locally
|
||||||
|
if not any(c in path_part for c in "/\\"):
|
||||||
|
continue
|
||||||
|
|
||||||
|
# Resolve relative path
|
||||||
|
if path_part:
|
||||||
|
target = (md_file.parent / path_part).resolve()
|
||||||
|
if not target.exists():
|
||||||
|
issues.append(f"{rel_path}:{line_num}: broken link '{url}' — file not found: {path_part}")
|
||||||
|
continue
|
||||||
|
# Check anchor in target file
|
||||||
|
if anchor:
|
||||||
|
target_headings = extract_headings(target)
|
||||||
|
target_slug = slugify(anchor)
|
||||||
|
if target_slug not in target_headings:
|
||||||
|
issues.append(f"{rel_path}:{line_num}: broken anchor '#{anchor}' in {path_part}")
|
||||||
|
elif anchor:
|
||||||
|
# Anchor-only link — check in current file
|
||||||
|
anchor_slug = slugify(anchor)
|
||||||
|
if anchor_slug not in headings:
|
||||||
|
issues.append(f"{rel_path}:{line_num}: broken anchor '#{anchor}'")
|
||||||
|
|
||||||
|
return issues
|
||||||
|
|
||||||
|
|
||||||
|
def check_heading_hierarchy(root: Path) -> list[str]:
|
||||||
|
"""Check that headings don't skip levels."""
|
||||||
|
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"))
|
||||||
|
prev_level = 0
|
||||||
|
for match in _HEADING_RE.finditer(content):
|
||||||
|
level = len(match.group(1))
|
||||||
|
if prev_level > 0 and level > prev_level + 1:
|
||||||
|
issues.append(f"{rel_path}: heading hierarchy skip — H{prev_level} → H{level}: '{match.group(2)}'")
|
||||||
|
prev_level = level
|
||||||
|
|
||||||
|
return issues
|
||||||
|
|
||||||
|
|
||||||
|
def check_todo_fixme(root: Path) -> list[str]:
|
||||||
|
"""Check for TODO/FIXME/HACK/XXX markers in documentation.
|
||||||
|
|
||||||
|
Only flags actual TODO/FIXME markers (e.g., "TODO: fix this"), not
|
||||||
|
references to the word "TODO" in rules or documentation about TODOs.
|
||||||
|
"""
|
||||||
|
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 match in _TODO_RE.finditer(content):
|
||||||
|
line_num = content[: match.start()].count("\n") + 1
|
||||||
|
line = content.splitlines()[line_num - 1] if line_num <= len(content.splitlines()) else ""
|
||||||
|
issues.append(f"{rel_path}:{line_num}: TODO/FIXME found: {line.strip()}")
|
||||||
|
|
||||||
|
return issues
|
||||||
|
|
||||||
|
|
||||||
|
def check_trailing_whitespace(root: Path) -> list[str]:
|
||||||
|
"""Check for trailing whitespace in markdown files."""
|
||||||
|
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 _TRAILING_WS_RE.search(line):
|
||||||
|
issues.append(f"{rel_path}:{i}: trailing whitespace")
|
||||||
|
|
||||||
|
return issues
|
||||||
|
|
||||||
|
|
||||||
|
def check_stale_docs(root: Path) -> list[str]:
|
||||||
|
"""Check for stale documentation (not modified in >180 days)."""
|
||||||
|
issues: list[str] = []
|
||||||
|
threshold = datetime.now() - timedelta(days=STALE_THRESHOLD_DAYS)
|
||||||
|
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)
|
||||||
|
mtime = datetime.fromtimestamp(md_file.stat().st_mtime)
|
||||||
|
if mtime < threshold:
|
||||||
|
days_old = (datetime.now() - mtime).days
|
||||||
|
issues.append(f"{rel_path}: stale doc — not modified in {days_old} days")
|
||||||
|
|
||||||
|
return issues
|
||||||
|
|
||||||
|
|
||||||
|
def check_duplicate_headings(root: Path) -> list[str]:
|
||||||
|
"""Check for duplicate headings within the same file."""
|
||||||
|
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)
|
||||||
|
# Skip auto-generated files like CHANGELOG.md
|
||||||
|
if md_file.name in DUPLICATE_HEADING_EXCLUDES:
|
||||||
|
continue
|
||||||
|
content = strip_code_blocks(md_file.read_text(encoding="utf-8"))
|
||||||
|
seen: dict[str, int] = {}
|
||||||
|
for match in _HEADING_RE.finditer(content):
|
||||||
|
text = match.group(2)
|
||||||
|
slug = slugify(text)
|
||||||
|
if slug in seen:
|
||||||
|
issues.append(f"{rel_path}: duplicate heading '{text}'")
|
||||||
|
seen[slug] = 1
|
||||||
|
|
||||||
|
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.option("--root", default=".", help="Repository root directory.")
|
||||||
|
@click.option("--docs-dir", default=None, help="Docs directory (default: <root>/docs).")
|
||||||
|
@click.option("--check-links/--no-check-links", default=True, help="Check internal links.")
|
||||||
|
@click.option("--check-headings/--no-check-headings", default=True, help="Check heading hierarchy.")
|
||||||
|
@click.option("--check-todo/--no-check-todo", default=True, help="Check for TODO/FIXME.")
|
||||||
|
@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-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.")
|
||||||
|
def main(
|
||||||
|
root: str,
|
||||||
|
docs_dir: str | None,
|
||||||
|
check_links: bool,
|
||||||
|
check_headings: bool,
|
||||||
|
check_todo: bool,
|
||||||
|
check_stale: bool,
|
||||||
|
check_trailing: bool,
|
||||||
|
check_duplicates: bool,
|
||||||
|
single_h1: bool,
|
||||||
|
depth: bool,
|
||||||
|
line_length: bool,
|
||||||
|
code_lang: bool,
|
||||||
|
orphans: bool,
|
||||||
|
fix: bool,
|
||||||
|
) -> None:
|
||||||
|
"""Lint documentation files for structure, links, and quality."""
|
||||||
|
root_path = Path(root).resolve()
|
||||||
|
docs_path = Path(docs_dir) if docs_dir else root_path / "docs"
|
||||||
|
|
||||||
|
click.echo(_("Linting documentation in {root}...", root=str(root_path)))
|
||||||
|
|
||||||
|
all_issues: list[str] = []
|
||||||
|
|
||||||
|
# Structure checks
|
||||||
|
click.echo(_("Checking required files..."))
|
||||||
|
all_issues.extend(check_required_files(root_path))
|
||||||
|
|
||||||
|
click.echo(_("Checking docs structure..."))
|
||||||
|
all_issues.extend(check_docs_structure(root_path, docs_path))
|
||||||
|
|
||||||
|
# Link checks
|
||||||
|
if check_links:
|
||||||
|
click.echo(_("Checking internal links..."))
|
||||||
|
all_issues.extend(check_internal_links(root_path, docs_path))
|
||||||
|
|
||||||
|
# Heading hierarchy
|
||||||
|
if check_headings:
|
||||||
|
click.echo(_("Checking heading hierarchy..."))
|
||||||
|
all_issues.extend(check_heading_hierarchy(root_path))
|
||||||
|
|
||||||
|
# Duplicate headings
|
||||||
|
if check_duplicates:
|
||||||
|
click.echo(_("Checking duplicate headings..."))
|
||||||
|
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
|
||||||
|
if check_todo:
|
||||||
|
click.echo(_("Checking for TODO/FIXME markers..."))
|
||||||
|
all_issues.extend(check_todo_fixme(root_path))
|
||||||
|
|
||||||
|
# Trailing whitespace
|
||||||
|
if check_trailing:
|
||||||
|
click.echo(_("Checking trailing whitespace..."))
|
||||||
|
ws_issues = check_trailing_whitespace(root_path)
|
||||||
|
if fix and ws_issues:
|
||||||
|
fixed = 0
|
||||||
|
md_files = [f for f in root_path.rglob("*.md") if not any(part in _EXCLUDE_DIRS for part in f.parts)]
|
||||||
|
for md_file in md_files:
|
||||||
|
content = md_file.read_text(encoding="utf-8")
|
||||||
|
fixed_content = _TRAILING_WS_RE.sub("", content)
|
||||||
|
if content != fixed_content:
|
||||||
|
md_file.write_text(fixed_content, encoding="utf-8")
|
||||||
|
fixed += 1
|
||||||
|
click.echo(_(" Auto-fixed trailing whitespace in {n} files", n=fixed))
|
||||||
|
else:
|
||||||
|
all_issues.extend(ws_issues)
|
||||||
|
|
||||||
|
# Stale docs (warnings)
|
||||||
|
if check_stale:
|
||||||
|
click.echo(_("Checking for stale docs..."))
|
||||||
|
stale = check_stale_docs(root_path)
|
||||||
|
for issue in stale:
|
||||||
|
click.echo(f" WARN: {issue}")
|
||||||
|
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
|
||||||
|
click.echo(f"\n{'=' * 60}")
|
||||||
|
if all_issues:
|
||||||
|
click.echo(_("FAIL: {n} documentation issues found:", n=len(all_issues)))
|
||||||
|
for issue in all_issues:
|
||||||
|
click.echo(f" - {issue}")
|
||||||
|
sys.exit(1)
|
||||||
|
else:
|
||||||
|
click.echo(_("PASS: All documentation checks passed!"))
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == "__main__": # pragma: no cover
|
||||||
|
main()
|
||||||
@@ -387,14 +387,34 @@ def check_documentation(files: list[dict[str, Any]], result: ReviewResult) -> No
|
|||||||
for f in files
|
for f in files
|
||||||
)
|
)
|
||||||
has_ansible_changes = any(f.get("filename", "").startswith("ansible/") for f in files)
|
has_ansible_changes = any(f.get("filename", "").startswith("ansible/") for f in files)
|
||||||
|
has_tofu_changes = any(f.get("filename", "").startswith("tofu/") for f in files)
|
||||||
|
has_workflow_changes = any(f.get("filename", "").startswith(".gitea/") for f in files)
|
||||||
|
|
||||||
|
# Check for TODO/FIXME in changed docs
|
||||||
|
todo_issues: list[str] = []
|
||||||
|
for f in files:
|
||||||
|
filename = f.get("filename", "")
|
||||||
|
if filename.endswith(".md") and filename.startswith(("docs/", "README", "AGENTS")):
|
||||||
|
# Can't check file content from PR API easily, but flag if patch adds TODO
|
||||||
|
patch = f.get("patch", "")
|
||||||
|
if patch and re.search(r"^\+.*\b(TODO|FIXME|HACK|XXX)\b", patch, re.IGNORECASE):
|
||||||
|
todo_issues.append(f"{filename}: new TODO/FIXME added in documentation")
|
||||||
|
|
||||||
if has_src_changes and not has_doc_changes:
|
if has_src_changes and not has_doc_changes:
|
||||||
result.add_summary("- Documentation: WARNING — source files changed but no docs updated")
|
result.add_summary("- Documentation: WARNING — source files changed but no docs updated")
|
||||||
elif has_ansible_changes and not has_doc_changes:
|
elif has_ansible_changes and not has_doc_changes:
|
||||||
result.add_summary("- Documentation: WARNING — Ansible role changed but no docs updated")
|
result.add_summary("- Documentation: WARNING — Ansible role changed but no docs updated")
|
||||||
|
elif has_tofu_changes and not has_doc_changes:
|
||||||
|
result.add_summary("- Documentation: WARNING — OpenTofu changes but no docs updated")
|
||||||
|
elif has_workflow_changes and not has_doc_changes:
|
||||||
|
result.add_summary("- Documentation: INFO — workflow changes (consider updating CI docs if behavior changed)")
|
||||||
else:
|
else:
|
||||||
result.add_summary("- Documentation: OK")
|
result.add_summary("- Documentation: OK")
|
||||||
|
|
||||||
|
if todo_issues:
|
||||||
|
for issue in todo_issues:
|
||||||
|
result.add_summary(f"- Documentation: WARNING — {issue}")
|
||||||
|
|
||||||
|
|
||||||
def check_test_coverage(files: list[dict[str, Any]], result: ReviewResult) -> None:
|
def check_test_coverage(files: list[dict[str, Any]], result: ReviewResult) -> None:
|
||||||
"""Check that tests are updated for source changes."""
|
"""Check that tests are updated for source changes."""
|
||||||
|
|||||||
+48
-14
@@ -28,6 +28,8 @@ from typing import Any
|
|||||||
|
|
||||||
import click
|
import click
|
||||||
|
|
||||||
|
from devx.i18n import _
|
||||||
|
|
||||||
|
|
||||||
def _repo_root() -> Path:
|
def _repo_root() -> Path:
|
||||||
"""Resolve repo root from GITHUB_WORKSPACE or cwd."""
|
"""Resolve repo root from GITHUB_WORKSPACE or cwd."""
|
||||||
@@ -68,7 +70,7 @@ def fetch_latest_master(branch: str = "master") -> None:
|
|||||||
"""
|
"""
|
||||||
_run(["git", "fetch", "origin", branch]) # nosec B607
|
_run(["git", "fetch", "origin", branch]) # nosec B607
|
||||||
_run(["git", "reset", "--hard", f"origin/{branch}"]) # nosec B607
|
_run(["git", "reset", "--hard", f"origin/{branch}"]) # nosec B607
|
||||||
click.echo(f"Synced to latest origin/{branch}")
|
click.echo(_("Synced to latest origin/{branch}", branch=branch))
|
||||||
|
|
||||||
|
|
||||||
def generate_badges(output_dir: str) -> None:
|
def generate_badges(output_dir: str) -> None:
|
||||||
@@ -76,8 +78,8 @@ def generate_badges(output_dir: str) -> None:
|
|||||||
_run([sys.executable, "-m", "devx.tools.generate_badges", "--output-dir", output_dir])
|
_run([sys.executable, "-m", "devx.tools.generate_badges", "--output-dir", output_dir])
|
||||||
badges = list(Path(output_dir).glob("*.svg"))
|
badges = list(Path(output_dir).glob("*.svg"))
|
||||||
if not badges:
|
if not badges:
|
||||||
raise click.ClickException("No badge SVG files generated")
|
raise click.ClickException(_("No badge SVG files generated"))
|
||||||
click.echo(f"Generated {len(badges)} badge files")
|
click.echo(_("Generated {count} badge files", count=len(badges)))
|
||||||
|
|
||||||
|
|
||||||
def push_to_badges_branch(badges_dir: str) -> str:
|
def push_to_badges_branch(badges_dir: str) -> str:
|
||||||
@@ -85,26 +87,33 @@ 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"))
|
||||||
|
|
||||||
# Get the commit SHA of the badges branch
|
# Get the commit SHA of the badges branch
|
||||||
result = _run_capture(["git", "rev-parse", "HEAD"]) # nosec B607
|
result = _run_capture(["git", "rev-parse", "HEAD"]) # nosec B607
|
||||||
sha = result.stdout.strip()
|
sha = result.stdout.strip()
|
||||||
click.echo(f"Badges commit SHA: {sha}")
|
click.echo(_("Badges commit SHA: {sha}", sha=sha))
|
||||||
return sha
|
return sha
|
||||||
|
|
||||||
|
|
||||||
@@ -133,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
|
||||||
@@ -142,11 +167,11 @@ def update_readme_with_badge_sha(badges_sha: str, repo_root: Path | None = None)
|
|||||||
new_content = update_badge_urls(content, badges_sha)
|
new_content = update_badge_urls(content, badges_sha)
|
||||||
if new_content != content:
|
if new_content != content:
|
||||||
filepath.write_text(new_content)
|
filepath.write_text(new_content)
|
||||||
click.echo(f"Updated badge URLs in {filename}")
|
click.echo(_("Updated badge URLs in {filename}", filename=filename))
|
||||||
updated_any = True
|
updated_any = True
|
||||||
|
|
||||||
if not updated_any:
|
if not updated_any:
|
||||||
click.echo("No badge URLs found to update — README already up to date")
|
click.echo(_("No badge URLs found to update — README already up to date"))
|
||||||
return
|
return
|
||||||
|
|
||||||
_run(["git", "add", "README.md", "docs/index.md"]) # nosec B607
|
_run(["git", "add", "README.md", "docs/index.md"]) # nosec B607
|
||||||
@@ -160,7 +185,7 @@ def update_readme_with_badge_sha(badges_sha: str, repo_root: Path | None = None)
|
|||||||
]
|
]
|
||||||
) # nosec B607
|
) # nosec B607
|
||||||
_run(["git", "push", "origin", "master"]) # nosec B607
|
_run(["git", "push", "origin", "master"]) # nosec B607
|
||||||
click.echo(f"Pushed README update with badge SHA {badges_sha[:8]}")
|
click.echo(_("Pushed README update with badge SHA {sha}", sha=badges_sha[:8]))
|
||||||
|
|
||||||
|
|
||||||
@click.command()
|
@click.command()
|
||||||
@@ -193,13 +218,22 @@ def main(output_dir: str, branch: str, no_readme_update: bool, retries: int) ->
|
|||||||
except (subprocess.CalledProcessError, RuntimeError) as exc:
|
except (subprocess.CalledProcessError, RuntimeError) as exc:
|
||||||
last_error = exc
|
last_error = exc
|
||||||
if attempt < retries:
|
if attempt < retries:
|
||||||
click.echo(f"Badge push attempt {attempt}/{retries} failed — retrying: {exc}")
|
click.echo(
|
||||||
|
_(
|
||||||
|
"Badge push attempt {attempt}/{retries} failed — retrying: {error}",
|
||||||
|
attempt=attempt,
|
||||||
|
retries=retries,
|
||||||
|
error=exc,
|
||||||
|
)
|
||||||
|
)
|
||||||
time.sleep(10)
|
time.sleep(10)
|
||||||
with contextlib.suppress(subprocess.CalledProcessError):
|
with contextlib.suppress(subprocess.CalledProcessError):
|
||||||
fetch_latest_master(branch)
|
fetch_latest_master(branch)
|
||||||
else:
|
else:
|
||||||
click.echo(f"Badge push failed after {retries} attempts: {exc}")
|
click.echo(_("Badge push failed after {retries} attempts: {error}", retries=retries, error=exc))
|
||||||
raise click.ClickException(f"Badge push failed after {retries} attempts: {last_error}")
|
raise click.ClickException(
|
||||||
|
_("Badge push failed after {retries} attempts: {error}", retries=retries, error=last_error)
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
if __name__ == "__main__": # pragma: no cover
|
if __name__ == "__main__": # pragma: no cover
|
||||||
|
|||||||
+65
-4
@@ -38,6 +38,7 @@ from __future__ import annotations
|
|||||||
import os
|
import os
|
||||||
import re
|
import re
|
||||||
import sys
|
import sys
|
||||||
|
import time
|
||||||
|
|
||||||
import click
|
import click
|
||||||
from dotenv import load_dotenv # pyright: ignore[reportMissingImports,reportUnknownVariableType]
|
from dotenv import load_dotenv # pyright: ignore[reportMissingImports,reportUnknownVariableType]
|
||||||
@@ -245,6 +246,32 @@ def update_changelog(changelog: str) -> None:
|
|||||||
f.write(updated)
|
f.write(updated)
|
||||||
|
|
||||||
|
|
||||||
|
def update_doc_versions(new_version: str) -> None:
|
||||||
|
"""Update documentation version references to match the new release.
|
||||||
|
|
||||||
|
Runs ``check_doc_versions --fix`` so that README.md and docs/*.md
|
||||||
|
always reference the latest released version.
|
||||||
|
"""
|
||||||
|
import subprocess # nosec B404
|
||||||
|
|
||||||
|
result = subprocess.run( # nosec B603
|
||||||
|
[sys.executable, "-m", "devx.tools.check_doc_versions", "--fix"],
|
||||||
|
check=False,
|
||||||
|
text=True,
|
||||||
|
capture_output=True,
|
||||||
|
)
|
||||||
|
if result.returncode == 0:
|
||||||
|
click.echo(_("Updated documentation version references to v{version}", version=new_version))
|
||||||
|
else:
|
||||||
|
click.echo(
|
||||||
|
_(
|
||||||
|
"WARNING: check_doc_versions --fix failed (rc={rc}): {err}",
|
||||||
|
rc=result.returncode,
|
||||||
|
err=result.stderr.strip()[:200],
|
||||||
|
)
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
def commit_release_changes(new_version: str) -> bool:
|
def commit_release_changes(new_version: str) -> bool:
|
||||||
"""Stage version file and changelog, then create a release commit.
|
"""Stage version file and changelog, then create a release commit.
|
||||||
|
|
||||||
@@ -254,7 +281,7 @@ def commit_release_changes(new_version: str) -> bool:
|
|||||||
commits are a special case generated by the release script.
|
commits are a special case generated by the release script.
|
||||||
Returns True if a commit was created, False if there were no staged changes.
|
Returns True if a commit was created, False if there were no staged changes.
|
||||||
"""
|
"""
|
||||||
run_cmd(["git", "add", INIT_FILE, CHANGELOG_FILE])
|
run_cmd(["git", "add", INIT_FILE, CHANGELOG_FILE, "README.md", "docs/"])
|
||||||
status = run_cmd(["git", "diff", "--cached", "--quiet"], check=False)
|
status = run_cmd(["git", "diff", "--cached", "--quiet"], check=False)
|
||||||
if status.returncode == 0:
|
if status.returncode == 0:
|
||||||
click.echo(_("No staged changes — version and changelog already up to date."))
|
click.echo(_("No staged changes — version and changelog already up to date."))
|
||||||
@@ -683,6 +710,7 @@ def main(dry_run: bool, skip_tests: bool, verify: bool) -> None:
|
|||||||
click.echo(_("\n[dry-run] Changelog:\n{changelog}", changelog=changelog))
|
click.echo(_("\n[dry-run] Changelog:\n{changelog}", changelog=changelog))
|
||||||
click.echo(_("[dry-run] Would update {init}", init=INIT_FILE))
|
click.echo(_("[dry-run] Would update {init}", init=INIT_FILE))
|
||||||
click.echo(_("[dry-run] Would update {changelog_file}", changelog_file=CHANGELOG_FILE))
|
click.echo(_("[dry-run] Would update {changelog_file}", changelog_file=CHANGELOG_FILE))
|
||||||
|
click.echo(_("[dry-run] Would update doc version references via check_doc_versions --fix"))
|
||||||
click.echo(_("[dry-run] Would commit: release: v{version} [skip ci]", version=new_version))
|
click.echo(_("[dry-run] Would commit: release: v{version} [skip ci]", version=new_version))
|
||||||
click.echo(_("[dry-run] Would push commit to master"))
|
click.echo(_("[dry-run] Would push commit to master"))
|
||||||
click.echo(_("[dry-run] Would create tag: v{version}", version=new_version))
|
click.echo(_("[dry-run] Would create tag: v{version}", version=new_version))
|
||||||
@@ -696,6 +724,9 @@ def main(dry_run: bool, skip_tests: bool, verify: bool) -> None:
|
|||||||
update_changelog(changelog)
|
update_changelog(changelog)
|
||||||
click.echo(_("Updated {changelog_file}", changelog_file=CHANGELOG_FILE))
|
click.echo(_("Updated {changelog_file}", changelog_file=CHANGELOG_FILE))
|
||||||
|
|
||||||
|
# Update documentation version references (README, docs/*.md)
|
||||||
|
update_doc_versions(new_version)
|
||||||
|
|
||||||
# Verify tests pass BEFORE committing or tagging.
|
# Verify tests pass BEFORE committing or tagging.
|
||||||
# This ensures we never release a version that fails tests.
|
# This ensures we never release a version that fails tests.
|
||||||
if skip_tests:
|
if skip_tests:
|
||||||
@@ -709,9 +740,39 @@ def main(dry_run: bool, skip_tests: bool, verify: bool) -> None:
|
|||||||
click.echo(_("Created release commit."))
|
click.echo(_("Created release commit."))
|
||||||
# Pull --rebase before push to handle the case where master
|
# Pull --rebase before push to handle the case where master
|
||||||
# advanced between checkout and commit (e.g., another merge).
|
# advanced between checkout and commit (e.g., another merge).
|
||||||
run_cmd(["git", "pull", "--rebase", "origin", "master"], check=False)
|
# Retry up to 3 times to handle concurrent pushes.
|
||||||
# Use refs/heads/master to avoid ambiguity with a 'master' tag
|
push_succeeded = False
|
||||||
run_cmd(["git", "push", "origin", "refs/heads/master:refs/heads/master"])
|
for attempt in range(3):
|
||||||
|
rebase = run_cmd(["git", "pull", "--rebase", "origin", "master"], check=False)
|
||||||
|
if rebase.returncode != 0:
|
||||||
|
# Rebase failed (likely conflicts). Abort and retry.
|
||||||
|
click.echo(
|
||||||
|
_(
|
||||||
|
"Rebase attempt {n}/3 failed: {err}",
|
||||||
|
n=attempt + 1,
|
||||||
|
err=rebase.stderr.strip() if rebase.stderr else rebase.stdout.strip(),
|
||||||
|
)
|
||||||
|
)
|
||||||
|
run_cmd(["git", "rebase", "--abort"], check=False)
|
||||||
|
# Brief delay before retry to let concurrent pushes settle.
|
||||||
|
time.sleep(5)
|
||||||
|
continue
|
||||||
|
push = run_cmd(["git", "push", "origin", "refs/heads/master:refs/heads/master"], check=False)
|
||||||
|
if push.returncode == 0:
|
||||||
|
push_succeeded = True
|
||||||
|
break
|
||||||
|
click.echo(
|
||||||
|
_(
|
||||||
|
"Push attempt {n}/3 failed: {err}",
|
||||||
|
n=attempt + 1,
|
||||||
|
err=push.stderr.strip() if push.stderr else push.stdout.strip(),
|
||||||
|
)
|
||||||
|
)
|
||||||
|
time.sleep(5)
|
||||||
|
if not push_succeeded:
|
||||||
|
raise click.ClickException(
|
||||||
|
_("Failed to push release commit after 3 attempts. Manual intervention required.")
|
||||||
|
)
|
||||||
click.echo(_("Pushed release commit to master."))
|
click.echo(_("Pushed release commit to master."))
|
||||||
else:
|
else:
|
||||||
click.echo(_("Skipping commit push — no staged changes."))
|
click.echo(_("Skipping commit push — no staged changes."))
|
||||||
|
|||||||
+251
-225
@@ -1,17 +1,24 @@
|
|||||||
#!/usr/bin/env python3
|
#!/usr/bin/env python3
|
||||||
"""Sync documentation from /docs/ to the Gitea wiki via API.
|
"""Sync documentation from /docs/ to the Gitea wiki via Git.
|
||||||
|
|
||||||
Reads markdown files from the ``docs/`` directory, uses ``mapping.json`` to
|
Instead of using the Gitea wiki API (which is slow, unreliable, and
|
||||||
map file paths to wiki page titles, and creates/updates wiki pages via the
|
prone to timeouts), this module clones the wiki Git repository,
|
||||||
Gitea API. Pages that exist in the wiki but not in the mapping are left
|
copies the documentation files into it, transforms internal links
|
||||||
untouched (not deleted).
|
to wiki-friendly format, commits, and pushes.
|
||||||
|
|
||||||
Gitea 1.26 wiki API endpoints (all use content_base64, NOT content):
|
This approach is:
|
||||||
- Create: POST /repos/{owner}/{repo}/wiki/new {title, content_base64, message}
|
- **Faster** — a single git push vs N API calls
|
||||||
- Update: PATCH /repos/{owner}/{repo}/wiki/page/{sub_url} {title, content_base64, message}
|
- **More reliable** — no API timeouts or rate limits
|
||||||
- List: GET /repos/{owner}/{repo}/wiki/pages → [{title, sub_url, ...}]
|
- **Atomic** — all pages sync in one commit
|
||||||
- Fetch: GET /repos/{owner}/{repo}/wiki/page/{sub_url} → {title, content_base64, ...}
|
- **Auto-pruning** — stale wiki pages are removed automatically
|
||||||
- Delete: DELETE /repos/{owner}/{repo}/wiki/page/{sub_url}
|
|
||||||
|
The wiki Git URL is ``{clone_url}.wiki.git`` (Gitea convention).
|
||||||
|
|
||||||
|
Link transformations:
|
||||||
|
- ``[text](file.md)`` → ``[text](file)`` (wiki pages don't use .md)
|
||||||
|
- ``[text](docs/file.md)`` → ``[text](file)``
|
||||||
|
- External links (http/https/mailto) are preserved
|
||||||
|
- Anchor-only links (``#section``) are preserved
|
||||||
|
|
||||||
Usage:
|
Usage:
|
||||||
CI_GITEA_TOKEN=<token> python3 -m devx.ci.sync_wiki [--dry-run] [--repo owner/repo]
|
CI_GITEA_TOKEN=<token> python3 -m devx.ci.sync_wiki [--dry-run] [--repo owner/repo]
|
||||||
@@ -19,36 +26,49 @@ Usage:
|
|||||||
|
|
||||||
from __future__ import annotations
|
from __future__ import annotations
|
||||||
|
|
||||||
import base64
|
|
||||||
import json
|
import json
|
||||||
import os
|
import os
|
||||||
|
import re
|
||||||
|
import subprocess # nosec B404
|
||||||
|
import tempfile
|
||||||
|
import time
|
||||||
from pathlib import Path
|
from pathlib import Path
|
||||||
|
from urllib.parse import quote, urlparse
|
||||||
|
|
||||||
import click
|
import click
|
||||||
from dotenv import load_dotenv # pyright: ignore[reportMissingImports,reportUnknownVariableType]
|
from dotenv import load_dotenv # pyright: ignore[reportMissingImports,reportUnknownVariableType]
|
||||||
|
|
||||||
from devx.api_clients import GiteaClient
|
|
||||||
from devx.config import GITEA_API_URL, REPO_NAME, REPO_OWNER
|
from devx.config import GITEA_API_URL, REPO_NAME, REPO_OWNER
|
||||||
from devx.exceptions import APIError
|
|
||||||
from devx.i18n import _
|
from devx.i18n import _
|
||||||
|
|
||||||
load_dotenv()
|
load_dotenv()
|
||||||
|
|
||||||
# DOCS_DIR is the repo's docs/ directory. When devx is installed as a
|
|
||||||
# package (e.g., in .venv/lib/python3.12/site-packages/devx/), the
|
|
||||||
# __file__-relative path would point inside the venv, not the repo.
|
|
||||||
# Use DEVX_DOCS_DIR env var if set, otherwise fall back to ./docs
|
|
||||||
# (relative to the current working directory, which is the repo root
|
|
||||||
# in CI and local development).
|
|
||||||
DOCS_DIR = Path(os.environ.get("DEVX_DOCS_DIR", "docs"))
|
DOCS_DIR = Path(os.environ.get("DEVX_DOCS_DIR", "docs"))
|
||||||
MAPPING_FILE = DOCS_DIR / "mapping.json"
|
MAPPING_FILE = DOCS_DIR / "mapping.json"
|
||||||
|
|
||||||
|
# Markdown link pattern: [text](url)
|
||||||
|
_LINK_RE = re.compile(r"\[([^\]]*)\]\(([^)]+)\)")
|
||||||
|
|
||||||
|
|
||||||
|
def wiki_filename(page_title: str) -> str:
|
||||||
|
"""Convert a wiki page title to its Gitea wiki filename.
|
||||||
|
|
||||||
|
Gitea uses a "dash marker" (``.-``) suffix to distinguish literal dashes
|
||||||
|
from space-to-dash conversions. See Gitea's ``services/wiki/wiki_path.go``.
|
||||||
|
|
||||||
|
- "Architecture" (no dashes) → ``Architecture.md``
|
||||||
|
- "Getting-Started" (has dashes) → ``Getting-Started.-.md``
|
||||||
|
- "Home" (no dashes) → ``Home.md``
|
||||||
|
"""
|
||||||
|
name = page_title.replace(" ", "-")
|
||||||
|
if "-" in name:
|
||||||
|
name += ".-"
|
||||||
|
name += ".md"
|
||||||
|
return quote(name, safe="")
|
||||||
|
|
||||||
|
|
||||||
def load_mapping() -> dict[str, str]:
|
def load_mapping() -> dict[str, str]:
|
||||||
"""Load the file-to-wiki-page mapping from mapping.json.
|
"""Load the file-to-wiki-page mapping from mapping.json."""
|
||||||
|
|
||||||
Validates that the mapping is a dict of string-to-string pairs.
|
|
||||||
"""
|
|
||||||
with open(MAPPING_FILE, encoding="utf-8") as f:
|
with open(MAPPING_FILE, encoding="utf-8") as f:
|
||||||
data = json.load(f)
|
data = json.load(f)
|
||||||
if not isinstance(data, dict):
|
if not isinstance(data, dict):
|
||||||
@@ -61,152 +81,186 @@ def load_mapping() -> dict[str, str]:
|
|||||||
return data
|
return data
|
||||||
|
|
||||||
|
|
||||||
def read_doc_content(file_path: str) -> str:
|
def transform_links(content: str) -> str:
|
||||||
"""Read markdown content from a docs file."""
|
"""Transform markdown links from file-based to wiki-friendly format.
|
||||||
full_path = DOCS_DIR / file_path
|
|
||||||
with open(full_path, encoding="utf-8") as f:
|
|
||||||
return f.read()
|
|
||||||
|
|
||||||
|
- ``[text](file.md)`` → ``[text](file)``
|
||||||
def encode_content(content: str) -> str:
|
- ``[text](docs/file.md)`` → ``[text](file)``
|
||||||
"""Encode content as base64 for the Gitea wiki API.
|
- ``[text](../file.md)`` → ``[text](file)``
|
||||||
|
- External links (http/https/mailto) preserved
|
||||||
The Gitea wiki API requires content_base64, not plain content.
|
- Anchor-only links (``#section``) preserved
|
||||||
Sending plain content silently fails (pages are created/updated
|
|
||||||
but with empty content).
|
|
||||||
"""
|
"""
|
||||||
return base64.b64encode(content.encode("utf-8")).decode("ascii")
|
|
||||||
|
def replace_link(match: re.Match[str]) -> str:
|
||||||
|
text = match.group(1)
|
||||||
|
url = match.group(2).strip()
|
||||||
|
# Skip external links and mailto
|
||||||
|
if url.startswith(("http://", "https://", "mailto:")):
|
||||||
|
return match.group(0)
|
||||||
|
# Skip anchor-only links
|
||||||
|
if url.startswith("#"):
|
||||||
|
return match.group(0)
|
||||||
|
# Split path and anchor
|
||||||
|
if "#" in url:
|
||||||
|
path_part, anchor = url.split("#", 1)
|
||||||
|
anchor = f"#{anchor}"
|
||||||
|
else:
|
||||||
|
path_part, anchor = url, ""
|
||||||
|
# Remove .md extension and directory prefixes
|
||||||
|
if path_part.endswith(".md"):
|
||||||
|
path_part = path_part[:-3]
|
||||||
|
# Remove directory prefix (docs/, ../, etc.)
|
||||||
|
path_part = path_part.split("/")[-1]
|
||||||
|
return f"[{text}]({path_part}{anchor})"
|
||||||
|
|
||||||
|
return _LINK_RE.sub(replace_link, content)
|
||||||
|
|
||||||
|
|
||||||
def decode_content(content_b64: str) -> str:
|
def get_wiki_clone_url(owner: str, repo: str, token: str) -> str:
|
||||||
"""Decode base64 content from the Gitea wiki API."""
|
"""Build the wiki Git clone URL with token auth."""
|
||||||
if not content_b64:
|
# Gitea wiki repos are at {clone_url}.wiki.git
|
||||||
return ""
|
# Extract base URL from API URL
|
||||||
return base64.b64decode(content_b64).decode("utf-8")
|
base = GITEA_API_URL.rsplit("/api/v1", 1)[0]
|
||||||
|
# Embed token in URL for both clone and push auth
|
||||||
|
# Format: https://token@host/owner/repo.wiki.git
|
||||||
|
parsed = urlparse(base)
|
||||||
|
return f"{parsed.scheme}://{token}@{parsed.hostname}/{owner}/{repo}.wiki.git"
|
||||||
|
|
||||||
|
|
||||||
def list_wiki_pages(client: GiteaClient) -> dict[str, str]:
|
def clone_wiki(wiki_url: str, dest: Path) -> bool:
|
||||||
"""List existing wiki pages, returning {title: sub_url}."""
|
"""Clone the wiki repo into dest. Returns True if clone succeeded.
|
||||||
try:
|
|
||||||
pages = client._request("GET", "/wiki/pages").json()
|
|
||||||
except APIError:
|
|
||||||
return {}
|
|
||||||
return {page.get("title", ""): page.get("sub_url", page.get("title", "")) for page in pages}
|
|
||||||
|
|
||||||
|
If the wiki repo doesn't exist yet (no pages created), returns False.
|
||||||
def fetch_page_content(client: GiteaClient, sub_url: str) -> str:
|
|
||||||
"""Fetch a wiki page's content by sub_url, decoded from base64."""
|
|
||||||
try:
|
|
||||||
page = client._request("GET", f"/wiki/page/{sub_url}").json()
|
|
||||||
return decode_content(page.get("content_base64", ""))
|
|
||||||
except APIError:
|
|
||||||
return ""
|
|
||||||
|
|
||||||
|
|
||||||
def sync_page(
|
|
||||||
client: GiteaClient,
|
|
||||||
page_title: str,
|
|
||||||
content: str,
|
|
||||||
existing_pages: dict[str, str],
|
|
||||||
dry_run: bool,
|
|
||||||
) -> str:
|
|
||||||
"""Create or update a single wiki page.
|
|
||||||
|
|
||||||
Returns "created", "updated", or "skipped" (if dry-run).
|
|
||||||
"""
|
"""
|
||||||
if dry_run:
|
result = subprocess.run( # nosec
|
||||||
click.echo(_("[dry-run] Would sync page: {title} ({chars} chars)", title=page_title, chars=len(content)))
|
["git", "clone", "--depth", "1", wiki_url, str(dest)],
|
||||||
return "skipped"
|
capture_output=True,
|
||||||
|
text=True,
|
||||||
content_b64 = encode_content(content)
|
timeout=60,
|
||||||
|
|
||||||
if page_title in existing_pages:
|
|
||||||
# Update existing page via PATCH
|
|
||||||
sub_url = existing_pages[page_title]
|
|
||||||
client._request(
|
|
||||||
"PATCH",
|
|
||||||
f"/wiki/page/{sub_url}",
|
|
||||||
json={
|
|
||||||
"title": page_title,
|
|
||||||
"content_base64": content_b64,
|
|
||||||
"message": f"Sync from docs/ — update {page_title}",
|
|
||||||
},
|
|
||||||
)
|
|
||||||
return "updated"
|
|
||||||
|
|
||||||
# Create new page via POST /wiki/new
|
|
||||||
client._request(
|
|
||||||
"POST",
|
|
||||||
"/wiki/new",
|
|
||||||
json={
|
|
||||||
"title": page_title,
|
|
||||||
"content_base64": content_b64,
|
|
||||||
"message": f"Sync from docs/ — create {page_title}",
|
|
||||||
},
|
|
||||||
)
|
)
|
||||||
return "created"
|
return result.returncode == 0
|
||||||
|
|
||||||
|
|
||||||
def verify_wiki_page(
|
def init_wiki(dest: Path) -> None:
|
||||||
client: GiteaClient, page_title: str, expected_content: str, existing_pages: dict[str, str]
|
"""Initialize a fresh wiki repo (when clone fails)."""
|
||||||
) -> bool:
|
dest.mkdir(parents=True, exist_ok=True)
|
||||||
"""Verify that a wiki page has non-empty content matching the docs.
|
subprocess.run(["git", "init"], cwd=dest, capture_output=True, check=True) # nosec
|
||||||
|
subprocess.run( # nosec
|
||||||
Returns True if the page content matches, False otherwise.
|
["git", "config", "user.email", "ci@oblachno.fyi"],
|
||||||
"""
|
cwd=dest,
|
||||||
if page_title not in existing_pages:
|
capture_output=True,
|
||||||
return False
|
check=True,
|
||||||
sub_url = existing_pages[page_title]
|
)
|
||||||
actual = fetch_page_content(client, sub_url)
|
subprocess.run( # nosec
|
||||||
return actual.strip() == expected_content.strip()
|
["git", "config", "user.name", "CI Wiki Sync"],
|
||||||
|
cwd=dest,
|
||||||
|
capture_output=True,
|
||||||
|
check=True,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
def verify_wiki_integrity(
|
def sync_files(
|
||||||
client: GiteaClient,
|
docs_dir: Path,
|
||||||
|
wiki_dir: Path,
|
||||||
mapping: dict[str, str],
|
mapping: dict[str, str],
|
||||||
synced: dict[str, str],
|
dry_run: bool,
|
||||||
) -> list[str]:
|
) -> tuple[int, int]:
|
||||||
"""Comprehensive wiki verification.
|
"""Copy docs files to wiki dir with link transformation.
|
||||||
|
|
||||||
Checks:
|
Returns (synced, pruned) counts.
|
||||||
1. Every mapped page exists in the wiki
|
|
||||||
2. Every mapped page has non-empty content
|
|
||||||
3. Every mapped page's content matches the docs
|
|
||||||
4. No stale pages exist in the wiki (pages not in mapping)
|
|
||||||
5. Page count matches
|
|
||||||
|
|
||||||
Returns a list of failure messages (empty if all checks pass).
|
|
||||||
"""
|
"""
|
||||||
failures: list[str] = []
|
synced = 0
|
||||||
existing_pages = list_wiki_pages(client)
|
|
||||||
expected_titles = set(mapping.values())
|
|
||||||
|
|
||||||
# Check 1: Page count
|
# Build set of expected wiki filenames
|
||||||
if len(existing_pages) != len(expected_titles):
|
expected_files: set[str] = set()
|
||||||
failures.append(f"Page count mismatch: wiki has {len(existing_pages)}, mapping has {len(expected_titles)}")
|
|
||||||
|
|
||||||
# Check 2: Missing pages (in mapping but not in wiki)
|
for file_path, page_title in sorted(mapping.items()):
|
||||||
missing = expected_titles - set(existing_pages.keys())
|
src = docs_dir / file_path
|
||||||
for title in sorted(missing):
|
if not src.exists():
|
||||||
failures.append(f"Missing page: {title}")
|
click.echo(_(" WARN: Mapped file {file} not found, skipping", file=file_path))
|
||||||
|
continue
|
||||||
|
|
||||||
# Check 3: Stale pages (in wiki but not in mapping)
|
content = src.read_text(encoding="utf-8")
|
||||||
stale = set(existing_pages.keys()) - expected_titles
|
if not content.strip():
|
||||||
for title in sorted(stale):
|
click.echo(_(" WARN: Mapped file {file} is empty, skipping", file=file_path))
|
||||||
failures.append(f"Stale page (not in mapping): {title}")
|
continue
|
||||||
|
|
||||||
# Check 4: Content verification
|
# Transform links
|
||||||
for page_title, expected_content in sorted(synced.items()):
|
transformed = transform_links(content)
|
||||||
ok = verify_wiki_page(client, page_title, expected_content, existing_pages)
|
|
||||||
if not ok:
|
|
||||||
sub_url = existing_pages.get(page_title, "?")
|
|
||||||
actual = fetch_page_content(client, sub_url)
|
|
||||||
if not actual.strip():
|
|
||||||
failures.append(f"Empty content: {page_title}")
|
|
||||||
else:
|
|
||||||
failures.append(f"Content mismatch: {page_title}")
|
|
||||||
|
|
||||||
return failures
|
# Wiki filename: Gitea uses a dash-marker convention for titles with dashes
|
||||||
|
fname = wiki_filename(page_title)
|
||||||
|
expected_files.add(fname)
|
||||||
|
|
||||||
|
if not dry_run:
|
||||||
|
dest = wiki_dir / fname
|
||||||
|
dest.write_text(transformed, encoding="utf-8")
|
||||||
|
synced += 1
|
||||||
|
click.echo(_(" Synced: {title} → {file}", title=page_title, file=fname))
|
||||||
|
|
||||||
|
# Prune stale pages (in wiki but not in mapping)
|
||||||
|
pruned = 0
|
||||||
|
if not dry_run:
|
||||||
|
for existing in wiki_dir.glob("*.md"):
|
||||||
|
if existing.name not in expected_files:
|
||||||
|
existing.unlink()
|
||||||
|
pruned += 1
|
||||||
|
click.echo(_(" Pruned: {file} (not in mapping)", file=existing.name))
|
||||||
|
|
||||||
|
return synced, pruned
|
||||||
|
|
||||||
|
|
||||||
|
def commit_and_push(wiki_dir: Path, wiki_url: str, dry_run: bool) -> bool:
|
||||||
|
"""Commit changes and push to the wiki repo. Returns True if pushed."""
|
||||||
|
if dry_run:
|
||||||
|
click.echo(_("[dry-run] Would commit and push wiki changes"))
|
||||||
|
return False
|
||||||
|
|
||||||
|
# Stage all changes
|
||||||
|
subprocess.run(["git", "add", "-A"], cwd=wiki_dir, capture_output=True, check=True) # nosec
|
||||||
|
|
||||||
|
# Check if there are changes to commit
|
||||||
|
result = subprocess.run( # nosec
|
||||||
|
["git", "diff", "--cached", "--quiet"],
|
||||||
|
cwd=wiki_dir,
|
||||||
|
capture_output=True,
|
||||||
|
)
|
||||||
|
if result.returncode == 0:
|
||||||
|
click.echo(_("No changes to sync — wiki is up to date."))
|
||||||
|
return False
|
||||||
|
|
||||||
|
# Commit — ensure git identity is configured (CI environments may lack it)
|
||||||
|
subprocess.run( # nosec
|
||||||
|
["git", "config", "user.email", "devin-ai-integration[bot]@users.noreply.github.com"],
|
||||||
|
cwd=wiki_dir,
|
||||||
|
capture_output=True,
|
||||||
|
check=True,
|
||||||
|
)
|
||||||
|
subprocess.run( # nosec
|
||||||
|
["git", "config", "user.name", "Devin CI"],
|
||||||
|
cwd=wiki_dir,
|
||||||
|
capture_output=True,
|
||||||
|
check=True,
|
||||||
|
)
|
||||||
|
subprocess.run( # nosec
|
||||||
|
["git", "commit", "-m", "Sync wiki from docs/ [skip ci]"],
|
||||||
|
cwd=wiki_dir,
|
||||||
|
capture_output=True,
|
||||||
|
check=True,
|
||||||
|
)
|
||||||
|
|
||||||
|
# Push
|
||||||
|
result = subprocess.run( # nosec
|
||||||
|
["git", "push", "--force", wiki_url, "HEAD:master"],
|
||||||
|
cwd=wiki_dir,
|
||||||
|
capture_output=True,
|
||||||
|
text=True,
|
||||||
|
timeout=60,
|
||||||
|
)
|
||||||
|
if result.returncode != 0:
|
||||||
|
click.echo(_("Push failed: {error}", error=result.stderr))
|
||||||
|
return False
|
||||||
|
return True
|
||||||
|
|
||||||
|
|
||||||
@click.command()
|
@click.command()
|
||||||
@@ -216,15 +270,10 @@ def verify_wiki_integrity(
|
|||||||
"--verify",
|
"--verify",
|
||||||
is_flag=True,
|
is_flag=True,
|
||||||
default=False,
|
default=False,
|
||||||
help="After syncing, verify each page has non-empty content. Exit 1 if any page is empty or mismatched.",
|
help="After syncing, verify each page exists in the wiki. Exit 1 if any page is missing.",
|
||||||
)
|
)
|
||||||
@click.option(
|
def main(dry_run: bool, repo: str | None, verify: bool) -> None:
|
||||||
"--strict",
|
"""Sync documentation to the Gitea wiki via Git."""
|
||||||
is_flag=True,
|
|
||||||
default=False,
|
|
||||||
help="Full integrity check: verify page count, missing pages, stale pages, and content. Implies --verify.",
|
|
||||||
)
|
|
||||||
def main(dry_run: bool, repo: str | None, verify: bool, strict: bool) -> None:
|
|
||||||
token = os.environ.get("CI_GITEA_TOKEN", "")
|
token = os.environ.get("CI_GITEA_TOKEN", "")
|
||||||
if not token:
|
if not token:
|
||||||
raise click.ClickException(_("ERROR: CI_GITEA_TOKEN is not set."))
|
raise click.ClickException(_("ERROR: CI_GITEA_TOKEN is not set."))
|
||||||
@@ -239,89 +288,66 @@ def main(dry_run: bool, repo: str | None, verify: bool, strict: bool) -> None:
|
|||||||
raise click.ClickException(_("ERROR: mapping.json not found at {path}", path=MAPPING_FILE))
|
raise click.ClickException(_("ERROR: mapping.json not found at {path}", path=MAPPING_FILE))
|
||||||
|
|
||||||
mapping = load_mapping()
|
mapping = load_mapping()
|
||||||
client = GiteaClient(GITEA_API_URL, token, owner, repo_name)
|
wiki_url = get_wiki_clone_url(owner, repo_name, token)
|
||||||
|
|
||||||
click.echo(_("Syncing {count} documentation pages to wiki...", count=len(mapping)))
|
click.echo(_("Syncing {count} documentation pages to wiki via Git...", count=len(mapping)))
|
||||||
|
|
||||||
existing_pages = list_wiki_pages(client)
|
with tempfile.TemporaryDirectory() as tmpdir:
|
||||||
if existing_pages:
|
wiki_dir = Path(tmpdir) / "wiki"
|
||||||
click.echo(_("Found {count} existing wiki pages.", count=len(existing_pages)))
|
|
||||||
|
|
||||||
created = 0
|
click.echo(_("Cloning wiki repo..."))
|
||||||
updated = 0
|
if clone_wiki(wiki_url, wiki_dir):
|
||||||
skipped = 0
|
click.echo(_("Cloned existing wiki."))
|
||||||
synced: dict[str, str] = {} # title -> content, for verification
|
|
||||||
|
|
||||||
for file_path, page_title in sorted(mapping.items()):
|
|
||||||
try:
|
|
||||||
content = read_doc_content(file_path)
|
|
||||||
except FileNotFoundError:
|
|
||||||
raise click.ClickException(
|
|
||||||
_("Mapped file {file} not found. Update mapping.json or create the file.", file=file_path)
|
|
||||||
) from None
|
|
||||||
|
|
||||||
if not content.strip():
|
|
||||||
raise click.ClickException(
|
|
||||||
_("Mapped file {file} is empty. Update the content or remove from mapping.json.", file=file_path)
|
|
||||||
) from None
|
|
||||||
|
|
||||||
result = sync_page(client, page_title, content, existing_pages, dry_run)
|
|
||||||
if result == "created":
|
|
||||||
created += 1
|
|
||||||
click.echo(_(" Created: {title}", title=page_title))
|
|
||||||
elif result == "updated":
|
|
||||||
updated += 1
|
|
||||||
click.echo(_(" Updated: {title}", title=page_title))
|
|
||||||
else:
|
else:
|
||||||
skipped += 1
|
click.echo(_("Wiki repo not found or empty — initializing fresh."))
|
||||||
|
init_wiki(wiki_dir)
|
||||||
|
|
||||||
synced[page_title] = content
|
click.echo(_("Syncing files..."))
|
||||||
|
synced, pruned = sync_files(DOCS_DIR, wiki_dir, mapping, dry_run)
|
||||||
|
|
||||||
click.echo(
|
click.echo(
|
||||||
_(
|
_(
|
||||||
"\nDone! Created: {created}, Updated: {updated}, Skipped: {skipped}",
|
"\nDone! Synced: {synced}, Pruned: {pruned}",
|
||||||
created=created,
|
synced=synced,
|
||||||
updated=updated,
|
pruned=pruned,
|
||||||
skipped=skipped,
|
)
|
||||||
)
|
)
|
||||||
)
|
|
||||||
|
|
||||||
# --strict implies --verify
|
if dry_run:
|
||||||
do_verify = verify or strict
|
click.echo(_("[dry-run] No changes pushed."))
|
||||||
|
return
|
||||||
|
|
||||||
if do_verify and not dry_run:
|
click.echo(_("Committing and pushing..."))
|
||||||
if strict:
|
pushed = commit_and_push(wiki_dir, wiki_url, dry_run)
|
||||||
click.echo(_("\nRunning full wiki integrity check..."))
|
if pushed:
|
||||||
failures = verify_wiki_integrity(client, mapping, synced)
|
click.echo(_("Wiki synced successfully."))
|
||||||
if failures:
|
elif not dry_run:
|
||||||
click.echo(_("\nIntegrity check FAILED ({count} issues):", count=len(failures)))
|
click.echo(_("No push needed (no changes or push failed)."))
|
||||||
for f in failures:
|
|
||||||
click.echo(f" - {f}")
|
# Verification
|
||||||
raise click.ClickException(_("Wiki integrity check failed — {count} issue(s)", count=len(failures)))
|
if verify and not dry_run:
|
||||||
click.echo(_("\nIntegrity check passed — all {count} pages verified.", count=len(synced)))
|
if pushed:
|
||||||
else:
|
click.echo(_("Waiting 5s for Gitea to process pushed commits..."))
|
||||||
click.echo(_("\nVerifying wiki pages have content..."))
|
time.sleep(5)
|
||||||
# Re-fetch the page list to get updated sub_urls
|
click.echo(_("\nVerifying wiki pages..."))
|
||||||
existing_pages = list_wiki_pages(client)
|
# Re-clone to verify
|
||||||
|
verify_dir = Path(tmpdir) / "verify"
|
||||||
|
if not clone_wiki(wiki_url, verify_dir):
|
||||||
|
click.echo(_("FAIL: Could not clone wiki for verification."))
|
||||||
|
raise click.ClickException(_("Wiki verification failed — could not clone wiki"))
|
||||||
failures = 0
|
failures = 0
|
||||||
for page_title, expected_content in sorted(synced.items()):
|
for _file_path, page_title in sorted(mapping.items()):
|
||||||
ok = verify_wiki_page(client, page_title, expected_content, existing_pages)
|
fname = wiki_filename(page_title)
|
||||||
if ok:
|
if (verify_dir / fname).exists():
|
||||||
click.echo(_(" OK: {title} ({chars} chars)", title=page_title, chars=len(expected_content)))
|
click.echo(_(" OK: {title}", title=page_title))
|
||||||
else:
|
else:
|
||||||
click.echo(_(" FAIL: {title} — content mismatch or empty!", title=page_title))
|
click.echo(_(" FAIL: {title} — page not found in wiki!", title=page_title))
|
||||||
failures += 1
|
failures += 1
|
||||||
if failures > 0:
|
if failures > 0:
|
||||||
click.echo(
|
|
||||||
_(
|
|
||||||
"\nVerification FAILED: {failures} page(s) have empty or mismatched content!",
|
|
||||||
failures=failures,
|
|
||||||
)
|
|
||||||
)
|
|
||||||
raise click.ClickException(
|
raise click.ClickException(
|
||||||
_("Wiki verification failed — {failures} page(s) empty or mismatched", failures=failures)
|
_("Wiki verification failed — {failures} page(s) missing", failures=failures)
|
||||||
)
|
)
|
||||||
click.echo(_("\nVerification passed — all wiki pages have correct content."))
|
click.echo(_("\nVerification passed — all wiki pages exist."))
|
||||||
|
|
||||||
|
|
||||||
if __name__ == "__main__": # pragma: no cover
|
if __name__ == "__main__": # pragma: no cover
|
||||||
|
|||||||
@@ -95,6 +95,13 @@ def ci_doc_coverage(args: tuple[str, ...]) -> None:
|
|||||||
_run_module("devx.ci.doc_coverage", list(args))
|
_run_module("devx.ci.doc_coverage", list(args))
|
||||||
|
|
||||||
|
|
||||||
|
@ci.command("lint-docs")
|
||||||
|
@click.argument("args", nargs=-1)
|
||||||
|
def ci_lint_docs(args: tuple[str, ...]) -> None:
|
||||||
|
"""Lint documentation files for structure, links, and quality."""
|
||||||
|
_run_module("devx.ci.lint_docs", list(args))
|
||||||
|
|
||||||
|
|
||||||
@ci.command("notify-failure")
|
@ci.command("notify-failure")
|
||||||
@click.argument("args", nargs=-1)
|
@click.argument("args", nargs=-1)
|
||||||
def ci_notify_failure(args: tuple[str, ...]) -> None:
|
def ci_notify_failure(args: tuple[str, ...]) -> None:
|
||||||
@@ -219,6 +226,20 @@ def tools_setup(args: tuple[str, ...]) -> None:
|
|||||||
_run_module("devx.tools.setup", list(args))
|
_run_module("devx.tools.setup", list(args))
|
||||||
|
|
||||||
|
|
||||||
|
@tools.command("rebase")
|
||||||
|
@click.argument("args", nargs=-1)
|
||||||
|
def tools_rebase(args: tuple[str, ...]) -> None:
|
||||||
|
"""Rebase current branch onto origin/master and force-push."""
|
||||||
|
_run_module("devx.tools.rebase", list(args))
|
||||||
|
|
||||||
|
|
||||||
|
@tools.command("pr-rebase")
|
||||||
|
@click.argument("args", nargs=-1)
|
||||||
|
def tools_pr_rebase(args: tuple[str, ...]) -> None:
|
||||||
|
"""Rebase a PR's head branch onto master via Gitea API (server-side)."""
|
||||||
|
_run_module("devx.tools.pr_rebase", list(args))
|
||||||
|
|
||||||
|
|
||||||
@cli.group()
|
@cli.group()
|
||||||
def molecule() -> None:
|
def molecule() -> None:
|
||||||
"""Molecule testing commands (requires devx[molecule])."""
|
"""Molecule testing commands (requires devx[molecule])."""
|
||||||
|
|||||||
+119
-17
@@ -39,6 +39,9 @@
|
|||||||
# DEVX_GITEA_PYPI_ORG — Gitea PyPI org (default: oblachno-oss)
|
# DEVX_GITEA_PYPI_ORG — Gitea PyPI org (default: oblachno-oss)
|
||||||
# DEVX_ACTIONLINT_CFG — actionlint config file (default: .gitea/actionlint.yaml)
|
# DEVX_ACTIONLINT_CFG — actionlint config file (default: .gitea/actionlint.yaml)
|
||||||
# DEVX_WORKFLOW_DIR — workflow directory (default: .gitea/workflows)
|
# DEVX_WORKFLOW_DIR — workflow directory (default: .gitea/workflows)
|
||||||
|
# DEVX_DOC_COVERAGE_STRICT — fail on missing docs (default: 0)
|
||||||
|
# DEVX_DOC_VERSIONS_PKG — package name for version ref checks (default: auto)
|
||||||
|
# DEVX_VALE_LEVEL — vale alert threshold (default: warning)
|
||||||
|
|
||||||
DEVX_PYTHON ?= python3
|
DEVX_PYTHON ?= python3
|
||||||
DEVX_PR_BASE ?= master
|
DEVX_PR_BASE ?= master
|
||||||
@@ -52,24 +55,66 @@ DEVX_GITEA_PYPI_ORG ?= oblachno-oss
|
|||||||
DEVX_ACTIONLINT_CFG ?= .gitea/actionlint.yaml
|
DEVX_ACTIONLINT_CFG ?= .gitea/actionlint.yaml
|
||||||
DEVX_WORKFLOW_DIR ?= .gitea/workflows
|
DEVX_WORKFLOW_DIR ?= .gitea/workflows
|
||||||
DEVX_DOCKERFILE_PATHS ?= docker
|
DEVX_DOCKERFILE_PATHS ?= docker
|
||||||
|
DEVX_VALE_LEVEL ?= warning
|
||||||
|
|
||||||
# PIP_INSTALL — helper to run pip with Gitea private PyPI registry configured.
|
# PIP_INSTALL — helper to run pip with Gitea private PyPI registry configured.
|
||||||
# Usage: $(DEVX_PIP_INSTALL) install -e '.[ci,lint]'
|
# Usage: $(DEVX_PIP_INSTALL) install -e '.[ci,lint]'
|
||||||
# CI_GITEA_USERNAME can be set in .env, as an env var, or as a Make variable.
|
# CI_GITEA_USERNAME can be set in .env, as an env var, or as a Make variable.
|
||||||
|
# Projects can alias: PIP_INSTALL = $(DEVX_PIP_INSTALL)
|
||||||
DEVX_PIP_INSTALL := if [ -z "$$CI_GITEA_TOKEN" ]; then . ./.env 2>/dev/null; fi; \
|
DEVX_PIP_INSTALL := if [ -z "$$CI_GITEA_TOKEN" ]; then . ./.env 2>/dev/null; fi; \
|
||||||
CI_GITEA_TOKEN="$$CI_GITEA_TOKEN"; \
|
CI_GITEA_TOKEN="$$CI_GITEA_TOKEN"; \
|
||||||
_PYPI_USER="$${CI_GITEA_USERNAME:-emil}"; \
|
_PYPI_USER="$${CI_GITEA_USERNAME:-emil}"; \
|
||||||
if [ -n "$$CI_GITEA_TOKEN" ] && [ -n "$$_PYPI_USER" ]; then export PIP_EXTRA_INDEX_URL="https://$$_PYPI_USER:$$CI_GITEA_TOKEN@$(DEVX_GITEA_PYPI_HOST)/api/packages/$(DEVX_GITEA_PYPI_ORG)/pypi/simple/"; fi; \
|
if [ -n "$$CI_GITEA_TOKEN" ] && [ -n "$$_PYPI_USER" ]; then export PIP_EXTRA_INDEX_URL="https://$$_PYPI_USER:$$CI_GITEA_TOKEN@$(DEVX_GITEA_PYPI_HOST)/api/packages/$(DEVX_GITEA_PYPI_ORG)/pypi/simple/"; fi; \
|
||||||
$(DEVX_BIN)/pip
|
$(DEVX_BIN)/pip
|
||||||
|
|
||||||
|
# ── Virtual environment management ────────────────────────────────────────────
|
||||||
|
#
|
||||||
|
# These targets provide a single, consistent venv setup across all
|
||||||
|
# devx-integrated projects. Each project includes
|
||||||
|
# devx.mak and aliases its local targets to these.
|
||||||
|
#
|
||||||
|
# The venv is a standard .venv directory (no pyenv virtualenv dependency).
|
||||||
|
# pyenv can still be used to install Python 3.12+ but the venv itself
|
||||||
|
# is created with `python3 -m venv .venv`.
|
||||||
|
#
|
||||||
|
# Projects should set these variables BEFORE including devx.mak:
|
||||||
|
# DEVX_VENV — venv directory (default: .venv)
|
||||||
|
# DEVX_BIN — venv bin directory (default: $(DEVX_VENV)/bin)
|
||||||
|
# DEVX_PYTHON — Python executable (default: python3; should be $(DEVX_BIN)/python after setup)
|
||||||
|
#
|
||||||
|
# Common aliases in project Makefiles:
|
||||||
|
# PIP_INSTALL = $(DEVX_PIP_INSTALL)
|
||||||
|
# venv: devx-venv
|
||||||
|
# activate-scripts: devx-activate-scripts
|
||||||
|
# .env: devx-env
|
||||||
|
|
||||||
|
# Create .venv with Python version check (3.12+ required)
|
||||||
|
$(DEVX_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')"
|
||||||
|
python3 -m venv $(DEVX_VENV)
|
||||||
|
$(DEVX_BIN)/pip install --upgrade pip setuptools wheel
|
||||||
|
|
||||||
|
# Alias: devx-venv creates the venv (delegates to the activate rule)
|
||||||
|
devx-venv: $(DEVX_VENV)/bin/activate
|
||||||
|
|
||||||
|
# Ensure a venv exists — in CI (no pyenv), creates .venv if missing.
|
||||||
|
# Locally, uses the existing .venv (created by `make setup` or `make devx-venv`).
|
||||||
|
devx-ensure-venv:
|
||||||
|
@if [ ! -f $(DEVX_BIN)/python ]; then \
|
||||||
|
echo "[ensure-venv] Creating $(DEVX_VENV) (no venv found)..."; \
|
||||||
|
python3 -m venv $(DEVX_VENV); \
|
||||||
|
$(DEVX_BIN)/pip install --upgrade pip setuptools wheel; \
|
||||||
|
fi
|
||||||
|
|
||||||
.PHONY: devx-create-task devx-create-pr devx-push devx-push-with-pr devx-check-config
|
.PHONY: devx-create-task devx-create-pr devx-push devx-push-with-pr devx-check-config
|
||||||
.PHONY: devx-pr-status devx-pr-logs devx-pr-label devx-pr-review
|
.PHONY: devx-pr-status devx-pr-logs devx-pr-label devx-pr-review devx-rebase devx-pr-rebase
|
||||||
.PHONY: devx-configure-gitea-pypi devx-install-tools devx-install-checkmake devx-checkmake
|
.PHONY: devx-configure-gitea-pypi devx-install-tools devx-install-checkmake devx-checkmake
|
||||||
.PHONY: devx-workflow-lint devx-workflow-dryrun devx-workflow-dryrun-safe devx-workflow-check
|
.PHONY: devx-workflow-lint devx-workflow-dryrun devx-workflow-dryrun-safe devx-workflow-check
|
||||||
.PHONY: devx-notify-failure devx-install-hooks devx-activate-scripts
|
.PHONY: devx-notify-failure devx-install-hooks devx-activate-scripts devx-venv devx-ensure-venv
|
||||||
.PHONY: devx-lint-ruff devx-lint-format devx-typecheck devx-lint-bandit devx-lint-deps devx-lint
|
.PHONY: devx-lint-ruff devx-lint-format devx-typecheck devx-lint-bandit devx-lint-deps devx-lint
|
||||||
.PHONY: devx-clean devx-pre-push
|
.PHONY: devx-clean devx-pre-push
|
||||||
.PHONY: devx-check-mutable-globals devx-check-dep-docs devx-check-test-coverage devx-check-docs devx-check-test-speed
|
.PHONY: devx-check-mutable-globals devx-check-dep-docs devx-check-test-coverage devx-check-docs devx-check-test-speed devx-check-doc-versions devx-vale
|
||||||
|
.PHONY: devx-check-api-identity-checks devx-setup-ssh-key
|
||||||
.PHONY: devx-test-unit devx-pytest-cov
|
.PHONY: devx-test-unit devx-pytest-cov
|
||||||
.PHONY: devx-setup-image devx-lint-dockerfiles
|
.PHONY: devx-setup-image devx-lint-dockerfiles
|
||||||
|
|
||||||
@@ -134,6 +179,20 @@ devx-pr-review:
|
|||||||
$(if $(BODY),--body "$(BODY)") \
|
$(if $(BODY),--body "$(BODY)") \
|
||||||
$(if $(CHECKLIST),--checklist-confirmed --checklist-categories $(CHECKLIST))
|
$(if $(CHECKLIST),--checklist-confirmed --checklist-categories $(CHECKLIST))
|
||||||
|
|
||||||
|
# Rebase current branch onto origin/master and force-push
|
||||||
|
# Usage: make devx-rebase
|
||||||
|
# make devx-rebase NO_PUSH=1
|
||||||
|
devx-rebase:
|
||||||
|
@$(DEVX_PYTHON) -m devx.tools.rebase \
|
||||||
|
$(if $(NO_PUSH),--no-push)
|
||||||
|
|
||||||
|
# Rebase a PR's head branch via Gitea API (server-side, no local git needed)
|
||||||
|
# Usage: make devx-pr-rebase
|
||||||
|
# make devx-pr-rebase PR=42
|
||||||
|
devx-pr-rebase:
|
||||||
|
@$(DEVX_PYTHON) -m devx.tools.pr_rebase \
|
||||||
|
$(if $(PR),--pr $(PR))
|
||||||
|
|
||||||
# ── Environment setup ─────────────────────────────────────────────────────────
|
# ── Environment setup ─────────────────────────────────────────────────────────
|
||||||
|
|
||||||
# Configure Gitea private PyPI registry so pip can find devx and other
|
# Configure Gitea private PyPI registry so pip can find devx and other
|
||||||
@@ -151,12 +210,6 @@ devx-env:
|
|||||||
echo "Created .env from .env.example — please edit it with your credentials."; \
|
echo "Created .env from .env.example — please edit it with your credentials."; \
|
||||||
fi
|
fi
|
||||||
|
|
||||||
# Create Python venv with version check
|
|
||||||
devx-venv:
|
|
||||||
@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')"
|
|
||||||
$(DEVX_PYTHON) -m venv $(DEVX_VENV)
|
|
||||||
$(DEVX_BIN)/pip install --upgrade pip setuptools wheel
|
|
||||||
|
|
||||||
# Create activate scripts for shell/fish/zsh
|
# Create activate scripts for shell/fish/zsh
|
||||||
devx-activate-scripts:
|
devx-activate-scripts:
|
||||||
@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.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)
|
||||||
@@ -252,10 +305,10 @@ devx-lint: devx-lint-ruff devx-lint-format devx-typecheck devx-lint-bandit
|
|||||||
# ── Testing ───────────────────────────────────────────────────────────────────
|
# ── Testing ───────────────────────────────────────────────────────────────────
|
||||||
|
|
||||||
devx-test-unit:
|
devx-test-unit:
|
||||||
@$(DEVX_BIN)/pytest $(DEVX_TEST_PATHS) -v --no-cov
|
@$(DEVX_BIN)/pytest $(DEVX_TEST_PATHS) -q --no-cov
|
||||||
|
|
||||||
devx-pytest-cov:
|
devx-pytest-cov:
|
||||||
@$(DEVX_BIN)/pytest $(DEVX_TEST_PATHS) -v --cov=$(DEVX_COV_PKG) --cov-report=term-missing --cov-fail-under=100
|
@$(DEVX_BIN)/pytest $(DEVX_TEST_PATHS) -n auto --cov=$(DEVX_COV_PKG) --cov-report=term-missing --cov-fail-under=100
|
||||||
|
|
||||||
# ── Quality checks ────────────────────────────────────────────────────────────
|
# ── Quality checks ────────────────────────────────────────────────────────────
|
||||||
|
|
||||||
@@ -275,10 +328,63 @@ devx-check-test-coverage:
|
|||||||
devx-check-docs:
|
devx-check-docs:
|
||||||
@$(DEVX_PYTHON) -m devx.tools.check_agent_docs
|
@$(DEVX_PYTHON) -m devx.tools.check_agent_docs
|
||||||
|
|
||||||
|
# Check documentation version references match current package version
|
||||||
|
devx-check-doc-versions:
|
||||||
|
@$(DEVX_PYTHON) -m devx.tools.check_doc_versions --root .
|
||||||
|
|
||||||
|
# Documentation coverage — checks that all modules/scripts/CLI commands
|
||||||
|
# are documented. Fails if any are missing when DEVX_DOC_COVERAGE_STRICT=1.
|
||||||
|
devx-doc-coverage:
|
||||||
|
@$(DEVX_PYTHON) -m devx.ci.doc_coverage $(if $(filter 1,$(DEVX_DOC_COVERAGE_STRICT)),--fail-on-missing)
|
||||||
|
|
||||||
|
# All-in-one documentation gate: coverage + stale refs + structural lint +
|
||||||
|
# version refs + prose lint. Use in CI and pre-commit as a single step
|
||||||
|
# instead of 5+ separate steps.
|
||||||
|
#
|
||||||
|
# Configuration via environment variables (set in Makefile before include
|
||||||
|
# or in CI env):
|
||||||
|
# DEVX_DOC_COVERAGE_STRICT=1 — fail on missing docs (recommended)
|
||||||
|
# DEVX_DOC_VERSIONS_PKG=<pkg> — enable version ref checks for a named package
|
||||||
|
# DEVX_VALE_LEVEL=<level> — vale alert threshold (error, warning, suggestion)
|
||||||
|
# default: warning (catches weasel words, unlabeled
|
||||||
|
# code blocks, etc. — not just spelling errors)
|
||||||
|
devx-docs-check: devx-doc-coverage devx-check-docs
|
||||||
|
@$(DEVX_PYTHON) -m devx.ci.lint_docs --root .
|
||||||
|
@if [ -n "$(DEVX_DOC_VERSIONS_PKG)" ]; then \
|
||||||
|
$(DEVX_PYTHON) -m devx.tools.check_doc_versions --root . --package $(DEVX_DOC_VERSIONS_PKG); \
|
||||||
|
elif $(DEVX_PYTHON) -c "import importlib.util,sys; sys.exit(0 if any(importlib.util.find_spec(p) for p in ['devx','grm','oblachno_infra']) else 1)" 2>/dev/null; then \
|
||||||
|
$(DEVX_PYTHON) -m devx.tools.check_doc_versions --root . 2>/dev/null || true; \
|
||||||
|
fi
|
||||||
|
@export PATH="$$HOME/.local/bin:$$PATH" && \
|
||||||
|
if ! command -v vale >/dev/null 2>&1; then \
|
||||||
|
echo "[devx-docs-check] vale not installed — skipping prose lint (install with 'make install-tools')"; \
|
||||||
|
else \
|
||||||
|
vale sync >/dev/null 2>&1 || true; \
|
||||||
|
vale --minAlertLevel=$(DEVX_VALE_LEVEL) docs/ AGENTS.md README.md; \
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Run Vale prose linter on docs and README (skips if vale not installed)
|
||||||
|
# Legacy target — use devx-docs-check for the full documentation gate.
|
||||||
|
devx-vale:
|
||||||
|
@export PATH="$$HOME/.local/bin:$$PATH" && \
|
||||||
|
if ! command -v vale >/dev/null 2>&1; then \
|
||||||
|
echo "[devx-vale] vale not installed — skipping (install with 'make install-tools')"; \
|
||||||
|
else \
|
||||||
|
vale --minAlertLevel=error docs/ AGENTS.md README.md; \
|
||||||
|
fi
|
||||||
|
|
||||||
# Verify test suite timing
|
# Verify test suite timing
|
||||||
devx-check-test-speed:
|
devx-check-test-speed:
|
||||||
@$(DEVX_PYTHON) -m devx.tools.check_test_speed
|
@$(DEVX_PYTHON) -m devx.tools.check_test_speed
|
||||||
|
|
||||||
|
# Scan integration tests for unsafe is True/is False identity checks
|
||||||
|
devx-check-api-identity-checks:
|
||||||
|
@$(DEVX_PYTHON) -m devx.tools.check_api_identity_checks
|
||||||
|
|
||||||
|
# Set up SSH private key from SSH_PRIVATE_KEY env var
|
||||||
|
devx-setup-ssh-key:
|
||||||
|
@$(DEVX_PYTHON) -m devx.tools.setup_ssh_key
|
||||||
|
|
||||||
# ── Pre-push validation ───────────────────────────────────────────────────────
|
# ── Pre-push validation ───────────────────────────────────────────────────────
|
||||||
|
|
||||||
# Run lint + tests before push (projects can override with project-specific targets)
|
# Run lint + tests before push (projects can override with project-specific targets)
|
||||||
@@ -327,12 +433,8 @@ devx-lint-dockerfiles:
|
|||||||
# devx-setup-ci) — each project defines its own setup-ci target.
|
# devx-setup-ci) — each project defines its own setup-ci target.
|
||||||
|
|
||||||
devx-setup-image:
|
devx-setup-image:
|
||||||
@if [ -d /opt/venv ]; then ln -sf /opt/venv $(DEVX_VENV); . $(DEVX_BIN)/activate; \
|
@/opt/venv/bin/python -m devx.tools.setup_image --venv $(DEVX_VENV) --extras "$(EXTRAS)" \
|
||||||
_U="$${CI_GITEA_USERNAME:-emil}"; \
|
--gitea-host $(DEVX_GITEA_PYPI_HOST) --gitea-org $(DEVX_GITEA_PYPI_ORG)
|
||||||
if [ -n "$$CI_GITEA_TOKEN" ]; then export PIP_EXTRA_INDEX_URL="https://$$_U:$$CI_GITEA_TOKEN@$(DEVX_GITEA_PYPI_HOST)/api/packages/$(DEVX_GITEA_PYPI_ORG)/pypi/simple/"; fi; \
|
|
||||||
pip install --no-cache-dir -e .$(if $(EXTRAS),[$(EXTRAS)],); \
|
|
||||||
echo "[devx-setup-image] Linked /opt/venv$(if $(EXTRAS), with [$(EXTRAS)],)."; \
|
|
||||||
else echo "[devx-setup-image] /opt/venv not found — falling back to setup-ci"; $(MAKE) setup-ci; fi
|
|
||||||
|
|
||||||
# ── Docker image build / push / cleanup ───────────────────────────────────────
|
# ── Docker image build / push / cleanup ───────────────────────────────────────
|
||||||
#
|
#
|
||||||
|
|||||||
@@ -16,7 +16,7 @@ Outputs:
|
|||||||
- (default): prints both as ``count=N`` and ``indices=[0,1,...]``
|
- (default): prints both as ``count=N`` and ``indices=[0,1,...]``
|
||||||
|
|
||||||
Usage:
|
Usage:
|
||||||
python3 -m devx.molecule.discover_runners --owner oblachno-oss --repo grm
|
python3 -m devx.molecule.discover_runners --owner my-org --repo my-repo
|
||||||
python3 -m devx.molecule.discover_runners --indices
|
python3 -m devx.molecule.discover_runners --indices
|
||||||
python3 -m devx.molecule.discover_runners --count
|
python3 -m devx.molecule.discover_runners --count
|
||||||
"""
|
"""
|
||||||
|
|||||||
@@ -137,7 +137,7 @@ def build_multi_role_pairs(
|
|||||||
# --- Molecule weight configuration ---
|
# --- Molecule weight configuration ---
|
||||||
#
|
#
|
||||||
# Weights are loaded from ``[tool.devx.molecule.weights]`` in
|
# Weights are loaded from ``[tool.devx.molecule.weights]`` in
|
||||||
# ``pyproject.toml``. Each project (infra, grm, …) contributes its own
|
# ``pyproject.toml``. Each project contributes its own
|
||||||
# weights calibrated from actual CI execution times.
|
# weights calibrated from actual CI execution times.
|
||||||
#
|
#
|
||||||
# Two key formats are supported:
|
# Two key formats are supported:
|
||||||
|
|||||||
@@ -15,9 +15,9 @@ exits early with code 1.
|
|||||||
|
|
||||||
Usage::
|
Usage::
|
||||||
|
|
||||||
# Single-role (grm-style)
|
# Single-role
|
||||||
python3 -m devx.molecule.molecule_ci_guard pair1 pair2 ...
|
python3 -m devx.molecule.molecule_ci_guard pair1 pair2 ...
|
||||||
# Multi-role (infra-style)
|
# Multi-role
|
||||||
python3 -m devx.molecule.molecule_ci_guard --roles-root ansible/roles pair1 pair2 ...
|
python3 -m devx.molecule.molecule_ci_guard --roles-root ansible/roles pair1 pair2 ...
|
||||||
|
|
||||||
Environment variables:
|
Environment variables:
|
||||||
|
|||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user