GitHub Wiki 公開
要求された資料をリポジトリの既存Wikiに公開します。コンテンツ生成と公開は分離してください。提供されたページ、レポート、アセットを使用し、必要に応じてリンクとナビゲーションを適応させます。別のプロジェクトの規則をインポートせず、対象プロジェクトのルールに従ってください。
公開先と範囲を確定する
- リクエストとリポジトリのコンテキストから、GitHubホスト、リポジトリ、Wiki URL、ソースファイル、意図するページ名を解決します。公開内容を実質的に変更する未解決の選択肢についてのみ質問します。
- 準備と公開を区別します。明示的な公開リクエストは、名前付きのWiki更新を許可します。同じアクションについて再度質問しないでください。下書きや評価のみのリクエストは、プッシュを許可しません。
- まず、関連するコネクタの機能を確認します。コネクタがWikiのコンテンツとアセットを適切に管理できない場合は、Wikiの個別のGitリポジトリを使用します。そのフォールバックについて簡単に説明します。通常のリポジトリContents APIはWikiリポジトリを扱いません。
- 既存の認証済み接続またはGit認証情報を使用して、アクセスを確認します。URL、ページ、または保存された証跡に認証情報を埋め込まないでください。認証されていない404レスポンスは、プライベートWikiが存在しないことを証明しません。
- Wiki Gitリポジトリが存在しない場合は、Wikiが無効になっているか、GitHubを通じて最初のページを作成する必要があるかを確認します。副作用としてリポジトリ機能を有効にしたり、アクセスを変更したりしないでください。可能な場合は承認された最初のページ作成を使用します。それ以外の場合は、不足している前提条件を具体的に報告します。
限定された更新を準備する
Git公開の場合は、Git手順を読んでください。新しいスクラッチクローンを使用し、実際のデフォルトブランチを確認し、書き込み前に既存の宛先ページ、Home、サイドバーを読み取ります。
- 各ソースファイルを宛先ページまたはアセットにマッピングします。無関係なページ、手動で作成されたセクション、ナビゲーションは保持します。ソースファイルが存在しないことは削除命令ではありません。要求された更新に属する場合にのみ、ページ全体を置き換えます。共有のHome/サイドバーコンテンツには狭い編集を使用します。既存のリンクを維持し、繰り返し実行時に重複したナビゲーションエントリを作成しないでください。
- テキストは明示的にUTF-8で読み書きします。バイナリアセットはバイト単位でコピーします。ソースの事実を静かに修正したり、異なるデータセットからレポートをリフレッシュしたりしないでください。実際の日付、出典、制限事項を保持します。再生成が対象範囲内の場合にのみ、適切な上流ジェネレータを使用します。
- Wikiの実際の宛先に合わせてリンクを書き換えます。リポジトリ相対リンクは、ページを移動した後に壊れる可能性があります。参照されているアセットをコピーするか、アクセス可能なリポジトリリビジョンにリンクします。ローカルパス、未公開のブランチリンク、アクセスできない外部リソースを残さないでください。
- Wikiはページのファイル名をタイトルとして表示するため、独自のH1で始まるページはタイトルが二重に表示されます。そのH1を削除し、ページにその名前を付けます。H1が意図的にページ名と異なる場合（Homeなど）にのみH1を保持します。ナビゲーションを派生名に更新します。Homeは
/wikiで提供されるため、その相対リンクはWikiの外部で解決されます。画像、ページリンク、サイドバーには絶対Wiki URLを使用してください。 - 意味のある代替テキストを持つサポートされているインライン画像を使用します。HTMLレポートやアニメーション/インタラクティブ図の場合、Wikiがレンダリングできない場合は、有用な静的プレビューと元のアーティファクトへのリンクを提供します。ダウンロード可能なHTMLを、Wiki内で提供されるアプリケーションとして説明しないでください。新しいアートワークの生成が範囲内の場合は、プロジェクト固有の図ツールに従います。このスキルは特定のジェネレータを要求しません。
- ローカルリンクとアセット、代表的な非ASCIIテキスト、および変更された正確なパスをチェックします。最終的な差分を検査して、意図しない削除、上書きされたコンテンツ、認証情報、生成されたゴミがないことを確認します。一時的なクローンとローカル証跡は、ユーザーまたはプロジェクトがそこにソースを保持することを要求しない限り、アプリケーションリポジトリに保持しないでください。
公開して検証する
ユーザーの既存の認可内でのみ公開を適用します。Wikiの更新は、アプリケーションブランチのプッシュ、Issueの変更、サイトのデプロイ、同期のスケジュール設定、CIのインストールを許可しません。
- 意図したWikiパスのみをコミットし、Git手順に従って同時変更をフェッチして調整します。Wikiの検出されたデフォルトブランチに通常どおりプッシュします。別のライターを克服するためにフォースプッシュしないでください。
- リジェクトされた場合は、一度フェッチして検査します。互換性のある編集を統合し、完全な差分を再チェックします。同じ競合が再発する場合、意図を解決できない場合、またはアクセスが失敗した場合は、リトライを停止し、正確なブロッカーとともに回復可能なクローンを保持します。失敗時に削除しないでください。
- 公開されたコミットをライブリモートに対して検証します。クリーンなワーキングツリーだけでは、ローカルコミットがプッシュされたことが証明されません。
- 利用可能な場合は、認証されたブラウザを通じて実際に提供されたページを検査します：ページテキスト、代表的なUnicode、ナビゲーション、リンク、画像の読み込みと可読性。チャートの場合、レンダリングされた結果をソースの事実と比較します。インラインプレビューでラベルが不明瞭な場合は、フルサイズの画像をチェックします。範囲内で観察された欠陥を修正し、影響を受けるコンテンツを再確認します。
- 認証されたレンダリング検証が利用できない場合は、公開とリモート検証を、未実行のブラウザチェックとは別に報告します。ローカルファイル、HTTP応答、または成功したプッシュからのレンダリングパスを主張しないでください。
ページURL、公開リビジョン、重要な変更、実行されたチェック、および未解決の制限事項を報告します。作業が未公開のままの場合は、回復パスを保持します。新しい承認ゲート、コンテンツスキーマ、プロジェクトライフサイクル、またはテスト体制を追加しないでください。