Github Actionで自動コミット設定をする

公開日時

Git Auto Commitを使うとGithub Action実行時に自動コミットができる。

これを使うとCI実行時にAPI仕様書を自動更新する、といったことができるので、仕様書の更新漏れを防ぐことができる。

なお、pushを有効にするには[[action/checkout@v2]]を利用する必要があるとのこと。

↓のようにすればCI実行のたびにdoc以下を削除して仕様書を自動コミットしてくれるようになる。

([[yarn run generate-api-docs]]部分はダミー)

name: build

on: [push]

jobs:
  build:
    runs-on: ubuntu-latest

    steps:
      - uses: actions/checkout@v2

      - name: Use Node.js
        uses: actions/setup-node@v1
        with:
          node-version: '12.x'

      - name: Install dependencies
        run: yarn
        
      # build
      # test
      
      - name: Cleanup
        working-directory: ./doc
        run: |
          rm -rf *
      - name: Generate API doc
        run: |
          yarn run generate-api-docs
      - name: Update API docs
        uses: stefanzweifel/git-auto-commit-action@v4.2.0
        with:
          commit_message: Update API docs

参考


Related #github

iPhoneで撮った写真(HEIC)をGitHubにアップロードする

GitHubアプリ上からアップロードするのが楽

MonorepoでGitHub Actionsを使う

pathsを設定することでサブディレクトリへの変更のみを検知できるようになった

Personal Access Tokenの見直し

整理した

Github ActionでfirebaseプロジェクトをS3にデプロイする

deploymentブランチにpushしたら自動でs3にデプロイできるようになった

Github ActionでCloudfrontのキャッシュをクリアする

デプロイ後にキャッシュクリアを行うように設定

GitHub app is built on Slack's workspace apps which are now deprecated

旧GitHub appは新appのインストール後に消すべきだった