[workshop-sync] workshop/18-share-and-reuse.md: `gh aw add` shorthand lookup location unclear

クローズ 初心者向け
#5,269 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

まだ誰も着手していません。

評価

難易度
2/5
見積もり時間
1〜3時間
初心者へのやさしさ
62/100
issue の種類
ドキュメント
明瞭さ
おおむね明確
活発さ
活発
技術スタック
github, github-actions, markdown
領域
documentation

調査の方向性

その記述は workshop/18-share-and-reuse.md の20行目にあり、76行目の例では3部構成の gh aw add 形式を使っています。gh aw add --help を実行し、編集する前に .github/workflows/ が省略形の場所として解決されるかを確認してください。ページに、省略形が実際に検索するディレクトリが記載されているか、.github/workflows/ のファイルに対する明示的な4部構成のパスまたは blob URL が示されていれば完了です。

索引モデルが issue の本文から書いたものです。

説明

documentation

Workshop file reviewed

workshop/18-share-and-reuse.md

Problem

Line 20 says:

Any .md file in a .github/workflows/ folder of a repository you have read access to can act as a template

and line 76 shows gh aw add jsmith/my-workshop/daily-status.

The live gh aw add help (gh-aw v1.0.1) says the three-part form is owner/repo/workflow-name[@version] and "implicitly looks in workflows/ directory". It doesn't mention .github/workflows/ as the shorthand lookup location, so the page's claim is not supported by the CLI help.

Suggested fix

Clarify where the shorthand resolves. Either say the template should live in workflows/ for the shorthand to work, or show the explicit four-part form (owner/repo/workflows/workflow-name.md[@version]) or a full GitHub blob URL for files in .github/workflows/. Verify the actual behavior with gh aw add --help and a test before editing.

Files 19 (19-research-driven-training-node.md) and 20 (20-persistent-memory.md) were also reviewed with no issues found. Two external links (reusing-workflows, compilation-process) could not be checked against the doc URL map.

Generated by 🔍 Workshop Sync Check · copilot · auto · ~54 AIC · ⌖ ~1 AIC · ⊞ 4.7K · ◷

  • expires on Nov 3, 2026, 11:28 AM UTC
主要言語
JavaScript
スター
56
フォーク
40
平均マージ
2日 14時間
マージ済み PR(30日)
13

環境構築

Codespaces で開く

このプロジェクトの開発コンテナを、あなたの GitHub アカウントでブラウザ上に起動します。

  • Dockerfile・Docker Compose ファイルなし
  • プルリクエストのテンプレートなし
  • コントリビューションガイドなし

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

githubnext/gh-aw-workshop のほかの issue

githubnext/gh-aw-workshop の issue をすべて見る

似ている issue

JavaScript の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。