📖

GitHubのプロフィールをカッコよくする方法② GitHub Profile Summary Cards編

に公開
readme
tech

はじめに

GitHub Readme Stats, Github Profile Trophy編の続きです。
前提として、その１が終わっている。もしくはREADMEを作っているところから始めます。
まだREADMEを作成されていない方は、その1をご覧ください。

ゴール

今回はこの部分を作っていこうと思います。

今回使うライブラリ

GitHub Profile Summary Cards

https://github.com/vn7n24fzkq/github-profile-summary-cards/wiki/Toturial#add-personal-access-token-to-repo

早速やってみる

  1. 今回はGitHubのActionsを利用します。
    GitHubActionsが分からない方はこちらの公式をご覧ください。
    https://github.co.jp/features/actions
    簡単に言うと、ワークフローを設定出来て、CICDを自動化出来たりするものです。

  2. まず最初に必要なアクセス許可を持つパーソナルアクセストークンを作成します。

  3. GitHubの自分のアイコンをタップします。

  4. その中の「Settings」をタップします。

  5. プロフィールの設定画面に遷移します。

  6. そこで、「Developer settings」をタップします。

  7. 次の画面で「Personal access tokens」を選択します。

  8. すると、右側にボタンが出てきますので、「Generate new token」をタップします。

  9. tokenの作成画面に遷移します。
    ここで、Noteに何の為のtokenかと、必要な権限を選択します。

10.　一番下に「Generate token」ボタンがあるので、ここをタップすると、tokenが出来ます。

  1. tokenが出来ました。このパスワードは必ずコピーしておいてください。後で利用します。
    このパスワードは閉じてしまうと二度とみることはできないのでご注意ください。
  2. 続いてワークフローを設定するファイルを作成していきます。
  3. 自分のREADMEがあるディレクトリに移動して、「Add file」をタップします。
  4. するとファイルが作成されます。
  5. 「Nmae your file」の箇所に
.github/workflows/profile-summary-cards.yml

と入力します。
16. こうなります。

17.　続いて中身を記載していきます。
こちらを貼り付けください。

name: GitHub-Profile-Summary-Cards

on:
  schedule: # execute every 24 hours
    - cron: "* */24 * * *"
  workflow_dispatch:

jobs:
  build:
    runs-on: ubuntu-latest
    name: generate

    steps:
      - uses: actions/checkout@v2
      - uses: vn7n24fzkq/github-profile-summary-cards@release
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        with:
          USERNAME: ${{ github.repository_owner }}

18.　こうなります。

19.貼り付け出来たら、下の「Commit new file」のボタンを押してください。するとファイルが作成されます。

  1. 次に、${{ secrets.GITHUB_TOKEN }}のGITHUB_TOKENの部分に自分のSecretを入力する必要がありますので、Secretにtokenを設定します。

  2. 「Settings」ボタンをタップしてください。

  3. 次の画面で「Sectet」を選択します。

  4. Secretの作成画面に遷移しますので、「New repository secret」のボタンをタップします。

  5. Secretの入力画面にSecretの名前とtokenのパスワードを入力します。(先ほどコピーしたものです。)入力出来たら、「Add secret」ボタンをタップします。

  6. Secretができます。このSecretの名前をコピーします。

  7. Secretの名前を先ほどのファイルの、${{ secrets.GITHUB_TOKEN }}のGITHUB_TOKENの部分に入力します。

  8. こうなります。

  9. これで入力完了したので、次にActionsを動かします。上のタブの「Actions」を選択してください。

  10. Actionsの画面に遷移します。「GitHub-Profile-Summary-Cards」を選択します。

  11. 次に、ワークフローを動かします。右の「Run workflow」ボタンをタップします。


32. 成功すると緑のチェックが入ります。

34. ワークフローが成功すると、「profile-summary-card-output」というファイルが一つ増えます。

35. 「profile-summary-card-output」の中のREADMEの中にコードが出来上がってますので、コピーします。(今回はdefaltをコピーしていますが、色がテーマが数種類ありますので、お好きなテーマをご利用ください)

37. そして、それを自分のREADMEに貼り付けると、完成です。

さいごに

だいぶ出来るエンジニア感が出てきました。
実は今回書いた事はGitHub Profile Summary CardsのREADMEに全部書いてあります。
私の説明で分からない方は公式をご参考ください。
次回は、アイコンなどを追加したいなと考えてます。

参考

https://github.com/vn7n24fzkq/github-profile-summary-cards

Discussion