Skip to content

Hacktoberfest/hacktoberfest-repo-topic-apply

main
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
 
 
 
 

hfest-repo command line tool

hfest is a tool that adds the hacktoberfest topic to every public repository associated with a user or a GitHub org. It can also create the invalid, spam and hacktoberfest-accepted labels in your repos.

Installation

  1. Download the latest release from the releases page.
  2. Either move the binary to /usr/local/bin or run it locally.

Create an Access Token

You will need an access token to perform these actions on your repositories. Follow the instructions for creating a personal access token on GitHub and be sure to give it repo access. If you are using GitLab instead, follow these instructions for creating a personal access token on GitLab instead.

Usage

To use hfest-repo, run:

hfest-repo -t <TOKEN> 

If you don't specify your GitHub token, the tool will look for an environment variable named ACCESS_TOKEN.

To use GitLab instead of GitHub

hfest-repo -vcs Gitlab -t <TOKEN> 

if you don't specify your version control system, Github or Gitlab, it will default to Github.

The "Default Hacktoberfest run this on my stuff in GitHub" command

hfest-repo -t <TOKEN> -u <USER> --labels

The "Default Hacktoberfest run this on my stuff in GitLab" command

hfest-repo --vcs Gitlab -t <TOKEN> -u <USER> --labels

The "Default Hacktoberfest run this on my stuff" command, but run as a dry run for validation

hfest-repo -t <TOKEN> -u <USER> --labels --dry-run

Add Hacktoberfest topic to a user's repos

hfest-repo -t <TOKEN> -u <USER>

Add Hacktoberfest topic to an organization's (or group's if on Gitlab) repos

hfest-repo -t <TOKEN> -o <ORG>

Add Hacktoberfest topic to a user's repos and add labels

hfest-repo -t <TOKEN> -u <USER> --labels

Add Hacktoberfest topic to an organization's repos and add labels

hfest-repo -t <TOKEN> -o <ORG> --labels

Remove Hacktoberfest topic from a user/org

hfest-repo -t <TOKEN> -u <USER>/-o <ORG> --remove

Remove Hacktoberfest topic from a user/org

hfest-repo -t <TOKEN> -u <USER>/-o <ORG> --remove

Remove Hacktoberfest topic and labels from a user/org

hfest-repo -t <TOKEN> -u <USER>/-o <ORG> --labels --remove

Add an arbitrary topic to a user's/organization's repos instead of the hacktoberfest topic

hfest-repo -t <TOKEN> -u <USER>/-o <ORG> -p fun

Add Hacktoberfest topic to a user's repos including private and forks

hfest-repo -t <TOKEN> -u <USER> --include-forkes --include-private

Supported Options

usage: hfest-repo [<flags>]

Flags:
      --help                   Show context-sensitive help (also try --help-long and --help-man).
  -V, --vcs="Github"           GitHub or GitLab, defaults to GitHub
  -t, --access-token=ACCESS-TOKEN  
                               GitHub or GitLab API Token - if unset, attempts to use this tool's stored token of its current default context. env var: ACCESS_TOKEN
  -u, --user=USER           Github or Gitlab user to fetch repos of
  -o, --org=ORG             Github org or Gitlab group to fetch repos of
  -p, --topic="hacktoberfest"  topic to add to repos
  -r, --remove                 Remove topic and labels from all repos. Include -l to
                               remove labels
  -l, --labels                 Add spam, invalid, and hacktoberfest-accepted labels to repo
      --include-forks          Include forks
      --include-private        Include private repos
  -d, --dry-run                Show more or less what will be done without doing anything

About

Cmd line tool to add a topic to your github repo, defaults to hacktoberfest

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages