NAME

github-mirror — Create archives for git tags

SYNOPSIS

DESCRIPTION

The github-mirror utility mirrors bare git repositories to GitHub. GitHub repositories are created/updated with the description pulled from the bare repository's description file and are set to public if pubfile exists. If present, the homepage is set to the contents of the homepage file. Repositories are then pushed in mirror mode.

github-mirror must be authenticated to GitHub by setting GH_TOKEN or using the -t option. The token must allow read access to "metadata" and read/write access to "administration".

The following options are available:

-a archivefile

If archivefile is present, mark the repository as archived on GitHub. Default is archived.

-p pubfile

Specify the file that determines if the repository is public or not. Default is git-daemon-export-ok.

-t pat

Set the GitHub PAT token. Required if GH_TOKEN isn't set.

EXIT STATUS

The github-mirror utility exits 0 on success, and >0 if an error occurs.

EXAMPLES

Mirror all the git repositories under /var/git to GitHub:

SEE ALSO

gitsrv(1), gh(1)

AUTHORS

Jacob R. Edwards <jacob@jacobedwards.org>