Skip to content

Latest commit

 

History

History
85 lines (72 loc) · 4.02 KB

File metadata and controls

85 lines (72 loc) · 4.02 KB

Github-profilemd-Generater

情報

Github-profilemd-GenerateGithub Actionで実行されツールです。
Githubユーザーの情報をカウントし、自己紹介用のカードを生成します。


特徴

  • Overview - 概要統計(Stars / Repos / Followers / Commits / PR / Issue)
  • リポジトリ構成 - 言語統計(実際のコードのバイト数に基づく)
  • タグ設定 - トピック / タグの傾向
  • テーマ、表示数(TOP_N)、除外言語(HIDE)、出力先(OUTPUT_DIR)を設定可能

動作原理?

Github GraphQL から情報を取得→ SVGファイルを生成→ ツールが倉庫の "release" (デフォルト)ブランチにコミットします。GitHub Actions の node24 ランタイムで実行されます。


使用法

このツールを使用する前に Github Hidden Secrets を発見するこどをお確認でください,
(たとえば:kwangsing3/kwangsing3)

Github Action:

  1. Github GraphQLを使用するため、データの取得と使用するトークンが必要です。プロファイルを作成するためのキーの追加方法をクリックし,トークンを追加して情報を取得する方法を学習します。

2.自己申告ウェアハウスのシークレットにトークンを追加し、「MY_GITHUB_TOKEN」という名前を付けます。 (詳細な手順リポジトリに秘密を追加を表示)。

3.次のを .yml ファイルに挿入します。

permissions:
  contents: write          # bot がカードをリポジトリにコミットできるようにする

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: kwangsing3/github-profilemd-Generater@release
        env:
          GITHUB_TOKEN: ${{ secrets.MY_GITHUB_TOKEN }}
        with:
          USERNAME: ${{ github.repository_owner }}
          GITHUB_REPO_NAME: ${{ github.event.repository.name }}
          # 以下は任意
          THEME: 'all'        # またはカンマ区切り(例: "nord_dark,dracula")
          TOP_N: '8'          # カードごとの言語 / タグ数
          HIDE: ''            # 除外する言語(例: "HTML,CSS")
          OUTPUT_DIR: 'output'

🔒 本番環境では @release を commit SHA に固定し、ワークフローに必要な permissions のみを付与してください。

ローカル実行:

依存関係をインストールしてバンドルをビルドし、引数を指定して実行します。

npm install
npm run build
node dist/index.js [arg1] [arg2] [arg3]
  • [arg1]: ユーザー名
  • [arg2]: repo name
  • [arg3]: MY_GITHUB_TOKEN

開發

$ git clone https://github.com/kwangsing3/github-profilemd.Generater

その他

   README.MDを一貫性保つため,Github-profilemd-Genearater README.mdを上書きませずん,統計カードの作成それだけ (./output/github-profilemd-generater/)
README.MDが別のアップロードされた画像を使用するのではなく,相対パスを使用してカードを取得していることを確認してください。

*** あなたのサポートを示すために星を残してください,そしてこのツールがいつかあなたを助けることをこのように祈るています ***

ありがたい :)