action-gitstory-slack

What is this?

GitHub action for notifying to slack when pushed or merged to the repository.

Gitstory means Git + History 😅

How to use?

1. Create a slack app

Create a slack app and get the webhook url.

2. Add secrets to your repository

Add the webhook url to your repository secrets.

3. Create a workflow file

Create a workflow file in your repository.

name: Slack Notification

on:
  push:
    branches:
      - '**' # all branches
  pull_request:
    branches:
      - '**' # all branches

jobs:
  slack_notification:
    runs-on: ubuntu-latest
    steps:
      # checkout the repository
      - name: Checkout
        uses: actions/checkout@v4
        with:
          # fetch all history(you can adjust the depth)
          fetch-depth: 0
          # gitstory uses .git directory for commit history
          sparse-checkout: '.git'
      - name: Notify to slack
        uses: importamt/[email protected]
        env:
          # set your timezone
          TZ: Asia/Seoul
          # set secret in the GitHub setting repository settings
          WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }}
          BEFORE_REF: ${{ github.event.before }}

4. Push to the repository

Push the workflow file to the repository.

5. Check the slack

Check the slack when pushed or merged to the repository.

6. Enjoy!

License

MIT