はてなブックマーク

You can use GitHub Pages to host a website about yourself, your organization, or your project directly from a repository on GitHub. GitHub Pages is available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub’s plans. A

GitHub's collaborative approach to development depends on publishing commits from your local repository to GitHub for other people to view, fetch, and update. About remote repositories A remote URL is Git's fancy way of saying "the place where your code is stored." That URL could be your repository on GitHub, or another user's fork, or even on a completely different server. You can only push to tw

Two-factor authentication (2FA) is an extra layer of security used when logging into websites or apps. With 2FA, you have to log in with your username and password and provide another form of authentication that only you know or have access to. Note As of March 2023, GitHub required all users who contribute code on GitHub.com to enable one or more forms of two-factor authentication (2FA). If you w

Public repositories on GitHub are often used to share open source software. For your repository to truly be open source, you'll need to license it so that others are free to use, change, and distribute the software. Choosing the right license We created choosealicense.com, to help you understand how to license your code. A software license tells others what they can and can't do with your source c

In rare circumstances, connecting to GitHub via SSH on Linux produces the error "Agent admitted failure to sign using the key". Follow these steps to resolve the problem. When trying to SSH into GitHub.com on a Linux computer, you may see the following message in your terminal: $ ssh -vT git@github.com > ... > Agent admitted failure to sign using the key. > debug1: No more authentication methods t

Rendering and diffing images GitHub can display several common image formats, including PNG, JPG, GIF, PSD, and SVG. In addition to simply displaying them, there are several ways to compare differences between versions of those image formats. Note GitHub does not support comparing the differences between PSD files. If you are using the Firefox browser, SVGs on GitHub may not render. Viewing images

Rendering and diffing images GitHub can display several common image formats, including PNG, JPG, GIF, PSD, and SVG. In addition to simply displaying them, there are several ways to compare differences between versions of those image formats. Note GitHub does not support comparing the differences between PSD files. If you are using the Firefox browser, SVGs on GitHub may not render. Viewing images

GitHub Pages is available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub’s plans. CNAME errors If you are publishing from a custom GitHub Actions workflow, any CNAME file is ignored and is not required. If you are p

Note If you have a project hosted on another Git-based hosting service, you can automatically import your project to GitHub using the GitHub Importer tool. For more information, see About GitHub Importer. Before you can push the original repository to your new copy, or mirror, of the repository, you must create the new repository on GitHub.com. In these examples, exampleuser/new-repository or exam

GitHub uses the email address in the commit header to link the commit to a GitHub user. If your commits are being linked to another user, or not linked to a user at all, you may need to change your local Git configuration settings, add an email address to your account email settings, or do both. Note If your commits are linked to another user, that does not mean the user can access your repository

You'll need to update your saved credentials in the git-credential-osxkeychain helper if you change your username, password, or personal access token on GitHub. Note Updating credentials from the macOS Keychain only applies to users who manually configured a personal access token using the osxkeychain helper that is built-in to macOS. We recommend you either configure SSH or upgrade to the Git Cre

Syncing a fork branch from the web UI On GitHub, navigate to the main page of the forked repository that you want to sync with the upstream repository. Above the list of files, select the Sync fork dropdown menu. Review the details about the commits from the upstream repository, then click Update branch. If the changes from the upstream repository cause conflicts, GitHub will prompt you to create

GitHub serves applications from multiple IP address ranges, which are available using the API. You can retrieve a list of the IP addresses for GitHub.com from the meta API endpoint. For more information, see REST API endpoints for meta data. Note The list of GitHub IP addresses returned by the Meta API is not intended to be an exhaustive list. For example, IP addresses for some GitHub services mig

You can use Jekyll, a popular static site generator, to further customize your GitHub Pages site. GitHub Pages is available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub’s plans.

Sometimes, firewalls refuse to allow SSH connections entirely. If using HTTPS cloning with credential caching is not an option, you can attempt to clone using an SSH connection made over the HTTPS port. Most firewall rules should allow this, but proxy servers may interfere. Warning GitHub Enterprise Server users: Accessing GitHub Enterprise Server via SSH over the HTTPS port is currently not suppo

Setting your commit email address on GitHub If you haven't enabled email address privacy, you can choose which verified email address to author changes with when you edit, delete, or create files or merge a pull request in the user interface. If you enabled email address privacy, then the commit author email address cannot be changed and will be a no-reply by default. For more information about th

Configuring ignored files for a single repository You can create a .gitignore file in your repository's root directory to tell Git which files and directories to ignore when you make a commit. To share the ignore rules with other users who clone the repository, commit the .gitignore file in to your repository. GitHub maintains an official list of recommended .gitignore files for many popular opera

Merge a pull request into the upstream branch when work is completed. Anyone with push access to the repository can complete the merge. About pull request merges In a pull request, you propose that changes you've made on a head branch should be merged into a base branch. By default, any pull request can be merged at any time, unless the head branch is in conflict with the base branch. However, the

When you select Available for hire, you indicate that you're open to job opportunities. When you select Available for hire and someone uses the REST API to get public and private information about authenticated users, the hireable field returns true. For more information, see REST API endpoints for users in the REST API documentation. In the upper-right corner of any page on GitHub, click your pro

A "Permission denied" error means that the server rejected your connection. There could be several reasons why, and the most common examples are explained below. Should the sudo command or elevated privileges be used with Git? You should not be using the sudo command or elevated privileges, such as administrator permissions, with Git. If you have a very good reason you must use sudo, then ensure y

If Git prompts you for a username and password every time you try to interact with GitHub, you're probably using the HTTPS clone URL for your repository. Using an HTTPS remote URL has some advantages compared with using SSH. It's easier to set up than SSH, and usually works through strict firewalls and proxies. However, it also prompts you to enter your GitHub credentials every time you pull or pu

HTTPS cloning errors There are a few common errors when using HTTPS with Git. These errors usually indicate you have an old version of Git, or you don't have access to the repository. Here's an example of an HTTPS error you might receive: > error: The requested URL returned error: 401 while accessing > https://github.com/USER/REPO.git/info/refs?service=git-receive-pack > fatal: HTTP request failed