README.ja.md

Get Diff Action

Read this in other languages: English, 日本語.

これは git diff を取得するための GitHub Actions です。

Table of Contents

Details

• スクリーンショット
• 使用方法
• 動作
• 出力
• Action イベント詳細
  • 対象イベント
• 補足
  • FROM, TO
• Author

スクリーンショット

1. Workflow の例
   
2. スキップ
   

使用方法

on: pull_request
name: CI
jobs:
  eslint:
    name: ESLint
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - uses: technote-space/get-diff-action@v1
        with:
          PREFIX_FILTER: |
            src
            __tests__
          SUFFIX_FILTER: .ts
      - name: Install Package dependencies
        run: yarn install
        if: env.GIT_DIFF
      - name: Check code style
        # 差分があるソースコードだけチェック
        run: yarn eslint ${{ env.GIT_DIFF }}
        if: env.GIT_DIFF

  phpmd:
    name: PHPMD
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - uses: technote-space/get-diff-action@v1
        id: git_diff
        with:
          SUFFIX_FILTER: .php
          SEPARATOR: ','
      - name: Install composer
        run: composer install
        if: steps.git_diff.outputs.diff
      - name: Check code style
        # 差分があるソースコードだけチェック
        run: vendor/bin/phpmd ${{ steps.git_diff.outputs.diff }} ansi phpmd.xml
        if: steps.git_diff.outputs.diff

以下のソースコードに差分がない場合、この Workflow はコードのスタイルチェックをスキップします。

• src/**/*.ts
• __tests__/**/*.ts

動作

1. git diff を取得

   git diff ${FROM}${DOT}${TO} '--diff-filter=${DIFF_FILTER}' --name-only

   例：(default)

   DOT: '...'
   DIFF_FILTER: 'AM'

   =>

   git diff ${FROM}...${TO} '--diff-filter=AM' --name-only

   =>

   .github/workflows/ci.yml
   __tests__/utils/command.test.ts
   package.json
   src/main.ts
   src/utils/command.ts
   yarn.lock
   

   ${FROM}, ${TO}

2. PREFIX_FILTER や SUFFIX_FILTER オプションによるフィルタ

   例：

   SUFFIX_FILTER: .ts
   PREFIX_FILTER: src/

   =>

   src/main.ts
   src/utils/command.ts
   

3. ABSOLUTE オプションがtrue場合に絶対パスに変換 (default: false)

   例：

   /home/runner/work/my-repo-name/my-repo-name/src/main.ts
   /home/runner/work/my-repo-name/my-repo-name/src/utils/command.ts
   

4. SEPARATOR オプションの値で結合

   例：(default: false)

   SEPARATOR: ' '

   =>

   /home/runner/work/my-repo-name/my-repo-name/src/main.ts /home/runner/work/my-repo-name/my-repo-name/src/utils/command.ts
   

出力

name	description	e.g.
diff	差分のあるファイルの結果 SET_ENV_NAME(default: GIT_DIFF) が設定されている場合、その名前で環境変数が設定されます	src/main.ts src/utils/command.ts
count	差分のあるファイル数 SET_ENV_NAME_COUNT(default: '') が設定されている場合、その名前で環境変数が設定されます	100
insertions	追加された行数 SET_ENV_NAME_INSERTIONS(default: '') が設定されている場合、その名前で環境変数が設定されます	100
deletions	削除された行数 SET_ENV_NAME_DELETIONS(default: '') が設定されている場合、その名前で環境変数が設定されます	100
lines	追加された行数と削除された行数の和 SET_ENV_NAME_LINES(default: '') が設定されている場合、その名前で環境変数が設定されます	200

Action イベント詳細

対象イベント

eventName	action
pull_request	opened, reopened, synchronize, closed
push	*

もしこれ以外のイベントで呼ばれた場合、結果は空になります。

補足

FROM, TO

condition	FROM	TO
tag push	---	---
pull request	pull.base.ref (e.g. master)	context.ref (e.g. refs/pull/123/merge)
push (has related pull request)	pull.base.ref (e.g. master)	refs/pull/${pull.number}/merge (e.g. refs/pull/123/merge)
context.payload.before = '000...000'	default branch (e.g. master)	context.payload.after
else	context.payload.before	context.payload.after

Author

GitHub (Technote)
Blog