📝 Documentation: Github Workflow Documentation

[seveibar]

Bug Report Checklist

• I have pulled the latest main branch of the repository.
• I have searched for related issues and found none that matched my issue.

Overview

I think it'd be cool to show how to use a github workflow to automate this.

I'm not sure you can create fine-grained access tokens for notifications though, so this could be issue (having your whole team's PATs on a server is not good)

Here's an action I wrote to help myself:

name: Prune seveibar GitHub Notifications

on:
  schedule:
    - cron: '*/10 * * * *'  # Runs every 10 minutes
  workflow_dispatch:  # Allows manual triggering

jobs:
  prune-notifications:
    runs-on: ubuntu-latest
    
    steps:
      - name: Setup Bun Runtime
        uses: oven-sh/setup-bun@v1
        with:
          bun-version: latest

      - name: Install Prune Notifications Tool
        run: bun install --global @seveibar/prune-github-notifications

      - name: Prune Bot Notifications
        env:
          GH_TOKEN: ${{ secrets.SEVEIBAR_GH_TOKEN }}
        run: prune-github-notifications --botAuthors --title ".*" --reason any

      - name: Prune Dependency Update Notifications
        env:
          GH_TOKEN: ${{ secrets.SEVEIBAR_GH_TOKEN }}
        run: prune-github-notifications --reason any --title ".*update dependency.*"

Additional Info

No response

[github-actions]

Uh oh! @seveibar, the image you shared is missing helpful alt text. Check your issue body.

Alt text is an invisible description that helps screen readers describe images to blind or low-vision users. If you are using markdown to display images, add your alt text inside the brackets of the markdown image.

Learn more about alt text at Basic writing and formatting syntax: images on GitHub Docs.

🤖 Beep boop! This comment was added automatically by github/accessibility-alt-text-bot.

[JoshuaKGoldberg]

Ooh I hadn't thought of this - but it's a really nifty idea!

Personally, I just keep a shell/terminal tab open on my desktop at all times just running this. Which means whenever my computer restarts itself (😡) I start getting notifications again. Irksome.

Anyway, +1, I think it's be great to have some kind of "Recipes" / "Suggested Usage" section including:

• This GHA suggestion
• watch -n1 npx -y prune-github-notifications --watch 50: until 🐛 Bug: --watch mode eventually crashes with no gh auth token #180 is resolved
• ...I can't think of anything else, but 🤷