☘️ GitHub プロフィールで草を生やす

Susan Sarandon

リリース： 2024-11-21 08:31:11

オリジナル

907 人が閲覧しました

GitHub Contributions から 3D 草画像を生成する CGrass を紹介したいと思います。生成されたイメージを Github プロファイルに配置できます。 CGrass は Github アクションで実行されるため、ワークフローを追加して README を少し書き直すだけで済みます。

↓このプロジェクトのリポジトリは以下のリンクからご覧いただけます

ヌリスク / 草

3Dグラスへの貢献

英語 | 日本語

☘️ Growing grass on Your GitHub Profile

このプロジェクトが気に入ったら、スターを付けてください ⭐️

Cグラス

CGrass は、GitHub Actions と統合できる GitHub コントリビューション画像ジェネレーターです。 GitHub への投稿の 3D 画像を生成し、プロフィールの README に設定できます。

はじめに

GitHub アクション

次のコードをプロファイルリポジトリの .github/workflows/cgrass.yml ファイルにコピーします。

name: Generate Picture and Push to output branch
on:
    push:
        branches:
            - main
    schedule:
        - cron: <span>'0 0 * * *'</span> <span># any time you want</span>
    
permissions:
    contents: write

jobs:
    generate:
        runs-on: ubuntu-24.04

        steps:
          - name: Checkout
            uses: actions/checkout@v4

          - name: Generate Picture
            uses: nrysk/cgrass@v1.0.0
            with:
                github_username: ${{ github.repository_owner }}
                github_token: ${{ secrets.GITHUB_TOKEN }}
                output_path: output/output.png
                command: <span>"theme"</span>
                argument: <span>"github</span>

ログイン後にコピー

…

GitHub で表示

CGrass の使用方法

1.プロフィールページを作成する

GitHub ユーザー名と同じ名前でリポジトリを作成します。
GitHub ユーザー名が nrysk の場合は、nrysk という名前のリポジトリを作成します。

2. ワークフローを設定する

.github/workflows/cgrass.yml という名前のファイルを作成します。

name: Generate Picture and Push to output branch
on:
    push:
        branches:
            - main
    schedule:
        - cron: <span>'0 0 * * *'</span> <span># any time you want</span>
    
permissions:
    contents: write

jobs:
    generate:
        runs-on: ubuntu-24.04

        steps:
          - name: Checkout
            uses: actions/checkout@v4

          - name: Generate Picture
            uses: nrysk/cgrass@v1.0.0
            with:
                github_username: ${{ github.repository_owner }}
                github_token: ${{ secrets.GITHUB_TOKEN }}
                output_path: output/output.png
                command: <span>"theme"</span>
                argument: <span>"github</span>

ログイン後にコピー

プッシュ (または GitHub でコミット) すると、GitHub アクションが実行されます。アクションが完了すると、生成されたイメージが出力ブランチに保存されます。
セグメンテーション違反が発生した場合は、再実行してください。

3. テーマを変更する

引数フィールドの文字列を変更することでテーマを切り替えることができます。
github、github-nograss、planet、planet-nograssの4つのテーマを用意しました。

name: Generate Picture and Push to output branch

on:
    push:
        branches:
            - main
    schedule:
        - cron: '0 0 * * *' # Adjust the time as desired

permissions:
    contents: write

jobs:
    generate:
        runs-on: ubuntu-24.04

        steps:
          - name: Checkout
            uses: actions/checkout@v4

          - name: Generate Picture
            uses: nrysk/cgrass@v1.0.0
            with:
                github_username: ${{ github.repository_owner }}
                github_token: ${{ secrets.GITHUB_TOKEN }}
                output_path: output/output.png
                command: "theme"
                argument: "github"

          - name: Push output image to output branch
            uses: crazy-max/ghaction-github-pages@v4
            with:
                target_branch: output
                build_dir: output
                commit_message: "Generate Output Image"
            env:
                GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

ログイン後にコピー

ギットハブ

☘️ Growing grass on Your GitHub Profile

github-nograss

☘️ Growing grass on Your GitHub Profile

惑星

☘️ Growing grass on Your GitHub Profile

プラネット・ノーグラス

☘️ Growing grass on Your GitHub Profile

4. プロフィールに画像を追加する

プロフィールの README.md に画像を表示するには、次の行を追加し、を置き換えます。 GitHub ユーザー名を使用します。

  - name: Generate Picture
    uses: nrysk/cgrass@v1.0.0
    with:
        github_username: ${{ github.repository_owner }}
        github_token: ${{ secrets.GITHUB_TOKEN }}
        output_path: output/output.png
        command: "theme"
        argument: "github" # Change this part

ログイン後にコピー