https://github.com/nethermindeth/starknet-proposals-whisperer

A very gossipy slack bot that warns when there is a new Starknet Proposal
https://github.com/nethermindeth/starknet-proposals-whisperer

bot go nubia slack

Last synced: 10 days ago
JSON representation

A very gossipy slack bot that warns when there is a new Starknet Proposal

• Host: GitHub
• URL: https://github.com/nethermindeth/starknet-proposals-whisperer
• Owner: NethermindEth
• License: mit
• Created: 2023-10-30T11:31:05.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2023-11-06T13:23:57.000Z (about 1 year ago)
• Last Synced: 2024-11-24T20:36:43.237Z (about 1 month ago)
• Topics: bot, go, nubia, slack
• Language: HCL
• Homepage:
• Size: 146 KB
• Stars: 0
• Watchers: 5
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Starknet Proposals Whisperer

- [Starknet Proposals Whisperer](#starknet-proposals-whisperer)

  - [Project Description](#project-description)

  - [What the Code Does](#what-the-code-does)

  - [AWS Lambda Deployment](#aws-lambda-deployment)

  - [How to Update the Code and Trigger CI/CD](#how-to-update-the-code-and-trigger-cicd)

![Example](images/example.png)

## Project Description

The Starknet Proposals Whisperer is a Slack bot designed to keep your team updated on new Starknet Proposals. It listens for new pull requests in a specified GitHub repository and sends notifications to a Slack channel. This bot aims to streamline the process of keeping track of new proposals, ensuring that your team is always in the loop.

## What the Code Does

The core logic of the application is written in Go and is contained in the main.go file. The application uses AWS Lambda to run the code. Here's a breakdown of what the code does:

- Initializes environment variables for Slack Webhook URL, GitHub repository owner and name, and a threshold for days.

- Listens for new pull requests in the specified GitHub repository.

- Sends a Slack notification if a new pull request is detected within the threshold days.

## AWS Lambda Deployment

The code is deployed to AWS Lambda, Angkor-Production account.

> The binary is built inside an Amazon Linux 2 Docker container to ensure compatibility with the AWS Lambda environment.

- AWS Region: us-east-2

- Runtime: Go 1.x

- Handler: main

- Function Name: starknet-proposals-whisperer

- Environment Variables: 

    - `SLACK_WEBHOOK_URL`: The Slack Webhook URL for the channel you want to send notifications to.

    - `GITHUB_REPO_OWNER`: The owner of the GitHub repository you want to monitor.

    - `GITHUB_REPO_NAME`: The name of the GitHub repository you want to monitor.

    - `THRESHOLD_DAYS`: The number of past days you want to monitor for new pull requests.

## How to Update the Code and Trigger CI/CD

The repository uses GitHub Actions for Continuous Integration and Continuous Deployment. The workflow is defined in the `.github/workflows/deploy.yml` file. To update the code and trigger the CI/CD pipeline, follow these steps:

1. Make your code changes locally.

1. Commit and push the changes to the main branch.

1. GitHub Actions will automatically build and deploy the code to AWS Lambda.