Zenn
🐙

[GitHub Actions] Pull Request時に自動テスト/prettier/ESLintを実行する

2024/09/22に公開
GitHub
GitHub Actions
初心者向け
tech

はじめに

この記事では、GitHub Actionsで自動テスト/prettier/ESLintを実行する方法を解説します。

1. github/workflows配下にcode_check.yamlを作成する

1. github/workflows配下にcode_check.yamlを作成する

2. code_check.yamlを記述する

  • 自動テスト
  • prettier
  • ESLint
# Actionの名前
name: Code Check

on:
  # Pull Request時
  pull_request:
    # 対象のブランチを指定
    branches: ['test_CI/CD']

jobs:
  Code-Check:
    runs-on: ubuntu-latest
    steps:
      # GitHubリポジトリのコードをチェックアウト
      - uses: actions/checkout@v3
      # Node.js v18をセットアップ
      - name: Use Node.js v18
        # npmのキャッシュを有効
        # 以前にインストールしたnpmパッケージを再利用でき、ビルド時間を短縮
        uses: actions/setup-node@v3
        with:
          node-version: 18
          cache: 'npm'
      # プロジェクトの依存関係をインストール
      - run: npm ci
      # prettierでコードのフォーマットをチェック
      - run: npm run prettier-format
      # ESLintでコードをチェック
      - run: npm run eslint
      # 自動テストの結果/カバレッジをチェック
      - run: npm run test:cov test/

3. 開発ブランチに取り込み

今後のPR(Pull Request)を出されたときにGitHub Actionsが実行する

GitHubで編集を提案

Discussion