Onboard GitHub to DevOps Change Velocity — Service Catalog
- UpdatedAug 1, 2024
- 2 minutes to read
- Xanadu
- DevOps
Onboard GitHub to DevOps Change Velocity — Service Catalog
Create, connect, discover, and configure your GitHub instance using the ServiceNow Service Catalog.
Before you begin
Role required: sn_devops.admin or sn_devops.tool_owner
Procedure
-
Navigate to All > Service Catalog > Catalog Definitions > Maintain Items and search for DevOps.
Note: You can also access the service catalog from Employee Center or Service portal.
- From the DevOps catalog items, select and activate DevOps App Onboarding and DevOps Tool Onboarding.
- After activating, select DevOps Tool Onboarding and select Try it.
-
In the DevOps Tool Onboarding form, enter the tool details:
Field Description Tool name Name for your GitHub integration. Tool integration Select GitHub or GitHub Enterprise. Tool URL Enter https://api.github.com. Credential type Select Basic Auth or OAuth, depending on the credentials you're using. - For Basic Auth, enter the username and password or access token.
- For OAuth, enter the credentials.
Use MidServer Optional. Select MID Server for an on-premises tool that is attached to a MID Server. Application is automatically set to DevOps and capability is set to REST. Note: For GitHub Enterprise Server (on-premises instance), OAuth is not supported if you are connecting using a MID server.For a list of all the permissions required on the credentials for connecting to GitHub, see GitHub permissions in Permissions required for DevOps tools.
-
Select Order Now.
A request is created. When the request is approved, the tool is created, connected, and discovered.
- From the DevOps catalog items, select DevOps App Onboarding.
-
In the DevOps App Onboarding form, enter the details:
Are you creating a new app or adding to an existing one? Select from the options whether to create a new app or use an existing app. App Enter the name for the app that you're creating or using. Onboarding pipelines Leave empty. Onboarding repositories Enter the connected GitHub tool name. Repositories Select the repositories for which you want to configure webhooks and import historical data. Note: Workflows associated with the repositories will also be imported.Import from and Import to Select the dates for which you want to import the data. By default, the last 30 days are selected. You can choose to import data for a maximum of 90 days. Do you wish to configure webhook for the tool? Select the check box if you want to configure webhooks for the selected repositories. Onboarding plans Leave empty. -
Select Order Now.
A request is created. When the request is approved, the repository and pipeline objects are associated to the app record and webhooks are configured for real-time tracking. Historical data is imported for the selected repositories and the associated workflows. The Track field is automatically enabled for imported repositories and pipelines. For repositories the Track file changes is also automatically enabled.