Navigation Menu

Skip to content

kawamataryo/lapras-card-readme

Use this GitHub action with your project
Add this Action to an existing workflow or create a new one
View on Marketplace

Repository files navigation

LAPRAS Card Readme

GitHub ProfileにLAPRAS の現在のスコアをカード画像として埋め込むGitHub Actionsです。

🛠️ 使い方

LAPRASポートフォリオの公開

このGitHub ActionsではLAPRASの公開ポートフォリオAPIを叩き、最新のスコアを取得しています。 事前にポートフォリオの公開設定をします。

GitHub Profileの設定

GitHub Profileリポジトリ README.md 内のカードを挿入したい位置に以下のコメントを追加します。

<!--START_SECTION:lapras-card-->
<!--END_SECTION:lapras-card-->

そして、.github/workflows/ に、以下 lapras-card.yml を追加し、GitHub Actionsを設定します。 SHARE_IDには、自分の公開プロフィールのIDを入力します(https://lapras.com/public/<:share_id>)。

name: LAPRAS Card

on:
  workflow_dispatch:
  schedule:
    - cron: "0 0 * * *"

jobs:
  update-card:
    name: LAPRAS Card
    runs-on: ubuntu-latest
    steps:
      - uses: kawamataryo/lapras-card-readme@main
        with:
          SHARE_ID: "<公開ポートフォリオのID>"
          # 以下オプション
          # https://lapras-card-generator.vercel.app でカスタマイズしたデザインを設定可能
          # ICON_FIRST: "#030E21"
          # ICON_SECOND: "#1688BF"
          # BACKGROUND_FIRST: "#020E27"
          # BACKGROUND_SECOND: "#0E5593"
          # LANG: "ja"
          # CARD_WIDTH: "400"
          # UPDATE_TIME: "true"
          # README_FILE: "README.md"
          # IS_CENTER: "true"
          # ALTERNATIVE_TEXT: "Score of {SHARE_ID} on LAPRAS"

初回はGitHub Actionsの ⚠手動実行⚠️ で画像を追加してください。以降は毎日12:00(UTC)に更新されます。

CleanShot 2022-12-12 at 19 51 47

🎨 オプション

カードのデザインはさまざまな調整が可能です。

property default description
ICON_FIRST #030E21 LAPRASアイコンのグラデーションの start color
ICON_SECOND #1688BF LAPRASアイコンのグラデーションの end color
BACKGROUND_FIRST #020E27 カード背景のグラデーションの start color
BACKGROUND_END #0E5593 カード背景のグラデーションの end color
LANG ja スコアの表記方法(ja or en
CARD_WIDTH 400 出力する画像のwidth
UPDATE_TIME true スコアの更新日時の表示有無
IS_CENTER true カード画像を中央揃えするかどうか
ALTERNATIVE_TEXT ${shareId}のLAPRASでのスコアは次の通りです: エンジニアリング: ${score.eScore} / 5.0, ビジネス: ${score.bScore} / 5.0, インフルエンス: ${score.iScore} / 5.0。 カード画像の代替テキスト、スクリーンリーダーでの利便性向上に関係

lapras-card-generator を使うことで生成画像のPreviewや、環境変数の出力も可能です。

Exportボタンの GitHub Actions params で、環境変数をコピーできます。

CleanShot 2022-12-17 at 21 41 44