開発¶
フロントエンドは src/cc_calendar/static/ にあるプレーンな HTML、CSS、ES モジュールで、ビルド手順はありません。
テストには合成ログのみを使います。実際のトランスクリプトは決してコミットしないでください。
スクリーンショット¶
スクリーンショットは、scripts/demo_data.py が生成する架空のデータ(メモとタグを含む)から描画されます。
インストール済みの Google Chrome を使い、あなた自身のメモや検索インデックスには
手を触れません。
このサイト¶
このサイトは docs/ と zensical.toml から Zensical でビルドしています。
main へのプッシュでサイトに関わるファイル(docs/、zensical.toml、pyproject.toml、uv.lock)が
変更されると、GitHub Actions が GitHub Pages にデプロイします。
ローカルでプレビューするには次のようにします。
日本語のページは docs/ja/ にあり、zensical.ja.toml で site/ja にビルドされ、/cc-calendar/ja/ で
公開されます。英語のページを変更したときは、同じプルリクエストで対応する docs/ja/ のページも更新してください。
見出しの { #anchor } ID は英語のスラッグと同一に保ち、画像は ../images/… で参照します(どちらも tests/test_docs.py で検査します)。
両方のサイトをローカルでビルドするには次のようにします。
リリース¶
バージョンタグをプッシュすると、.github/workflows/release.yml によってパッケージが
PyPI に公開されます。
-
mainでバージョンを上げ(バージョンはpyproject.tomlにのみ記載されています)、マージします。 -
マージしたコミットにタグを付け、タグをプッシュします。
ワークフローは、タグがバージョンと一致することを確認し、lint とテストを実行し、wheel と sdist をビルドして、
wheel のスモークテストを行います。その後、trusted publishing(pypi environment)で PyPI に公開し、
ファイルを GitHub のリリースに添付します。リリースがまだ存在しない場合はドラフトとして作成するので、
リリースノートを書いてから公開できます。
PyPI は同じバージョンを 2 回受け付けません。アップロード後に公開が失敗した場合は、タグを付け直さずに バージョンをもう一度上げてください。
謝辞¶
@tokkyo さんのこちらの投稿で紹介されていたツールに着想を得ています。 これは独自に再実装したもので、オリジナルとは関係ありません。