https://github.com/jdockerty/announcerd

Announce a message from pull requests into Slack
https://github.com/jdockerty/announcerd

announcement-bot github-app golang slack

Last synced: 30 days ago
JSON representation

Announce a message from pull requests into Slack

• Host: GitHub
• URL: https://github.com/jdockerty/announcerd
• Owner: jdockerty
• License: mit
• Created: 2022-10-11T15:16:31.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2022-10-25T16:53:52.000Z (about 2 years ago)
• Last Synced: 2024-10-13T09:21:26.199Z (2 months ago)
• Topics: announcement-bot, github-app, golang, slack
• Language: Go
• Homepage:
• Size: 28.3 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# announcerd

Announce a message from pull requests into Slack

### Motivation

I have forgotten to announce too many times at work. This workflow involved moving from a pull

request and writing out the message myself into a channel. This made me think *"shouldn't think be done entirely from a PR?"*.

By simply adding `announcement=""` to a pull request, the given message should be placed into a channel for the provided webhook.

### Usage

This is built as a [GitHub App](https://docs.github.com/en/developers/apps/getting-started-with-apps/about-apps) and will require installation as such.

#### Configuration

The application takes various environment variables which are used for configuration.

* `ANNOUNCERD_GH_APP_ID` is the GitHub App Application ID (required).

* `ANNOUNCERD_GH_APP_KEY_FILE` is the path to the `.pem` key file for the GitHub App (required).

* `ANNOUNCERD_SLACK_WEBHOOK` is the "Incoming Webhook" for Slack, configured to the channel you want to send announcements too (required).

* `ANNOUNCERD_HOST` is the address which `announcerd` binds to, by default this is `localhost`.

* `ANNOUNCERD_PORT` is the port which `announcerd` binds to, by default this is `6000`.