https://github.com/andrewslotin/rummelsnuff

Mark and close spam PRs created for HacktoberFest
https://github.com/andrewslotin/rummelsnuff

actions hacktoberfest spam-detection spam-filtering

Last synced: 2 months ago
JSON representation

Mark and close spam PRs created for HacktoberFest

• Host: GitHub
• URL: https://github.com/andrewslotin/rummelsnuff
• Owner: andrewslotin
• License: mit
• Created: 2020-10-01T23:03:08.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2021-07-14T14:25:54.000Z (over 3 years ago)
• Last Synced: 2024-03-15T08:05:18.525Z (10 months ago)
• Topics: actions, hacktoberfest, spam-detection, spam-filtering
• Language: Go
• Homepage:
• Size: 46.9 KB
• Stars: 45
• Watchers: 2
• Forks: 4
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
Rummelsnuff

===========

A GitHub action to mark and close spam PRs created to get a free HacktoberFest T-shirt.

Rules

-----

A pull request is considered as spam if it's coming from a forked repository and meets at least one of following criterias:

* The author has registered after this year's Hacktoberfest and has only forked repositories

* The PR is changing documentation insignificantly

* The PR consists of additions or deletions in a single file only

Configuration

-------------

The action needs an access token to manage PRs. To provide an access token, add `access_token: ${{ secrets.GITHUB_TOKEN }}` to the `with:` section of your workflow step (see example below).

By default this action adds "Spam" label and closes the PR that is recognized as spam. A custom label can be provided via the `spam_label` input. To disable closing PRs set the `close_spam_prs` to any value except `"yes"`, for example:

``` yaml

- name: Rummelsnuff

  uses: andrewslotin/rummelsnuff@master

    with:

      spam_label: "Bad PR" # default: "Spam"

      close_spam_prs: "no" # default: "yes"

      access_token: ${{ secrets.GITHUB_TOKEN }} # one-time access token generated for this action run

```