GH Release Paniker

A simple GitHub Action that physically puts your senses on alert when your build/release fails

Usage

Requirements:

Raspberry Pi, LED, Buzzer, Internet connection, Router with port-forwarding capabilities and some patience :D

• Step 1: Assembling the Circuit

  Assemble the Circuit as given in the diagram

  

• Step 2: Installing the FastAPI Server Clone the repo using the comment git clone https://github.com/DarthBenro008/gh-release-paniker in your Raspberry Pi

  Run the following commands:

  cd server
  pip install -r requirements.txt
  unvicorn main:app --host=0.0.0.0 --port=3000

• Step 3: Port forward and get the IP Address of your Raspberry Pi

  Go to your Router settings and port forward the IP address of your Raspbery Pi on port 3000

  Warning: Port forwarding exposes your raspberry pi to the internet, ensure you do not have any sensitive data or server running on it

• Step 4: Pick a GitHub Action workflow from this repository

  From the .github/workflows folder, you have various workflows to pick for your project, pick one and replace the public IP in the last line where it asks you to replace

  Incase you want to add your own YAML workflow, just ensure the continue-on-error: true is appended to each step and then you can add an additional step as follows:

      - name: Send Paniker
        if: steps.stepID.outcome != 'success' # Replace Step ID with your stepid 
        run: curl http://YOUR_IP:3000/panik # Replace the port-forwaded public IP

• Step 5: Hope this setup never buzzes! and may your releases always succeed

In order to turn off the buzzer, you have to go the following url: http://YOUR_IP:3000/stop

Actions Available

This repository contains various GitHub Actions that help Open-Source projects release a new version of their project with a single command.

This repository contains the following:

• rust-releaser
• golang-releaser
• hugo-releaser
• android-releaser

Use Cases

GitHub Actions featured in this repository

• actions/checkout@v1
• actions-rs/toolchain@v1
• actions/setup-go@v2
• softprops/action-gh-release@v1
• peaceiris/actions-hugo@v2
• peaceiris/actions-gh-pages@v3
• DarthBenro008/[email protected]