Skip to content

📝 手順書が警告どおりの事故を起こしうる形だったのを直す - #1903

Merged
yasulab merged 1 commit into
mainfrom
fix-doc-guard-and-typos
Aug 31, 2026
Merged

yasulab merged 1 commit into
mainfrom
fix-doc-guard-and-typos

Conversation

@yasulab

@yasulab yasulab commented Aug 31, 2026

Copy link
Copy Markdown
Member

昨夜の #1901 / #1902 を通しで見直したところ、手順書自身が禁じている操作を実行できる形になっていました。

コードブロックを丸ごと貼ると、警告した事故が起きます

「coderdojo.jp に出る前に DojoMap を起動すると、ジョブは成功するのに地図に出ない」と警告しておきながら、その下の 3 ステップは独立したコマンドの並びでした。

丸ごと貼り付けると、1 段目が時間切れで終わっても 2 段目の gh workflow run がそのまま走ります。

前の段階が成功しなければ次に進まない形に直しました。

DOJO=鞍手   # 掲載した Dojo 名に書き換える

# 出るまで待つ(見つかれば 0、時間切れなら 1 を返す)
wait_until() {   # $1: URL  $2: 探す文字列  $3: 待機秒(最大 20 回)
  for _ in $(seq 20); do
    curl -s "$1" | grep -qF "$2" && return 0
    sleep "$3"
  done
  return 1
}

wait_until https://coderdojo.jp/dojos.json  "\"name\":\"$DOJO\""        15 \
  && gh workflow run scheduler_daily.yml --repo coderdojo-japan/map.coderdojo.jp --ref main \
  && wait_until https://map.coderdojo.jp/dojos.json "\"name_japan\":\"$DOJO\"" 20 \
  && echo "地図に出ました" \
  || echo "途中で止まりました。下の切り分けを見てください"

未掲載の名前でワークフローが起動しないことを、実際に動かして確認しています。

$ # 掲載済み(鞍手)
OK: 地図に出ました
$ # 未掲載の名前に差し替えて実行
NG: 途中で止まりました      # ← gh workflow run は実行されない

ブラウザから実行する場合も、先に coderdojo.jp 側を目視で確認するよう補いました。

同じ確認を 2 度説明していました

3 段目で 鞍手 を使って地図を確認した直後に、南城 を使って同じ確認を説明していました。別々の Dojo 名で同じことを 2 回説明する形です。

後者は「どのクラブと突合したか」を見る別の用途なので、そう書き分け、例の Dojo 名も節内で統一しました(実データで出力例を取り直しています)。

既存の誤字

-| `counter` | 省略化。[連名道場]...
+| `counter` | 省略可。[連名道場]...

2 箇所ありました。

手順一覧の係り先

-9. 本番環境への反映を確認し、下記「DojoMap への反映」で地図も先に更新する
+9. 本番環境への反映を確認し、メールを送る前に下記「DojoMap への反映」で地図も更新する

「先に」だけでは何より先か読み取れないため補いました。

検証

  • 手順書内の bash ブロック 6 件を抽出し、bash -n で構文を確認
  • ガードが効くことを実行して確認(上記)
  • アンカーリンク 4 件・URL 8 件・GitHub blob リンク 4 件が生きていることを確認

関連: map#45(地図側のドキュメントの取り残しを修正)

見直しで、手順書自身が禁じている操作を実行できる形になっていた。

## コードブロックを丸ごと貼ると、警告した事故が起きる

「coderdojo.jp に出る前に DojoMap を起動すると、ジョブは成功するのに地図に
出ない」と警告しながら、その下の 3 ステップは独立したコマンドの並びだった。
丸ごと貼り付けると、1 段目が時間切れで終わっても 2 段目の gh workflow run が
そのまま走る。

前の段階が成功しなければ次に進まないよう && でつないだ。未掲載の名前で
ワークフローが起動しないことを実際に確認している。

## 同じ確認を 2 度説明していた

3 段目で鞍手を使って地図を確認した直後に、南城を使って同じ確認を説明して
いた。後者は「どのクラブと突合したか」を見る別の用途なので、そう書き分け、
例の Dojo 名も節内で統一した。

## 既存の誤字

「省略化」を「省略可」に直した (2 箇所)。

## 手順一覧の係り先

「地図も先に更新する」だけでは何より先か読み取れないため、
「メールを送る前に」を補った。
@yasulab
yasulab force-pushed the fix-doc-guard-and-typos branch from e6e8c47 to 9da60c3 Compare August 31, 2026 09:00
@yasulab
yasulab merged commit 910df46 into main Aug 31, 2026
5 checks passed
@yasulab
yasulab deleted the fix-doc-guard-and-typos branch August 31, 2026 09:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant