geoffchan23 / repo-moderator

repo-moderator

This GitHub Action empowers repositories to regulate sponsor team interactions with GitHub Issues, Pull Requests, and Discussions, ensuring optimal collaboration and workflow integrity.

Key Features

• Label Enforcement: Restricts sponsors to a designated set of labels on issues and pull requests.
• Issue/PR Control: Prevents sponsors from closing, reopening, or assigning issues and pull requests.

Prerequisites

• A GitHub repository where you want to enforce sponsor restrictions.
• A GitHub Token with appropriate permissions (repo scope and potentially admin:org for managing team memberships).

Setup

1. Add Workflow: Create a .github/workflows/repo-moderator.yml file in your repository, copy over the "Workflow Example" below, and edit the sponsor-team-slug to the name of sponsor team in GitHub.
2. Secrets: This Action uses the default GitHub Action token GITHUB_TOKEN

Workflow Example

name: Repo Moderator

on:
  issues: 
    types: [labeled, unlabeled, closed, reopened, assigned, unassigned] 
  pull_request:
    types: [closed, reopened, assigned, unassigned]

jobs:
  revert-action:
    if: github.actor != 'C4-Staff'
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - name: Revert Label Changes
        uses: geoffchan23/repo-moderator@main
        with:
          github-token: ${{ secrets.GITHUB_TOKEN }}
          sponsor-team-slug: "2024-04-sponsor-team-name"
          allowed-labels: "sponsor confirmed, sponsor disputed, sponsor acknowledged"

repo-moderator's Issues

Move this repo to a C4 org

Write some better docs

Yes, this was AI generated.

Make sure the CMA is adding Triage access for the sponsor team on audit setup

Reverting hiding comments doesn't work

Could be hallucinated code as I don't see any reference to a comment_hidden event here https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#issue_comment

Moderating Discussions needs testing

This may be hallucinated code and needs testing to verify.

https://github.com/geoffchan23/label-reverter/blob/198e24fbe0751bdca52d3685c00581c20b7e97ec/index.js#L87-L109

Verify all working prevention cases for issues and PRs

If I assign an issue to myself it will unassign me. But if I assign the issue to someone else it does not unassign that person from the issue.

Add action to make sure latest build is being used

Add an action like this to run a job that checks the diff our the output build to make sure that the latest version of the action is being used.

Add action to contest template and figure out automating token on setup