Skip to content

Commit c48694a

Browse files
takemi-ohamaclaude
andcommitted
docs(install): 配信パスを /i に短縮 (/install.sh はエイリアス) (PLAN31_1)
- pages.yml: install.sh を _site/i (正規) と _site/install.sh (後方互換 エイリアス) の両方へ配信 - 導入 URL を https://dl.basex.jp/i に更新 (README/getting-started/ CHANGELOG/install.sh ヘッダ/installer-hosting.md/index.html) - 配信仕様にパス方針とエイリアスを追記 - .gitignore に .env.bak を追加 (シークレット混入防止) Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
1 parent 3ac3b93 commit c48694a

7 files changed

Lines changed: 21 additions & 16 deletions

File tree

.github/workflows/pages.yml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,8 @@ jobs:
3737
- name: Assemble site (install.sh only)
3838
run: |
3939
mkdir -p _site
40-
cp install.sh _site/install.sh
40+
cp install.sh _site/i # 正規の短縮パス (https://dl.basex.jp/i)
41+
cp install.sh _site/install.sh # 後方互換エイリアス
4142
echo 'dl.basex.jp' > _site/CNAME
4243
cat > _site/index.html <<'HTML'
4344
<!doctype html>
@@ -46,7 +47,7 @@ jobs:
4647
<body style="font-family:system-ui;max-width:42rem;margin:3rem auto;padding:0 1rem">
4748
<h1>devbase installer</h1>
4849
<p>ワンライナーインストール:</p>
49-
<pre><code>curl -fsSL https://dl.basex.jp/install.sh | bash</code></pre>
50+
<pre><code>curl -fsSL https://dl.basex.jp/i | bash</code></pre>
5051
<p>ソース: <a href="https://github.com/devbasex/devbase">github.com/devbasex/devbase</a></p>
5152
</body>
5253
</html>

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
__pycache__/
22
.venv/
33
.env
4+
.env.bak
45
.env.backup
56
.gemini/
67
.docker-compose.scale.yml

CHANGELOG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
### Added
88
- **ワンライナー installer (`install.sh`) を新設**しました (PLAN31_1)。
9-
`curl -fsSL https://dl.basex.jp/install.sh | bash`
9+
`curl -fsSL https://dl.basex.jp/i | bash`
1010
`~/devbase` への clone(既存なら `git pull --ff-only`)と `devbase init` まで
1111
自動完了します(uv の自動導入・PATH/補完の登録・`plugins.yml` 生成を含む)。
1212
- 配置先 / clone 元 / ref を `DEVBASE_INSTALL_DIR` / `DEVBASE_INSTALL_REPO` /

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ devbaseは、Docker Composeを使った再現性の高い開発環境を提供
2323
### ワンライナーインストール(推奨)
2424

2525
```bash
26-
curl -fsSL https://dl.basex.jp/install.sh | bash
26+
curl -fsSL https://dl.basex.jp/i | bash
2727
```
2828

2929
`~/devbase` に clone(既存なら更新)し、`devbase init` まで自動実行します(uv の自動導入・PATH/補完の登録・`plugins.yml` 生成を含む)。**新しく開くターミナルでは自動で有効**です。
@@ -41,13 +41,13 @@ curl -fsSL https://dl.basex.jp/install.sh | bash
4141
```bash
4242
# 例: 別ディレクトリへ特定タグを入れる(パイプではなく保存実行でも env は同様に効きます)
4343
DEVBASE_INSTALL_DIR=~/work/devbase DEVBASE_INSTALL_REF=v1.2.3 \
44-
bash -c "$(curl -fsSL https://dl.basex.jp/install.sh)"
44+
bash -c "$(curl -fsSL https://dl.basex.jp/i)"
4545
```
4646

4747
> **`curl | bash` を実行する前に**: 中身を確認したい場合は、いったん保存してから実行してください。
4848
>
4949
> ```bash
50-
> curl -fsSL https://dl.basex.jp/install.sh -o install.sh
50+
> curl -fsSL https://dl.basex.jp/i -o install.sh
5151
> less install.sh # 内容を確認
5252
> bash install.sh
5353
> ```

docs/developer/installer-hosting.md

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,8 @@
99
- `curl -fsSL <URL> | bash` で実行する静的ファイル `install.sh` を、安定した
1010
短い HTTPS URL で配信する。
1111
- 配信 URL を `https://raw.githubusercontent.com/devbasex/devbase/main/install.sh`
12-
(約 73 文字)から `https://dl.basex.jp/install.sh`(約 33 文字)へ短縮する。
12+
(約 73 文字)から `https://dl.basex.jp/i`(約 21 文字)へ短縮する。
13+
後方互換のため `https://dl.basex.jp/install.sh` も同一内容のエイリアスとして配信する。
1314
- スコープ外: installer 自体の挙動(`issues/PLAN31_1_devbase-installer.md` 参照)。
1415

