Configuring GitHub

GitHub is a web-based hosting service for Git repos. You can have both local and remote copies of your repos, which makes it easy to collaborate.

GitHub Enterprise is an on-premises, web-based hosting service for Git repos.

GitHub Issues is a tracking tool that keeps your work and your plans all in one place. It is integrated with your development repo so that you can focus on important tasks.

You can configure GitHub as a tool integration in your toolchain so that you can manage source code in a new or existing repo on GitHub.com or your company's GitHub Enterprise instance. Engage in social coding through wikis, issue tracking, and pull requests.

If you are configuring this tool integration as you are creating the toolchain, follow these steps:

If you are storing your source code in a GitHub repo, in the Configurable Integrations section, click GitHub. If you are configuring this tool integration on IBM Cloud Public, you must authorize IBM Cloud to access GitHub by choosing either OAuth or Personal Access Token.
- If you choose OAuth, click Authorize to go to the GitHub website. If you don't have an active GitHub session, you are prompted to log in. Click Authorize Application to allow IBM Cloud to access your GitHub account. If you have an active GitHub session but you didn't enter your password recently, you might be prompted to enter your GitHub password to confirm.
- If you choose Personal Access Token, you must enter the personal access token to use to authorize with GitHub to clone repos and perform other actions on your behalf. If you don't have a personal access token, you can follow the documentation on the GitHub website to create one. Make sure that your personal access token has repo, delete_repo, read:user, and workflow rights.
If you are using a repo on your own GitHub Enterprise server, in the Configurable Integrations section, click Custom Server.

a. Type a title for your custom GitHub server, specify the root URL for the server, and enter your personal access token.

b. If you don't have a personal access token, you can follow the documentation on the GitHub website to create one.

c. If your GitHub server is air-gapped or is not accessible on the public internet, you can connect and integrate a Delivery Pipeline Private Worker to run on your own Kubernetes infrastructure to access internal or on-premises resources. For more information about Delivery Pipeline Private Workers, see Working with Delivery Pipeline Private Workers.
Review the default target repo locations for the GitHub repos. Those repos are cloned from the sample repos. If needed, change the names of the target repos.

If you have a toolchain and are adding this tool integration to it, follow these steps:

From the IBM Cloud console, click the Menu icon > Platform Automation > Toolchains. On the Toolchains page, click the toolchain to open its Overview page. Alternatively, on your app's Overview page, on the Continuous delivery card, click View toolchain. Then, click Overview.
Click Add tool.
In the Tool Integrations section, click GitHub.
Click the GitHub server that you want to use.
If you have a GitHub or GitHub Enterprise repo and want to use it, for the repository type, click Existing and type the URL.
If you want to use a new GitHub or GitHub Enterprise repo, type a name for the repo, type the URL for the repo that you are cloning or forking, and select the repository type:

a. To create an empty repo, click New.

b. To create a copy of a GitHub or GitHub Enterprise repo, click Clone.

c. To fork a GitHub or GitHub Enterprise repo so that you can contribute changes through pull requests, click Fork.
If you are a GitHub.com user with an upgraded account, or you selected a GitHub Enterprise server and you want to make a new private repo on the server, select the Make this repository private checkbox.
If you want to use GitHub's Issues for issue tracking, select the Enable GitHub Issues checkbox.
If you want to track the deployment of code changes by creating tags and comments on commits, and labels and comments on issues that are referenced by the commits, select the Track deployment of code changes checkbox. For more information, see Track where your code is deployed with toolchains.
Click Create Integration.
From your toolchain's Overview page, on the Repositories card, click the GitHub or GitHub Enterprise repo that you want to work with. Depending on the repo that you selected, either the GitHub website or your company's GitHub Enterprise repo opens, where you can view the contents of the repo.
If you enabled GitHub Issues, click GitHub Issues to open it. You can use this instance of GitHub Issues for your entire toolchain, even if the toolchain contains multiple GitHub or GitHub Enterprise repos.

If you don't have admin privileges for the repo that you are linking to, your integration is limited because you can't use a webhook. Webhooks are required to automatically run a pipeline when a commit is pushed to the repo. Without a webhook, you must start your pipelines manually.

Configuring GitHub by using the API

The GitHub tool integration supports the following configuration parameters that you can use with the Toolchain HTTP API and SDKs when you create, read, and update tool integrations.

You must specify the tool_type_id property in the request body with the githubconsolidated value.

GitHub tool integration parameters
Parameter	Usage	Type	Terraform argument	Description
api_root_url	optional, updatable	String	api_root_url	The URL of the API root for the GitHub server.
api_token	optional, updatable	Password	api_token	The Personal Access Token (PAT). This parameter is required only if the `auth_type` is set to `pat`, otherwise it is ignored.
auth_type	optional, updatable	String	auth_type	Set the authentication method to use to access the Git provider.
auto_init	optional, immutable, `Default: false`	Boolean	auto_init	Set this value to `true` to initialize this repo with a readme file. This parameter is used only when you create a repo.
blind_connection	optional, updatable, `Default: false`	Boolean	blind_connection	Setting this value to true means the server is not addressable on the public internet. IBM Cloud can't validate the connection details you provide. Certain functionality that requires API access to the git server will be disabled. Delivery pipeline will only work using a private worker that has network access to the git server.
default_branch	optional, updatable	String	default_branch	The default branch of the Git repo.
enable_traceability	optional, updatable, `Default: false`	Boolean	enable_traceability	Set this value to `true` to track the deployment of code changes by creating tags, labels and comments on commits, pull requests, and referenced issues.
git_id	optional, immutable	String	git_id	Set this value to `github` for github.com, or to the GUID of a custom GitHub Enterprise server.
has_issues	optional, updatable, `Default: true`	Boolean	toolchain_issues_enabled	Set this value to `true` to enable issues on the GitHub repo and add an Issues tool card to the toolchain. Set the value to `false` to remove the tool integration card from the toolchain. This setting does not impact whether issues are enabled on the GitHub repo itself.
integration_owner	optional, updatable	String	integration_owner	Select the user that the Git operations are performed as.
owner_id	optional, immutable	String	owner_id	The GitHub user or organization that owns the repo. This parameter is required when you create a repo, or clone or fork a repo. This value is computed when you link to an existing repo.
private_repo	optional, immutable, `Default: false`	Boolean	private_repo	Set this value to `true` to make the repo private when you create a repo or clone or fork a repo. This parameter is not used when you link to an existing repo.
repo_id	optional, immutable	String	repo_id	The ID of the GitHub repo.
repo_name	optional, immutable	String	repo_name	The name of the GitHub repo to create. This parameter is required when you create a repo, or clone or fork a repo. This value is computed when you link to an existing repo.
repo_url	optional, immutable	String	repo_url	The URL of the GitHub repo for this tool integration. This parameter is required when you link to an existing repo. This value is computed when you create a repo, or clone or fork a repo.
root_url	optional, updatable	String	root_url	The Root URL of the server. e.g. https://github.example.com
source_repo_url	optional, immutable	String	source_repo_url	The URL of the repo that you are forking or cloning. This parameter is required when you fork or clone a repo. It is not used when you create a repo or link to an existing repo.
title	optional, updatable	String	title	The title of the server. e.g. My GitHub Enterprise Server
token_url	optional, updatable	String	token_url	The token URL that is used to authorize with the GitHub server.
type	required, immutable	String	type	The operation to perform to initialize the new tool integration. Use `new` to create a Git repo, `clone` to clone an existing repo into a new Git repo, `fork` to fork an existing Git repo, or `link` to link to an existing Git repo.