https://github.com/browniebroke/hacktoberfest-labeler-action

A Github Action to labels issues for Hacktoberfest.
https://github.com/browniebroke/hacktoberfest-labeler-action

actions github-actions hacktoberfest labels

Last synced: about 1 month ago
JSON representation

A Github Action to labels issues for Hacktoberfest.

• Host: GitHub
• URL: https://github.com/browniebroke/hacktoberfest-labeler-action
• Owner: browniebroke
• License: mit
• Created: 2020-09-23T21:39:58.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2024-05-22T13:25:22.000Z (6 months ago)
• Last Synced: 2024-05-23T00:07:29.486Z (6 months ago)
• Topics: actions, github-actions, hacktoberfest, labels
• Language: Python
• Homepage:
• Size: 369 KB
• Stars: 2
• Watchers: 3
• Forks: 3
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# 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.

```yaml

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][token-permissions], and cannot update the repository's topics. You should create a repo scoped [personal access token][pat] 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.

[token-permissions]: https://docs.github.com/en/free-pro-team@latest/actions/reference/authentication-in-a-workflow#permissions-for-the-github_token

[pat]: https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token