Hacktoberfest 2026:メンテナが10月に向けて印を付けた、オープンで初心者向けの issue。 Hacktoberfest の issue を見る

Documentation Update for First Run ➔ gh-cache Branch, cache_key File, and JSON Escaping Guidance

オープン
#37 コメント 4 件 リアクション 0 件 担当者 0 名 GitHub で見る

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

評価

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

調査の方向性

まず action.yml と workflow の cache_key の設定を確認し、次に初回実行の要件がどこに記載されているかを特定してください。gh-cache ブランチと対応するキャッシュファイルの作成を文書化し、レポート出力が HTML の引用符を処理しても workflow がコード 2 で終了しないことを確認してください。

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

説明

awaiting-reporter

Great tool! It works for me now. However, I ran into a few undocumented setup issues during the first run that caused the workflow to exit with code 2.

1️⃣ Missing gh-cache branch

The first run failed with:

Branch gh-cache does not exist

Creating a branch named gh-cache resolved this.

2️⃣ Missing cache file matching cache_key

Next error on report:

cache-key-value not found in cache

Creating and pushing an empty file onto the gh-cache branch whose name matches the cache_key value in the workflow YAML fixed this issue.

3️⃣ JSON escaping issue in action.yml file in codebase:

Final error in report:

The line echo "issues=$issues" >> "$GITHUB_OUTPUT" fails whenever HTML contains quotations. This likely happens due to the line trying to echo out unescaped quotes.

Proposed fix:

issues_escaped=$(echo "$issues" | jq -c . | sed 's/%/%25/g; s/\r/%0D/g; s/\n/%0A/g')
echo "issues=$issues_escaped" >> "$GITHUB_OUTPUT"
主要言語
TypeScript
スター
374
フォーク
42
平均マージ
1日 13時間
マージ済み PR(30日)
7

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

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

github/accessibility-scanner のほかの issue

github/accessibility-scanner の issue をすべて見る

似ている issue

TypeScript の issue をもっと見る

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

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