create-riebeckite 0.0.11 → 0.0.12

package/README.md

@@ -21,6 +21,10 @@ npm exec riebeckite build
 | `--preset <name>` | Starter composition, e.g. `rich` (default: `starter`) |
 | `--force` | Scaffold even when the target directory is not empty |
 | `--list-presets` | Print the available presets and their descriptions, then exit |
+| `--github-actions` | Generate the Cloudflare deployment workflow |
+| `--content-repository <owner/repository>` | Check out this repository into `content/` during deployment (requires `--github-actions`) |
+| `--site-repository <owner/repository>` | Site repository notified by the generated content workflow |
+| `--notify-on-content-push` | Generate `github/notify-site.yml` for the content repository (requires Actions, content, and site repositories) |
 
 For example, scaffold with the `rich` preset:
 
@@ -28,6 +32,21 @@ For example, scaffold with the `rich` preset:
 npx create-riebeckite my-site --preset rich
 ```
 
+To use a separate content repository and deploy after its `main` branch is
+pushed, generate the common workflow once (the preset does not affect it):
+
+```sh
+npx create-riebeckite my-site --github-actions \
+  --content-repository OWNER/notes \
+  --site-repository OWNER/my-site \
+  --notify-on-content-push
+```
+
+Set `content.directory` to `"content"`, add the documented repository secrets,
+then copy `github/notify-site.yml` into the content repository as
+`.github/workflows/notify-site.yml`. See the [separate-content deployment
+guide](../../templates/cloudflare/README_en.md).
+
 ## Presets
 
 List the available presets with `--list-presets`:
@@ -76,4 +95,4 @@ await scaffoldRiebeckiteSite({
 Riebeckite is an extensible framework for publishing Markdown and
 Obsidian-oriented notes on the web. See the
 [Riebeckite documentation](https://github.com/Rerurate514/riebeckite#readme)
-for configuration and plugin guidance.
+for configuration and plugin guidance.

package/README_ja.md

@@ -22,6 +22,10 @@ npm exec riebeckite build
 | `--preset <name>` | 使用するスターター構成（既定は `starter`） |
 | `--force` | 空でないディレクトリにも展開する |
 | `--list-presets` | 利用可能な preset と説明を一覧表示して終了する |
+| `--github-actions` | Cloudflare へのデプロイ workflow を生成する |
+| `--content-repository <owner/repository>` | デプロイ時にこのリポジトリを `content/` へ checkout する（`--github-actions` が必要） |
+| `--site-repository <owner/repository>` | 生成する記事通知 workflow が通知する site リポジトリ |
+| `--notify-on-content-push` | 記事リポジトリ用の `github/notify-site.yml` を生成する（Actions、記事・site リポジトリが必要） |
 
 たとえば、`rich` preset で生成する場合は次のようにします。
 
@@ -29,6 +33,21 @@ npm exec riebeckite build
 npx create-riebeckite my-site --preset rich
 ```
 
+別の記事リポジトリを使い、その `main` への push でデプロイする場合は、共通の
+workflow を一度だけ生成します。preset による違いはありません。
+
+```sh
+npx create-riebeckite my-site --github-actions \
+  --content-repository OWNER/notes \
+  --site-repository OWNER/my-site \
+  --notify-on-content-push
+```
+
+`content.directory` は `"content"` にし、必要な repository Secret を登録した後、
+`github/notify-site.yml` を記事リポジトリの
+`.github/workflows/notify-site.yml` にコピーします。詳細は[別記事リポジトリの
+デプロイガイド](../../templates/cloudflare/README_ja.md)を参照してください。
+
 ## Preset
 
 利用可能な preset は `--list-presets` で確認できます。
