Public Access
Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
40a94df029 | ||
|
|
f50c4c1e00 | ||
|
|
bbb264efc9 | ||
|
|
c97b249935 | ||
|
|
32b9a53151 | ||
|
|
ae68df63f1 | ||
|
|
6402f31345 | ||
|
|
f017fec8f5 | ||
|
|
add02273b6 | ||
|
|
e489fdb206 |
@@ -190,7 +190,7 @@ jobs:
|
||||
PYTHONPATH: src
|
||||
run: |
|
||||
. .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
|
||||
if: failure()
|
||||
env:
|
||||
|
||||
@@ -2,6 +2,36 @@
|
||||
|
||||
All notable changes to this project will be documented in this file.
|
||||
|
||||
## [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
|
||||
|
||||
@@ -87,7 +87,7 @@ extra index and list devx in your dependencies:
|
||||
```toml
|
||||
[project]
|
||||
dependencies = [
|
||||
"devx>=0.35.2",
|
||||
"devx>=0.35.7",
|
||||
]
|
||||
|
||||
[tool.pip]
|
||||
@@ -101,8 +101,8 @@ pip install -e .
|
||||
```
|
||||
|
||||
> **Note:** If your project requires a specific devx version, pin it in
|
||||
> `dependencies` (for example, `"devx==0.35.2"`) or use a version constraint
|
||||
> (for example, `"devx>=0.35.2,<0.36"`).
|
||||
> `dependencies` (for example, `"devx==0.35.7"`) or use a version constraint
|
||||
> (for example, `"devx>=0.35.7,<0.36"`).
|
||||
|
||||
### Optional extras
|
||||
|
||||
|
||||
+2
-2
@@ -74,14 +74,14 @@ Add devx to your `pyproject.toml` dependencies and configure the registry:
|
||||
```toml
|
||||
[project]
|
||||
dependencies = [
|
||||
"devx>=0.35.2",
|
||||
"devx>=0.35.7",
|
||||
]
|
||||
|
||||
[tool.pip]
|
||||
extra-index-url = "https://git.oblachno.oblachno.fyi/api/packages/oblachno-oss/pypi/simple"
|
||||
```
|
||||
|
||||
Pin a specific version if needed: `"devx==0.35.2"` or `"devx>=0.35.2,<0.36"`.
|
||||
Pin a specific version if needed: `"devx==0.35.7"` or `"devx>=0.35.7,<0.36"`.
|
||||
|
||||
### Optional extras
|
||||
|
||||
|
||||
@@ -48,12 +48,12 @@ Add devx to your `pyproject.toml`:
|
||||
```toml
|
||||
[project]
|
||||
dependencies = [
|
||||
"devx>=0.35.2",
|
||||
"devx>=0.35.7",
|
||||
]
|
||||
|
||||
[project.optional-dependencies]
|
||||
dev = [
|
||||
"devx>=0.35.2",
|
||||
"devx>=0.35.7",
|
||||
]
|
||||
```
|
||||
|
||||
|
||||
@@ -1,3 +1,3 @@
|
||||
"""devx — reusable development and CI/CD tools for oblachno-oss projects."""
|
||||
|
||||
__version__ = "0.35.2"
|
||||
__version__ = "0.35.7"
|
||||
|
||||
+47
-11
@@ -31,7 +31,9 @@ import os
|
||||
import re
|
||||
import subprocess # nosec B404
|
||||
import tempfile
|
||||
import time
|
||||
from pathlib import Path
|
||||
from urllib.parse import quote, urlparse
|
||||
|
||||
import click
|
||||
from dotenv import load_dotenv # pyright: ignore[reportMissingImports,reportUnknownVariableType]
|
||||
@@ -48,6 +50,23 @@ MAPPING_FILE = DOCS_DIR / "mapping.json"
|
||||
_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]:
|
||||
"""Load the file-to-wiki-page mapping from mapping.json."""
|
||||
with open(MAPPING_FILE, encoding="utf-8") as f:
|
||||
@@ -102,7 +121,10 @@ def get_wiki_clone_url(owner: str, repo: str, token: str) -> str:
|
||||
# Gitea wiki repos are at {clone_url}.wiki.git
|
||||
# Extract base URL from API URL
|
||||
base = GITEA_API_URL.rsplit("/api/v1", 1)[0]
|
||||
return f"{base}/{owner}/{repo}.wiki.git"
|
||||
# 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 clone_wiki(wiki_url: str, dest: Path) -> bool:
|
||||
@@ -166,16 +188,15 @@ def sync_files(
|
||||
# Transform links
|
||||
transformed = transform_links(content)
|
||||
|
||||
# Wiki filename: use the page title with spaces → underscores
|
||||
# Gitea wiki uses the page title as filename (spaces become dashes)
|
||||
wiki_filename = page_title.replace(" ", "-") + ".md"
|
||||
expected_files.add(wiki_filename)
|
||||
# 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 / wiki_filename
|
||||
dest = wiki_dir / fname
|
||||
dest.write_text(transformed, encoding="utf-8")
|
||||
synced += 1
|
||||
click.echo(_(" Synced: {title} → {file}", title=page_title, file=wiki_filename))
|
||||
click.echo(_(" Synced: {title} → {file}", title=page_title, file=fname))
|
||||
|
||||
# Prune stale pages (in wiki but not in mapping)
|
||||
pruned = 0
|
||||
@@ -208,7 +229,19 @@ def commit_and_push(wiki_dir: Path, wiki_url: str, dry_run: bool) -> bool:
|
||||
click.echo(_("No changes to sync — wiki is up to date."))
|
||||
return False
|
||||
|
||||
# Commit
|
||||
# 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,
|
||||
@@ -218,7 +251,7 @@ def commit_and_push(wiki_dir: Path, wiki_url: str, dry_run: bool) -> bool:
|
||||
|
||||
# Push
|
||||
result = subprocess.run( # nosec
|
||||
["git", "push", wiki_url, "HEAD:master"],
|
||||
["git", "push", "--force", wiki_url, "HEAD:master"],
|
||||
cwd=wiki_dir,
|
||||
capture_output=True,
|
||||
text=True,
|
||||
@@ -293,6 +326,9 @@ def main(dry_run: bool, repo: str | None, verify: bool) -> None:
|
||||
|
||||
# Verification
|
||||
if verify and not dry_run:
|
||||
if pushed:
|
||||
click.echo(_("Waiting 5s for Gitea to process pushed commits..."))
|
||||
time.sleep(5)
|
||||
click.echo(_("\nVerifying wiki pages..."))
|
||||
# Re-clone to verify
|
||||
verify_dir = Path(tmpdir) / "verify"
|
||||
@@ -301,8 +337,8 @@ def main(dry_run: bool, repo: str | None, verify: bool) -> None:
|
||||
raise click.ClickException(_("Wiki verification failed — could not clone wiki"))
|
||||
failures = 0
|
||||
for _file_path, page_title in sorted(mapping.items()):
|
||||
wiki_filename = page_title.replace(" ", "-") + ".md"
|
||||
if (verify_dir / wiki_filename).exists():
|
||||
fname = wiki_filename(page_title)
|
||||
if (verify_dir / fname).exists():
|
||||
click.echo(_(" OK: {title}", title=page_title))
|
||||
else:
|
||||
click.echo(_(" FAIL: {title} — page not found in wiki!", title=page_title))
|
||||
|
||||
@@ -19,6 +19,7 @@ from devx.ci.sync_wiki import (
|
||||
main,
|
||||
sync_files,
|
||||
transform_links,
|
||||
wiki_filename,
|
||||
)
|
||||
|
||||
|
||||
@@ -96,6 +97,29 @@ class TestGetWikiCloneUrl:
|
||||
assert "owner/repo.wiki.git" in url
|
||||
|
||||
|
||||
class TestWikiFilename:
|
||||
def test_no_dashes(self) -> None:
|
||||
assert wiki_filename("Home") == "Home.md"
|
||||
|
||||
def test_single_word(self) -> None:
|
||||
assert wiki_filename("Architecture") == "Architecture.md"
|
||||
|
||||
def test_with_dashes_adds_marker(self) -> None:
|
||||
assert wiki_filename("Getting-Started") == "Getting-Started.-.md"
|
||||
|
||||
def test_spaces_become_dashes_with_marker(self) -> None:
|
||||
# "Getting Started" → "Getting-Started" (has dash) → marker added
|
||||
assert wiki_filename("Getting Started") == "Getting-Started.-.md"
|
||||
|
||||
def test_spaces_no_dashes_no_marker(self) -> None:
|
||||
# "Foo Bar" → "Foo-Bar" (has dash) → marker added
|
||||
assert wiki_filename("Foo Bar") == "Foo-Bar.-.md"
|
||||
|
||||
def test_single_word_with_spaces_no_dash(self) -> None:
|
||||
# No dash at all after conversion → no marker
|
||||
assert wiki_filename("HelloWorld") == "HelloWorld.md"
|
||||
|
||||
|
||||
class TestCloneWiki:
|
||||
@patch("devx.ci.sync_wiki.subprocess.run")
|
||||
def test_clone_success(self, mock_run: MagicMock, tmp_path: Path) -> None:
|
||||
@@ -208,6 +232,8 @@ class TestCommitAndPush:
|
||||
mock_run.side_effect = [
|
||||
MagicMock(returncode=0), # git add
|
||||
MagicMock(returncode=1), # git diff --cached --quiet (has changes)
|
||||
MagicMock(returncode=0), # git config user.email
|
||||
MagicMock(returncode=0), # git config user.name
|
||||
MagicMock(returncode=0), # git commit
|
||||
MagicMock(returncode=0, stdout="", stderr=""), # git push
|
||||
]
|
||||
@@ -219,6 +245,8 @@ class TestCommitAndPush:
|
||||
mock_run.side_effect = [
|
||||
MagicMock(returncode=0), # git add
|
||||
MagicMock(returncode=1), # git diff --cached --quiet (has changes)
|
||||
MagicMock(returncode=0), # git config user.email
|
||||
MagicMock(returncode=0), # git config user.name
|
||||
MagicMock(returncode=0), # git commit
|
||||
MagicMock(returncode=1, stdout="", stderr="push failed"), # git push
|
||||
]
|
||||
@@ -319,6 +347,7 @@ class TestMain:
|
||||
assert result.exit_code == 0
|
||||
mock_init.assert_called_once()
|
||||
|
||||
@patch("devx.ci.sync_wiki.time.sleep")
|
||||
@patch("devx.ci.sync_wiki.clone_wiki")
|
||||
@patch("devx.ci.sync_wiki.commit_and_push", return_value=True)
|
||||
@patch("devx.ci.sync_wiki.sync_files", return_value=(1, 0))
|
||||
@@ -327,6 +356,7 @@ class TestMain:
|
||||
mock_sync: MagicMock,
|
||||
mock_push: MagicMock,
|
||||
mock_clone: MagicMock,
|
||||
mock_sleep: MagicMock,
|
||||
tmp_path: Path,
|
||||
monkeypatch: pytest.MonkeyPatch,
|
||||
) -> None:
|
||||
@@ -376,6 +406,7 @@ class TestMain:
|
||||
assert result.exit_code == 0
|
||||
assert "No push needed" in result.output
|
||||
|
||||
@patch("devx.ci.sync_wiki.time.sleep")
|
||||
@patch("devx.ci.sync_wiki.clone_wiki", side_effect=[True, False])
|
||||
@patch("devx.ci.sync_wiki.commit_and_push", return_value=True)
|
||||
@patch("devx.ci.sync_wiki.sync_files", return_value=(1, 0))
|
||||
@@ -384,6 +415,7 @@ class TestMain:
|
||||
mock_sync: MagicMock,
|
||||
mock_push: MagicMock,
|
||||
mock_clone: MagicMock,
|
||||
mock_sleep: MagicMock,
|
||||
tmp_path: Path,
|
||||
monkeypatch: pytest.MonkeyPatch,
|
||||
) -> None:
|
||||
@@ -400,6 +432,7 @@ class TestMain:
|
||||
assert result.exit_code != 0
|
||||
assert "could not clone" in result.output
|
||||
|
||||
@patch("devx.ci.sync_wiki.time.sleep")
|
||||
@patch("devx.ci.sync_wiki.clone_wiki")
|
||||
@patch("devx.ci.sync_wiki.commit_and_push", return_value=True)
|
||||
@patch("devx.ci.sync_wiki.sync_files", return_value=(1, 0))
|
||||
@@ -408,6 +441,7 @@ class TestMain:
|
||||
mock_sync: MagicMock,
|
||||
mock_push: MagicMock,
|
||||
mock_clone: MagicMock,
|
||||
mock_sleep: MagicMock,
|
||||
tmp_path: Path,
|
||||
monkeypatch: pytest.MonkeyPatch,
|
||||
) -> None:
|
||||
|
||||
Reference in New Issue
Block a user