When you rename a repository, all existing information, with the exception of project site URLs, is automatically redirected to the new name, including:
For more information on project sites, see "About GitHub Pages."
In addition to redirecting web traffic, all
git fetch, or
git push operations targeting the previous location will continue to function as if made on the new location. However, to reduce confusion, we strongly recommend updating any existing local clones to point to the new repository URL. You can do this by using
git remote on the command line:
$ git remote set-url origin new_url
For more information, see "Managing remote repositories."
If you plan to rename a repository that has a GitHub Pages site, we recommend using a custom domain for your site. This ensures that the site's URL isn't impacted by renaming the repository. For more information, see "About custom domains and GitHub Pages site."
Note: GitHub will not redirect calls to an action hosted by a renamed repository. Any workflow that uses that action will fail with the error
repository not found. Instead, create a new repository and action with the new name and archive the old repository. For more information, see "Archiving repositories."
Warning: If you create a new repository under your account in the future, do not reuse the original name of the renamed repository. If you do, redirects to the renamed repository will break.
- On GitHub.com, navigate to the main page of the repository.
- Under your repository name, click Settings.
- Under the Repository Name heading, type the new name of your repository.
- Click Rename. You're done!