get-git-comment-action

GitHub actions to get git comment.

View project on GitHub

Get git comment action

CI Status codecov CodeFactor License: MIT

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

これは Git コメントを取得する GitHub Actions です。

Table of Contents

Details - [スクリーンショット](#%E3%82%B9%E3%82%AF%E3%83%AA%E3%83%BC%E3%83%B3%E3%82%B7%E3%83%A7%E3%83%83%E3%83%88) - [Skip CI](#skip-ci) - [Not skip CI](#not-skip-ci) - [使用方法](#%E4%BD%BF%E7%94%A8%E6%96%B9%E6%B3%95) - [出力](#%E5%87%BA%E5%8A%9B) - [message](#message) - [Why?](#why) - [Author](#author)

スクリーンショット

Skip CI

skip ci

Not skip CI

not skip ci

使用方法

例:

on:
  pull_request:
  push:
    branches:
      - main
    tags:
      - "!*"
name: CI
jobs:
  eslint:
    name: Test
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - uses: technote-space/get-git-comment-action@v1
      - name: Install Package dependencies
        run: yarn install
        if: "! contains(env.COMMIT_MESSAGE, '[skip ci]') && ! contains(env.COMMIT_MESSAGE, '[ci skip]')"
      - name: Check code style
        run: yarn test
        if: "! contains(env.COMMIT_MESSAGE, '[skip ci]') && ! contains(env.COMMIT_MESSAGE, '[ci skip]')"

出力

message

if eventName == push

payload.head_commit.message

else

  1. git log --format=%B

    例:

    test1 test2  
       
    test3
    
  2. 改行で分割

    例:

    ['test1 test2', '', 'test3']
    
  3. トリム及び空白行の削除

    例:

    ['test1 test2', 'test3']
    
  4. SEPARATOR オプションの値で結合

    例:

    test1 test2 test3
    
  • sha
    1. context.payload.pull_request.head.sha
    2. context.payload.deployment.sha
    3. context.sha

Why?

[ci skip] を実現する方法として head_commit.message の紹介がよくありますが、もちろん pull_request イベントなどでは使用できません。
このアクションを使用することで push 以外でもコメントを取得することが可能になります。

Author

GitHub (Technote)
Blog