anuraghazra/github-readme-stats：README に基づく導入ガイド

anuraghazra/github-readme-stats の README はプロジェクトを「:zap: Dynamically generated stats for your github readmes」と説明しています。ここではリポジトリで確認できる事実だけを整理します。star 数やバッジは注目度の手掛かりであり、品質の証明ではありません。「README」には次の説明があります。> [!CAUTION] > This repository is no longer maintained. Please use the successor project GitHub Stats Extended.。これは範囲の説明であり、本番検証の結果ではありません。

README の「README」にある内容から、用途が合うかを先に判断できます。:film\projector: Check Out Step By Step Video Tutorial By @codeSTACKr。目的が違うなら、人気だけで採用する理由にはなりません。プロジェクト名やコマンドは原文のまま残し、一次資料へ戻って用語を確認できるようにしています。 README には次の確認可能な項目もあります。First step: get your Personal Access Token (PAT)。初回テストの材料にはなりますが、実際の環境での確認を省略する理由にはなりません。

動作の説明は「Important Notices」など複数の箇所に分かれています。確認できる情報は次の通りです。We're a small team, and to prioritize, we rely on upvotes :+1:. We use the Top Issues dashboard for tracking community demand (see #1935. Do not hesitate to upvote the issues and pull requests you are interested in.。書かれていない構成、性能、セキュリティを推測で補いません。導入時はディレクトリ、設定ファイル、release 履歴を確認してください。

初回導入は README の入口から始めます。確認できるコマンドは次の通りです。 name: Update README cards on: schedule: - cron: "0 3 * * *" workflow_dispatch: jobs: build: runs-on: ubuntu-latest steps: - uses: actions/checkout@v4 - name: Generate stats card uses: readme-tools/github-readme-stats-action@v1 with: card: stats options: username=${{ github.repository_owner }}&show_icons=true path: profile/stats.svg token: ${{ secrets.GITHUB_TOKEN }} - name: Commit cards run: | 実行可能なコマンドがない場合は手順を作らず、「GitHub Stats Card」で依存関係、待受ポート、初回設定を確認します。

日常運用は公式文書の範囲に限ります。「GitHub Stats Card」にはCopy and paste this into your markdown, and that's it. Simple!とあります。設定、環境変数、権限、データ保存先は明記されたものだけを扱います。未記載の既定値は隔離環境で確認し、戻せる設定を保存してください。 同じ資料には&sizeweight=1&countweight=0 - (default) Orders by byte count.ともあります。