1516
## 2. 決定事項
@@ -18,7 +19,7 @@
1819
|---|---|
1920
| ホスティング | **GitHub Pages**(devbasex/devbase リポジトリ) |
2021
| カスタムドメイン | **`dl.basex.jp`** |
21-
| 配信 URL | **`https://dl.basex.jp/install.sh`** |
22+
| 配信 URL | **`https://dl.basex.jp/i`** |
2223
| ドメインレジストラ | お名前.com(basex.jp) |
2324
| DNS | お名前.com DNS(`01〜04.dnsv.jp`)に `dl` の CNAME |
2425
| 月額コスト | **$0**(GitHub Pages 無料枠) |
@@ -39,7 +40,7 @@ installer 程度のトラフィックでは GitHub Pages の無料枠で十分
3940

4041
```mermaid
4142
flowchart LR
42-
U["ユーザー<br/>curl -fsSL https://dl.basex.jp/install.sh | bash"]
43+
U["ユーザー<br/>curl -fsSL https://dl.basex.jp/i | bash"]
4344
R[".jp レジストリ"]
4445
O["お名前.com DNS<br/>01〜04.dnsv.jp"]
4546
GP["GitHub Pages<br/>185.199.108-111.153"]
@@ -78,6 +79,8 @@ flowchart LR
7879
正本(single source of truth)であり、Pages 用に複製しない。
7980
- 成果物に `CNAME`(内容 `dl.basex.jp`)を含め、custom domain を固定する。
8081
- ルート(`/`)には簡単な案内 HTML を置く(任意)。
82+
- 配信パスは `/i` を正規とし、後方互換のため `/install.sh` も同一内容で配信する
83+
(ワークフローで `install.sh``_site/i``_site/install.sh` の両方へコピー)。
8184

8285
### 5.2 配信ワークフロー(`.github/workflows/pages.yml`
8386

@@ -87,7 +90,7 @@ flowchart TD
8790
B --> C["_site/ 組み立て<br/>install.sh / CNAME / index.html"]
8891
C --> D["upload-pages-artifact"]
8992
D --> E["deploy-pages"]
90-
E --> F["https://dl.basex.jp/install.sh 更新"]
93+
E --> F["https://dl.basex.jp/i 更新"]
9194
```
9295

9396
要点:
@@ -143,10 +146,10 @@ curl -fsS 'https://dns.google/resolve?name=dl.basex.jp&type=CNAME'
143146

144147
# 配信: install.sh が 200 で取得でき、HTTPS 証明書が一致するか
145148
curl -fsSL -o /dev/null -w 'HTTP %{http_code} ssl_verify=%{ssl_verify_result}\n' \
146-
https://dl.basex.jp/install.sh
149+
https://dl.basex.jp/i
147150

148151
# 中身の先頭確認
149-
curl -fsSL https://dl.basex.jp/install.sh | head -20
152+
curl -fsSL https://dl.basex.jp/i | head -20
150153
```
151154

152155
- DNS 成功時は `Status:0``data``devbasex.github.io.`
@@ -172,7 +175,7 @@ curl -fsSL https://dl.basex.jp/install.sh | head -20
172175

173176
- DNS(`dl.basex.jp` CNAME): **完了**(GitHub Pages IP に解決・確認済み)。
174177
- GitHub Pages 有効化 / custom domain / Enforce HTTPS: **完了**
175-
`https://dl.basex.jp/install.sh` が HTTP 200・証明書一致・`http→https` 301 を確認済み。
178+
`https://dl.basex.jp/i` が HTTP 200・証明書一致・`http→https` 301 を確認済み。
176179
- URL 更新(README / docs / install.sh): **完了**#49)。配信内容の sha256 が
177180
`main:install.sh` と一致することを確認済み。
178181
- ドメイン検証 TXT(§4・乗っ取り防止): ****(推奨)。GitHub の Verify domains で

docs/user/getting-started.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ devbase を利用するには、以下のソフトウェアがホストマシン
2222
手順 1〜2(クローンと初期化)を 1 コマンドで自動化できます。`git``curl` があれば実行できます。
2323

2424
```bash
25-
curl -fsSL https://dl.basex.jp/install.sh | bash
25+
curl -fsSL https://dl.basex.jp/i | bash
2626
```
2727

2828
このコマンドは次を行います。
@@ -48,7 +48,7 @@ curl -fsSL https://dl.basex.jp/install.sh | bash
4848
> **`curl | bash` を実行する前に**: 信頼できないスクリプトをそのままパイプ実行するのが不安な場合は、保存して内容を確認してから実行してください。
4949
>
5050
> ```bash
51-
> curl -fsSL https://dl.basex.jp/install.sh -o install.sh
51+
> curl -fsSL https://dl.basex.jp/i -o install.sh
5252
> less install.sh # 内容を確認
5353
> bash install.sh
5454
> ```

install.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
#
33
# devbase ワンライナー installer (PLAN31_1)
44
#
5-
# curl -fsSL https://dl.basex.jp/install.sh | bash
5+
# curl -fsSL https://dl.basex.jp/i | bash
66
#
77
# clone (または pull) して `bin/devbase init` を 1 回呼ぶだけの薄い導入スクリプト。
88
# uv の自動導入・rc 追記・補完登録・plugins.yml 生成・冪等性・旧版移行はすべて

0 commit comments

Comments
 (0)