@riebeckite/plugin-deploy 0.0.34 → 0.0.36

package/README.md

@@ -8,6 +8,22 @@ It does not upload anything and never writes to the filesystem.
 
 [日本語](./README_ja.md)
 
+## What it does
+
+- Generates provider-specific redirect and header files during `riebeckite build`.
+- Reads redirects only from `manifest.publicRedirects`.
+- Supports Cloudflare Pages, Cloudflare Workers, Netlify, Vercel, and GitHub
+  Pages.
+
+## What it does not do
+
+- It does not upload files, authenticate with a provider, or invalidate caches.
+- It does not deploy the site. Upload the build output with your provider's
+  normal deploy step, or use the publication workflow's `publish run --execute`
+  when your site is configured for it.
+- `riebeckite deploy setup` is a separate CLI helper that prepares Cloudflare
+  configuration. It also does not upload anything.
+
 ## Overview
 
 `deploy()` reads public redirects from the content manifest and plans the
@@ -53,6 +69,22 @@ GitHub Pages has no `_redirects` syntax, so every redirect becomes an HTML stub
 with a meta refresh and a `<link rel="canonical">`. A redirect from `/` is
 skipped because the root cannot be stubbed.
 
+## Deploying the generated files
+
+Run the normal build:
+
+```sh
+npm exec riebeckite build
+```
+
+The files are written into the build output (for example `dist/_redirects`).
+Upload that directory with your provider's deploy step. This plugin stops at
+file generation; it has no credentials and performs no upload.
+
+If your site uses the publication workflow, `publish run --execute` performs
+the configured publication step. `deploy setup` only prepares Cloudflare
+configuration.
+
 ## Public API
 
 - `deploy(options: DeployOptions): RiebeckitePlugin`

package/README_ja.md

@@ -7,6 +7,18 @@ Riebeckite の静的ホスティング向けの出力ヘルパーです。デプ
 
 [English](./README.md)
 
+## できること
+
+- `riebeckite build` の実行中に、プロバイダ固有のリダイレクトファイルとヘッダーファイルを生成します。
+- リダイレクトは `manifest.publicRedirects` からのみ読み取ります。
+- Cloudflare Pages、Cloudflare Workers、Netlify、Vercel、GitHub Pages に対応します。
+
+## できないこと
+
+- ファイルのアップロード、プロバイダ認証、キャッシュ無効化は行いません。
+- サイトをデプロイしません。ビルド出力をプロバイダの通常のデプロイ手順でアップロードするか、設定済みなら公開ワークフローの `publish run --execute` を使ってください。
+- `riebeckite deploy setup` は Cloudflare の設定を準備する別の CLI ヘルパーです。これもアップロードは行いません。
+
 ## 概要
 
 `deploy()` はコンテンツマニフェストの公開リダイレクトを読み、
@@ -52,6 +64,18 @@ GitHub Pages には `_redirects` 構文がないため、各リダイレクト
 `<link rel="canonical">` を持つ HTML スタブになります。`/` からのリダイレクトは
 ルートをスタブ化できないためスキップします。
 
+## 生成したファイルのデプロイ
+
+通常どおりビルドします。
+
+```sh
+npm exec riebeckite build
+```
+
+ファイルはビルド出力（たとえば `dist/_redirects`）へ書き込まれます。そのディレクトリをプロバイダのデプロイ手順でアップロードしてください。このプラグインはファイル生成までを担当し、認証情報を持たず、アップロードも行いません。
+
+サイトが公開ワークフローを使っている場合、`publish run --execute` が設定済みの公開処理を実行します。`deploy setup` は Cloudflare の設定を準備するだけです。
+
 ## 公開 API
 
 - `deploy(options: DeployOptions): RiebeckitePlugin`

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@riebeckite/plugin-deploy",
-  "version": "0.0.34",
+  "version": "0.0.36",
   "license": "Apache-2.0",
   "type": "module",
   "main": "./dist/index.js",
@@ -14,7 +14,7 @@
     }
   },
   "dependencies": {
-    "@riebeckite/core": "0.0.34"
+    "@riebeckite/core": "0.0.36"
   },
   "devDependencies": {
     "tsx": "^4.22.4"