github-slack-notify-action

---

📝 Table of Contents

• 📝 Table of Contents
• 🧐 About
• 🏁 Getting Started
• 🎈 Usage
• 🚀 Deployment
• ⛏️ Built Using
• ✍️ Authors

🧐 About

깃헙 이벤트를 슬랙으로 받아보기 위한 액션입니다.

🏁 Getting Started

개발 및 테스트 목적으로 로컬에서 프로젝트를 실행하는 방법을 설명합니다. 배포하는 방법에 대한 자세한 내용은 deployment를 참조 해주세요

🎈 Usage

다음과 같은 깃헙 액션을 .github/workflows 디렉토리에 생성해주세요. 액션 이름을 입력할 때는 현재 버전을 잘 보고 myrealtrip/github-slack-notify-action@{최신버전}의 포맷으로 입력해주세요.

name: Sample Action
on: [pull_request, pull_request_review]

jobs:
  create-pr:
    runs-on: ubuntu-latest
    name: Slack Notification
    steps:
      - name: Checkout
        uses: actions/checkout@master
      - name: Fire Notification
        uses: myrealtrip/github-slack-notify-action@latest
        with:
          plane-text: Hello Myrealtrip!
          slack-bot-token: ${{ secrets.SLACK_BOT_TOKEN }}
          github-token: ${{ secrets.GITHUB_TOKEN }}
          channel-id: "my-slack-channel-id"

이름	설명	옵션
slack-bot-token	메세지를 보낼 슬랙봇 토큰.	필수
github-token	Github Personal Access Token. repo 스코프를 지정해서 생성해주세요	필수
channel-id	노티를 쏘고 싶은 슬랙 채널 ID	선택
build-type	design_system_production, design_system_canary, canary_deploy, production_deploy	선택
plane-text	build-type 값 주지 않으면 슬랙 채널에 평문 메세지 전송합니다(마크다운 작성 가능)	선택
action-owner	github username 값을 주면 깃허브 프로필 명이 포함 되어 전송 됩니다.	선택

* action-owner 값이 포함 되었을때 예시

Author: 정건우(Frontend)
테스트 메세지입니다.

🚀 Deployment

• 앵귤러 커밋 가이드를 따라 시멘팅 버저닝과 매핑 되어 자동으로 버전이 상승합니다.

  [
    {
      "release": "minor",
      "type": "feat"
    },
    {
      "release": "patch",
      "type": "fix"
    },
    {
      "release": "patch",
      "type": "chore"
    },
    {
      "release": "patch",
      "type": "docs"
    },
    {
      "release": "patch",
      "type": "style"
    },
    {
      "release": "patch",
      "type": "refactor"
    },
    {
      "release": "patch",
      "type": "perf"
    },
    {
      "release": "patch",
      "type": "test"
    },
    {
      "release": "minor",
      "type": "build"
    },
    {
      "release": "patch",
      "type": "ci"
    },
    {
      "release": "minor",
      "type": "revert"
    }
  ]

• master 브랜치의 최근 커밋을 타입을 따릅니다.

• yarn build 를 통해 dist 파일과 함께 업스트림에 푸쉬 해주세요

  $ yarn build

• 최신 태그를 마켓 플레이스에 등록 해주세요

⛏️ Built Using

• @actions/core - 깃헙 액션
• @actions/github - 깃헙 이벤트
• @slack/web-api - 슬랙
• @vercel/ncc - 번들러

✍️ Authors

• @myrealtrip - Idea & Initial work