https://github.com/uptick/actions-shame

Shame users via slack and praise them if they do good.
https://github.com/uptick/actions-shame

Last synced: about 1 year ago
JSON representation

Shame users via slack and praise them if they do good.

• Host: GitHub
• URL: https://github.com/uptick/actions-shame
• Owner: uptick
• Created: 2022-11-23T22:50:14.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2022-12-13T07:19:46.000Z (over 3 years ago)
• Last Synced: 2025-02-22T21:49:18.120Z (over 1 year ago)
• Language: Python
• Size: 200 KB
• Stars: 0
• Watchers: 8
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# Github Slack Shaming Action

This github action notifies a slack channel on test failures (and subsequent fixes). The action

will include relevant information as well as slack notifying the user responsible for the failed test.

The command is split into 2 commands. A shame and a praise.

On a `praise` command, the action will search your git history for the last completed JOB

matching the current job. If the last job was a failure, this action will praise the author for fixing it.

The github action is able to locate the slack user by searching your slack organisations api for users with the most similar name and email as the latest git commit.

![Example screenshot of slack message](screenshot.png)

## Inputs

### `command`

**Required** The command to use. `shame` or `praise` dictates the type of message.

### `SLACK_TOKEN`

**Required** The slack token with permissions to post a chat message and to search users.

### `SLACK_CHANNEL`

**Required** The channel to notify.

### `GITHUB_TOKEN`

**Required** The `GITHUB_TOKEN` with permissions to `read:actions`.

## Example usage

```yaml

permissions:

  actions: read

on: [push]

jobs:

  test:

    runs-on: ubuntu-latest

    steps:

      - name: Checkout Code

        uses: actions/checkout@v3

        with:

          # TODO: Configure fetch-depth?

          fetch-depth: 2

      - name: Test shame works

        if: startsWith(env.BRANCH_NAME, 'main') && failure()

        id: shame

        uses: uptick/actions-shame@main

        with:

          command: "shame"

          SLACK_TOKEN: ${{ secrets.SLACK_TOKEN }}

          SLACK_CHANNEL: "devops-test-slack"

          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

      - name: Test praise works

        if: startsWith(env.BRANCH_NAME, 'main') && success()

        id: praise

        uses: uptick/actions-shame@main

        with:

          command: "praise"

          SLACK_TOKEN: ${{ secrets.SLACK_TOKEN }}

          SLACK_CHANNEL: "devops-test-slack"

          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

```