automation/songs #1

Merged
mikkeli merged 6 commits from automation/songs into main 2026-06-09 09:03:36 +00:00
4 changed files with 293 additions and 0 deletions
Showing only changes of commit 7f1bf2f995 - Show all commits
+97
View File
@@ -0,0 +1,97 @@
on:
workflow_call:
inputs:
SOURCE_REF:
description: "Commit SHA that was pushed to ncmr-songs"
required: true
type: string
SOURCE_BASE_REF:
description: "Commit SHA before the push (all-zeros = first push)"
required: true
type: string
FULL_PUBLISH:
description: "Re-publish every file regardless of diff"
required: false
type: boolean
default: false
jobs:
publish:
runs-on: ubuntu-latest
container:
image: python:3.12-slim
steps:
- name: Install system deps
run: |
apt-get update -qq
apt-get install -y --no-install-recommends git pandoc ca-certificates
- name: Checkout ncmr-songs
env:
FAPAT: ${{ secrets.FAPAT }}
run: |
SERVER="${{ github.server_url }}"
PROTO="${SERVER%%://*}"
HOST="${SERVER#*://}"
AUTHED="${PROTO}://mikkeli:${FAPAT}@${HOST}"
git clone "${AUTHED}/mikkeli/ncmr-songs" ncmr-songs
git -C ncmr-songs checkout ${{ inputs.SOURCE_REF }}
- name: Checkout auto-wiki
env:
FAPAT: ${{ secrets.FAPAT }}
run: |
SERVER="${{ github.server_url }}"
PROTO="${SERVER%%://*}"
HOST="${SERVER#*://}"
AUTHED="${PROTO}://mikkeli:${FAPAT}@${HOST}"
git clone "${AUTHED}/mikkeli/novoyuuparosk-auto-wiki" auto-wiki
- name: Install Python deps
run: pip install --no-cache-dir -r auto-wiki/pipelines/songs/requirements.txt
- name: Detect changed files
id: diff
run: |
BASE="${{ inputs.SOURCE_BASE_REF }}"
HEAD="${{ inputs.SOURCE_REF }}"
# All-zeros base means first push — publish everything
if [ -z "$BASE" ] || echo "$BASE" | grep -qE '^0+$'; then
echo "mode=all" >> "$GITHUB_OUTPUT"
else
git -C ncmr-songs diff --name-only "$BASE" "$HEAD" -- '*.md' \
| grep -v '^wip/' \
| grep -v '^README\.md' \
> /tmp/changed.txt 2>/dev/null || true
echo "Changed files:"
cat /tmp/changed.txt
echo "mode=incremental" >> "$GITHUB_OUTPUT"
echo "files=$(tr '\n' ' ' < /tmp/changed.txt)" >> "$GITHUB_OUTPUT"
fi
- name: Publish
env:
WIKI_API_URL: ${{ vars.WIKI_API_URL }}
WIKI_BASE_URL: ${{ vars.WIKI_BASE_URL }}
WIKI_BOT_USER: ${{ secrets.WIKI_BOT_USER }}
WIKI_BOT_PASSWORD: ${{ secrets.WIKI_BOT_PASSWORD }}
SOURCE_REF: ${{ inputs.SOURCE_REF }}
GITEA_REPO_URL: ${{ github.server_url }}/mikkeli/ncmr-songs
run: |
MODE="${{ steps.diff.outputs.mode }}"
if [ "$MODE" = "all" ] || [ "${{ inputs.FULL_PUBLISH }}" = "true" ]; then
python auto-wiki/pipelines/songs/render.py \
--source-dir ncmr-songs \
--all
else
FILES="${{ steps.diff.outputs.files }}"
if [ -z "$FILES" ]; then
echo "No changed .md files detected. Nothing to publish."
exit 0
fi
# shellcheck disable=SC2086
python auto-wiki/pipelines/songs/render.py \
--source-dir ncmr-songs \
--files $FILES
fi
+184
View File
@@ -0,0 +1,184 @@
#!/usr/bin/env python3
"""Songs pipeline renderer — converts source .md files to MediaWiki pages."""
import argparse
import os
import subprocess
import sys
from datetime import datetime, timezone
from pathlib import Path
import frontmatter
import mwclient
def validate(fm: dict, path: Path) -> None:
errors = []
for field in ("title", "album"):
val = fm.get(field)
if not val or not str(val).strip():
errors.append(f"missing or empty '{field}'")
wiki = fm.get("wiki")
if not isinstance(wiki, dict) or "publish" not in wiki:
errors.append("missing 'wiki.publish'")
elif not isinstance(wiki["publish"], bool):
errors.append("'wiki.publish' must be a boolean (true/false), not a string")
if "release_date" in fm and fm["release_date"]:
try:
datetime.strptime(str(fm["release_date"]), "%Y-%m-%d")
except ValueError:
errors.append("'release_date' must be YYYY-MM-DD")
if errors:
raise ValueError(f"{path}: " + "; ".join(errors))
def strip_first_h1(text: str) -> str:
"""Remove the first '# Heading' line and any immediately following blank line."""
lines = text.split("\n")
for i, line in enumerate(lines):
if line.strip().startswith("# "):
del lines[i]
if i < len(lines) and lines[i].strip() == "":
del lines[i]
break
return "\n".join(lines)
def markdown_to_wikitext(body: str) -> str:
result = subprocess.run(
["pandoc", "-f", "markdown", "-t", "mediawiki"],
input=body,
capture_output=True,
text=True,
)
if result.returncode != 0:
raise RuntimeError(f"pandoc failed: {result.stderr.strip()}")
return result.stdout
def build_wikitext(fm: dict, body_wikitext: str, source_url: str) -> str:
now = datetime.now(timezone.utc).strftime("%Y-%m-%dT%H:%M:%SZ")
banner = f"{{{{Auto-generated|source={source_url}|generated_at={now}}}}}"
category = f"[[Category:{fm['album']}]]"
return f"{banner}\n\n{body_wikitext}\n{category}\n"
def connect_wiki() -> mwclient.Site:
from urllib.parse import urlparse
api_url = os.environ["WIKI_API_URL"]
parsed = urlparse(api_url)
host = parsed.netloc
# Strip api.php to get the wiki root path (e.g. "/" or "/w/")
path = parsed.path[: parsed.path.rfind("/") + 1] or "/"
site = mwclient.Site(host, path=path, scheme=parsed.scheme)
site.login(os.environ["WIKI_BOT_USER"], os.environ["WIKI_BOT_PASSWORD"])
return site
def publish_one(rel: Path, post, site: mwclient.Site, source_ref: str, gitea_repo_url: str) -> str:
"""Returns 'published', 'noop', or 'skipped'."""
fm = post.metadata
if not fm["wiki"]["publish"]:
return "skipped"
body_wikitext = markdown_to_wikitext(strip_first_h1(post.content))
source_url = f"{gitea_repo_url}/src/commit/{source_ref}/{rel}"
page_content = build_wikitext(fm, body_wikitext, source_url)
page = site.pages[fm["title"]]
if page.text() == page_content:
return "noop"
ref_short = source_ref[:8] if source_ref else "unknown"
page.save(page_content, summary=f"Auto-published from {ref_short} (songs pipeline)")
return "published"
def load_and_validate(files: list[Path], source_dir: Path) -> dict[Path, object]:
posts = {}
titles: dict[str, Path] = {}
for path in files:
if not path.exists():
print(f" warn: {path} not found, skipping", file=sys.stderr)
continue
post = frontmatter.load(str(path))
validate(post.metadata, path)
if post.metadata["wiki"]["publish"]:
title = str(post.metadata["title"])
if title in titles:
raise ValueError(
f"Duplicate wiki title '{title}': {path} and {titles[title]}"
)
titles[title] = path
posts[path] = post
return posts
def main() -> None:
parser = argparse.ArgumentParser(description="Publish song .md files to MediaWiki.")
parser.add_argument("--source-dir", required=True, type=Path)
parser.add_argument("--files", nargs="*", default=[], help="Relative paths within source-dir")
parser.add_argument("--all", action="store_true", help="Publish all publishable files")
args = parser.parse_args()
source_dir = args.source_dir.resolve()
source_ref = os.environ.get("SOURCE_REF", "")
gitea_repo_url = os.environ.get("GITEA_REPO_URL", "").rstrip("/")
if args.all:
candidates = list(source_dir.rglob("*.md"))
elif args.files:
candidates = [source_dir / f for f in args.files]
else:
print("Nothing to do: pass --files or --all.")
return
files = [
p for p in candidates
if p.exists()
and p.suffix == ".md"
and "wip" not in p.relative_to(source_dir).parts
and p.name != "README.md"
]
if not files:
print("No publishable candidates after filtering.")
return
print(f"Validating {len(files)} file(s)...")
posts = load_and_validate(files, source_dir)
print("Validation passed.")
site = connect_wiki()
counts = {"published": 0, "noop": 0, "skipped": 0}
for abs_path, post in posts.items():
rel = abs_path.relative_to(source_dir)
outcome = publish_one(rel, post, site, source_ref, gitea_repo_url)
counts[outcome] += 1
print(f" [{outcome}] {rel}")
print(
f"\nDone: {counts['published']} published, "
f"{counts['noop']} unchanged, "
f"{counts['skipped']} skipped (wiki.publish=false)."
)
if __name__ == "__main__":
try:
main()
except Exception as e:
print(f"ERROR: {e}", file=sys.stderr)
sys.exit(1)
+3
View File
@@ -0,0 +1,3 @@
python-frontmatter>=1.1.0
mwclient>=0.10.1
PyYAML>=6.0
@@ -0,0 +1,9 @@
{{#if:{{{source|}}}|<div style="background:#f8f9fa;border:1px solid #a2a9b1;padding:0.4em 0.8em;margin-bottom:1em;font-size:0.85em;color:#54595d;">&#x26A0;&#xFE0F; This page is automatically published from source. Manual edits will be overwritten on the next pipeline run. &nbsp;&bull;&nbsp; Source: [{{{source}}} view on Gitea] &nbsp;&bull;&nbsp; Generated: {{{generated_at}}}</div>}}
<noinclude>
== Usage ==
Applied automatically by the songs pipeline. Parameters:
* <code>source</code> — URL to the source file on Gitea
* <code>generated_at</code> — ISO 8601 timestamp of the publishing run
[[Category:Auto-generated templates]]
</noinclude>