Get Started

一番需要があると思われる、Qittaの記事リストをREADME.mdに表示する方法を説明します。

README.mdの作成

プロフィールの README を管理するを参考に、プロフィール用リポジトリにREADME.mdを作成してください。 要はusername/usernameのリポジトリを作って、README.mdを作成しておくだけです。 README.md内で記事リストを表示したい場所に以下記述を入れてください。

# Qiita Articles

<!-- profile updater begin: qiita -->
(ここにリストが表示されます。この記述は後で更新され消えます)
<!-- profile updater end: qiita -->

GitHub Actionsの権限設定

GitHub Actionsがリポジトリに変更をプッシュするために、以下のいずれかの方法で書き込み権限を付与する必要があります：

1. ワークフローファイルでの設定（推奨）

下記の「GitHub Actionsの設定」で書かれるワークフローファイルにpermissionsセクションを追加しています。 この方法が最も安全で管理しやすい方法です。

2. リポジトリ設定での設定

または、リポジトリの Settings > Actions > General > Workflow permissions で「Read and write permissions」を選択することもできます。 ただし、この方法はリポジトリ全体の設定を変更することになります。

GitHub Actionsの設定

.github/workflows/に以下のようなYAMLファイルを置きます。ファイル名は何でも良いですが、ここではprofile-updater.ymlとしておきます。

name: profile updater

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

jobs:
  profile-updater:
    runs-on: ubuntu-latest
    permissions:
      contents: write
    steps:
      - uses: actions/checkout@v4
      - uses: kumackey/profile-updater@v1
        with:
          qiita_user_id: <ここに自分のQiitaのUser IDを入力してください>
      - name: Commit and push
        run: |
          git config --local user.name "GitHub Actions"
          git config --local user.email "action@github.com"
          git commit -am "profile updated" || true
          git push origin main

GitHub Actionsの実行

以下のように緑マークの表示がされれば成功です。

README.mdを確認すると、Qiitaの記事リストが表示されているはずです。

ちなみに、以下で記述した設定により「1日1回Github Actionsを実行する」という仕組みになっているので、今後は手動でGitHub Actionsの実行をする必要はありません。

  schedule:
    - cron: '0 0 * * *'