chore: prepare html-explainer v1.2.2 for public release
First public release of the html-explainer skill: deterministic HTML-to-MP4 explainer video pipeline for AI coding agents. Additions since v1.2.1: - scripts/lint_frames.py: pre-render audit of the eight frame-contract rules - scripts/peek_frame.mjs: single-scene screenshot preview (seconds, not minutes) - scripts/check_integrity.py: version/catalog/count consistency + stray-CDN scan - Bilingual README (README.md Chinese default, README.en.md English) - LICENSE (MIT), THIRD_PARTY_NOTICES.md, licenses/Apache-2.0.txt - CHANGELOG.md, CONTRIBUTING.md, .gitignore, .gitattributes - GitHub CI workflow and issue/PR templates Fixes and docs: - document lint_frames.py and peek_frame.mjs, previously absent from the file table - add the lint stage to the pipeline order - remove references to private client projects so the skill can ship publicly - record the full upstream attribution chain for the style catalog - package_skill.py now excludes repo-hygiene files and keeps licence files
This commit is contained in:
MohZhuang committed
commit
66b61002f2
42 files changed
+8004
No files matched your search
@@ -0,0 +1,83 @@
|
||||
name: Bug report
|
||||
description: Something rendered wrong, failed silently, or crashed.
|
||||
title: "[Bug] "
|
||||
labels: ["bug"]
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
Thanks for the report. This pipeline fails **silently** by design — a broken
|
||||
frame usually still produces a plausible-looking video. The more of the detail
|
||||
below you can fill in, the faster this gets diagnosed.
|
||||
|
||||
- type: dropdown
|
||||
id: stage
|
||||
attributes:
|
||||
label: Which stage failed?
|
||||
options:
|
||||
- "0 · new_project (scaffold)"
|
||||
- "1 · tts_build (voiceover)"
|
||||
- "2 · timeline_build (global timeline)"
|
||||
- "3 · subs (subtitles / beats)"
|
||||
- "4 · lint_frames (static audit)"
|
||||
- "5 · render_video (rendering)"
|
||||
- "6 · qc_check (audit)"
|
||||
- "7 · cover_build (covers)"
|
||||
- "setup_env / environment"
|
||||
- "Not sure"
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: what-happened
|
||||
attributes:
|
||||
label: What happened?
|
||||
description: Include the exact command you ran and the full output.
|
||||
placeholder: |
|
||||
Command: node scripts/render_video.mjs . --preview 30
|
||||
Expected: 30s preview with animated cards
|
||||
Actual: preview renders, but the number counter never moves
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: symptom-class
|
||||
attributes:
|
||||
label: Did it fail loudly or silently?
|
||||
description: >
|
||||
Silent failures are the interesting ones here. If playback works but the output
|
||||
is wrong (frozen element, desynced subtitle, missing text), say so explicitly.
|
||||
validations:
|
||||
required: false
|
||||
|
||||
- type: textarea
|
||||
id: environment
|
||||
attributes:
|
||||
label: Environment
|
||||
description: "Run these and paste the result."
|
||||
value: |
|
||||
- OS:
|
||||
- `node -v`:
|
||||
- `python -V`:
|
||||
- Shell (Git Bash / PowerShell / zsh):
|
||||
- Browser used for rendering (Chrome / Edge / playwright chromium):
|
||||
- ffmpeg source (PATH / imageio-ffmpeg):
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: input
|
||||
id: version
|
||||
attributes:
|
||||
label: Version
|
||||
description: The `version:` field in SKILL.md, or the release tag.
|
||||
placeholder: "1.2.2"
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: qc-output
|
||||
attributes:
|
||||
label: QC output (if you got as far as rendering)
|
||||
description: Paste `out/qc_report.md`, or attach the contact sheet.
|
||||
validations:
|
||||
required: false
|
||||
@@ -0,0 +1,11 @@
|
||||
blank_issues_enabled: false
|
||||
contact_links:
|
||||
- name: Read the frame contract first
|
||||
url: https://github.com/OneMoh/html-explainer/blob/main/references/frame-contract.md
|
||||
about: Most "my frame renders but looks wrong" reports are explained by the eight contract rules.
|
||||
- name: Check the lessons ledger
|
||||
url: https://github.com/OneMoh/html-explainer/blob/main/references/lessons.md
|
||||
about: Known silent-failure modes and their diagnoses. Worth a search before filing.
|
||||
- name: Setup and environment issues
|
||||
url: https://github.com/OneMoh/html-explainer/blob/main/README.md#疑难排查
|
||||
about: Run `bash setup_env.sh` and compare against the troubleshooting table (English version: README.en.md#troubleshooting).
|
||||
@@ -0,0 +1,51 @@
|
||||
name: Feature request
|
||||
description: Propose a new capability, style, or workflow improvement.
|
||||
title: "[Feature] "
|
||||
labels: ["enhancement"]
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
This project deliberately keeps a small surface: HTML frames in, MP4 out, with
|
||||
audio-video sync that actually holds. Proposals that add a build system, a plugin
|
||||
API, or a cloud dependency are usually out of scope — but say so if you think
|
||||
there's an important exception.
|
||||
|
||||
- type: textarea
|
||||
id: problem
|
||||
attributes:
|
||||
label: What problem does this solve?
|
||||
description: Describe the situation you're in, not the API you want.
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: proposal
|
||||
attributes:
|
||||
label: Proposed approach
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: dropdown
|
||||
id: area
|
||||
attributes:
|
||||
label: Area
|
||||
options:
|
||||
- Visual styles / templates
|
||||
- Narration / TTS
|
||||
- Subtitles / beat sync
|
||||
- Rendering
|
||||
- QC / auditing
|
||||
- Covers
|
||||
- Docs
|
||||
- Other
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: alternatives
|
||||
attributes:
|
||||
label: Alternatives considered
|
||||
description: Including "just do it manually" — it's a valid answer.
|
||||
validations:
|
||||
required: false
|
||||
@@ -0,0 +1,32 @@
|
||||
## What this changes
|
||||
|
||||
<!-- One or two sentences. What was wrong, and what does this do about it? -->
|
||||
|
||||
## Why
|
||||
|
||||
<!--
|
||||
If this fixes a silent failure, explain what was misbehaving and how you proved the
|
||||
cause. "I tried X, it still broke; I changed Y, it worked" is genuinely useful here —
|
||||
this pipeline produces plausible-looking output while being wrong.
|
||||
-->
|
||||
|
||||
## How it was verified
|
||||
|
||||
<!--
|
||||
Not "it should work". What did you actually run?
|
||||
e.g. `node scripts/peek_frame.mjs . hook --at 25,50,85` and inspected the 50% frame
|
||||
-->
|
||||
|
||||
## Checklist
|
||||
|
||||
- [ ] `python scripts/lint_frames.py --project <project>` reports no FAILs for frames I touched
|
||||
- [ ] I actually rendered the change and looked at the output
|
||||
- [ ] No external fonts, CDN links, or hardcoded colour literals introduced
|
||||
- [ ] New lesson (if any) appended to `references/lessons.md` with the next number
|
||||
- [ ] `python scripts/check_integrity.py` passes
|
||||
- [ ] `README.md` and `README.en.md` updated together if user-facing behaviour changed
|
||||
- [ ] `THIRD_PARTY_NOTICES.md` updated if third-party content was added or re-derived
|
||||
|
||||
## Related issues
|
||||
|
||||
<!-- Closes #... -->
|
||||
@@ -0,0 +1,85 @@
|
||||
name: CI
|
||||
|
||||
on:
|
||||
push:
|
||||
branches: [main]
|
||||
pull_request:
|
||||
branches: [main]
|
||||
workflow_dispatch:
|
||||
|
||||
# Only the latest run per branch matters; cancel superseded ones.
|
||||
concurrency:
|
||||
group: ${{ github.workflow }}-${{ github.ref }}
|
||||
cancel-in-progress: true
|
||||
|
||||
jobs:
|
||||
checks:
|
||||
name: ${{ matrix.os }} / py${{ matrix.python }}
|
||||
runs-on: ${{ matrix.os }}
|
||||
strategy:
|
||||
fail-fast: false
|
||||
matrix:
|
||||
# Windows + Git Bash is the primary development platform, so it is
|
||||
# tested alongside Linux rather than treated as an afterthought.
|
||||
os: [ubuntu-latest, windows-latest]
|
||||
python: ["3.9", "3.13"]
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
|
||||
- uses: actions/setup-python@v5
|
||||
with:
|
||||
python-version: ${{ matrix.python }}
|
||||
|
||||
- uses: actions/setup-node@v4
|
||||
with:
|
||||
node-version: "22"
|
||||
|
||||
# --- Repo self-consistency: version drift, catalog drift, stray CDN links ---
|
||||
- name: Repository integrity check
|
||||
run: python scripts/check_integrity.py
|
||||
|
||||
# --- Python scripts must at least compile on the oldest supported version ---
|
||||
- name: Compile Python scripts
|
||||
run: python -m compileall -q scripts
|
||||
|
||||
# --- Frame audit tool must be importable and its CLI must respond ---
|
||||
- name: Lint tool smoke test
|
||||
run: python scripts/lint_frames.py --help
|
||||
|
||||
- name: Integrity checker smoke test
|
||||
run: python scripts/check_integrity.py --root .
|
||||
|
||||
# --- Shell entrypoint syntax ---
|
||||
- name: Check setup_env.sh syntax
|
||||
shell: bash
|
||||
run: bash -n setup_env.sh
|
||||
|
||||
# --- Renderer / cover builder / peek tool syntax ---
|
||||
- name: Check Node module syntax
|
||||
shell: bash
|
||||
run: |
|
||||
set -e
|
||||
for f in scripts/*.mjs; do
|
||||
echo "checking $f"
|
||||
node --check "$f"
|
||||
done
|
||||
|
||||
- name: Check templates are self-contained
|
||||
shell: bash
|
||||
run: |
|
||||
set -e
|
||||
# Frames must never reach out to a CDN or web font: offline rendering
|
||||
# degrades silently rather than failing.
|
||||
# Scope to HTML only — markdown docs legitimately *mention* these URLs
|
||||
# (e.g. the guide explaining that you must delete them), and GSAP's own
|
||||
# bundled README documents its CDN option.
|
||||
hits=$(grep -rInE --include='*.html' \
|
||||
'https?://[^"'"'"' ]*(fonts\.googleapis|fonts\.gstatic|cdn\.)' . \
|
||||
|| true)
|
||||
if [ -n "$hits" ]; then
|
||||
echo "$hits"
|
||||
echo "::error::external font or CDN reference found in an HTML template"
|
||||
exit 1
|
||||
fi
|
||||
echo "no external font or CDN references in HTML templates"
|
||||
Reference in new issue
Block a user