@@ -62,4 +81,4 @@ npx create-riebeckite --list-presets
 Riebeckite は、Markdown や Obsidian 由来のノートを Web で公開するための
 拡張可能なフレームワークです。設定方法やプラグインについては
 [Riebeckite ドキュメント](https://github.com/Rerurate514/riebeckite#readme)
-を参照してください。
+を参照してください。

package/dist/src/index.d.ts

@@ -4,5 +4,9 @@ export type CreateRiebeckiteOptions = {
     readonly force: boolean;
     readonly preset: ScaffoldPresetName;
     readonly listPresets: boolean;
+    readonly githubActions: boolean;
+    readonly contentRepository?: string;
+    readonly siteRepository?: string;
+    readonly notifyOnContentPush: boolean;
 };
 export declare function runCreateRiebeckite(arguments_: readonly string[]): Promise<void>;

package/dist/src/index.js

@@ -26,12 +26,22 @@ async function runCreateRiebeckite(arguments_) {
     const result = await scaffoldRiebeckiteSite({
       targetDirectory,
       overwrite: options.force,
-      preset: options.preset
+      preset: options.preset,
+      githubActions: options.githubActions,
+      contentRepository: options.contentRepository,
+      siteRepository: options.siteRepository,
+      notifyOnContentPush: options.notifyOnContentPush
     });
     const relative = path.relative(process.cwd(), result.targetDirectory) || ".";
     console.log(`Created a ${options.preset} Riebeckite site in ${relative}`);
     console.log("");
     console.log(formatScaffoldNextSteps(relative));
+    if (options.notifyOnContentPush) {
+      console.log("");
+      console.log(
+        "Copy github/notify-site.yml to the content repository as .github/workflows/notify-site.yml."
+      );
+    }
   } catch (error) {
     if (error instanceof ScaffoldSiteError) {
       console.error(error.message);
@@ -46,6 +56,10 @@ function parseArguments(arguments_) {
   let force = false;
   let preset;
   let listPresets = false;
+  let githubActions = false;
+  let contentRepository;
+  let siteRepository;
+  let notifyOnContentPush = false;
   for (let index = 0; index < arguments_.length; index += 1) {
     const argument = arguments_[index];
     if (argument === "--force") {
@@ -56,6 +70,24 @@ function parseArguments(arguments_) {
       listPresets = true;
       continue;
     }
+    if (argument === "--github-actions") {
+      githubActions = true;
+      continue;
+    }
+    if (argument === "--notify-on-content-push") {
+      notifyOnContentPush = true;
+      continue;
+    }
+    if (argument === "--content-repository" || argument === "--site-repository") {
+      const value = arguments_[index + 1];
+      if (value === void 0 || value.startsWith("-")) {
+        throw new Error(`${argument} requires an owner/repository value.`);
+      }
+      if (argument === "--content-repository") contentRepository = value;
+      else siteRepository = value;
+      index += 1;
+      continue;
+    }
     if (argument === "--preset") {
       const value = arguments_[index + 1];
       if (value === void 0 || !isScaffoldPresetName(value)) {
@@ -72,7 +104,7 @@ function parseArguments(arguments_) {
     }
     if (directory !== void 0) {
       throw new Error(
-        "Usage: create-riebeckite [directory] [--preset <name>] [--force]"
+        "Usage: create-riebeckite [directory] [--preset <name>] [--github-actions] [--content-repository <owner/repository>] [--site-repository <owner/repository>] [--notify-on-content-push] [--force]"
       );
     }
     directory = argument;
@@ -81,7 +113,11 @@ function parseArguments(arguments_) {
     directory: directory ?? ".",
     force,
     preset: preset ?? "starter",
-    listPresets
+    listPresets,
+    githubActions,
+    contentRepository,
+    siteRepository,
+    notifyOnContentPush
   };
 }
 function printPresets() {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-riebeckite",
-  "version": "0.0.11",
+  "version": "0.0.12",
   "license": "Apache-2.0",
   "type": "module",
   "main": "./dist/src/index.js",
@@ -27,7 +27,7 @@
     "access": "public"
   },
   "dependencies": {
-    "@riebeckite/honox": "0.0.11"
+    "@riebeckite/honox": "0.0.12"
   },
   "repository": {
     "type": "git",