Hacktoberfest Labeler Action

A Github Action to opt-in to Hacktoberfest every year.

Usage

This workflow will be adding the hacktoberfest topic to your repo and label all the issues flagged as good first issue with the hacktoberfest label.

The workflow will behave differently if executed in October. You can run it once at the beginning of November to remove the hacktoberfest topic from your repo and un-label your issues.

name: Hacktoberfest

on:
  schedule:
    # Run every day in October
    - cron: "0 0 * 10 *"
    # Run on the 1st of November to revert
    - cron: "0 13 1 11 *"

jobs:
  hacktoberfest:
    runs-on: ubuntu-latest

    steps:
      - uses: browniebroke/hacktoberfest-labeler-action@main
        with:
          github_token: ${{ secrets.GH_PAT }}

Note that the default secrets.GITHUB_TOKEN hasn't got enough permissions, and cannot update the repository's topics. You should create a repo scoped personal access token instead. Alternatively, you can fork the repo and replace the action name to use your fork after reviewing the code to ensure security of your repository. This would mitigate the non-granular GitHub PAT permission scopes.