GitHub integration with DevOps Change Velocity
Summarize
Summary of GitHub Integration with DevOps Change Velocity
The GitHub integration with DevOps Change Velocity enables users to connect their GitHub instances for effective change traceability and automation. It supports Plan, Code, and Orchestration capabilities across both GitHub and GitHub Enterprise, allowing for the discovery of repositories, plans, and pipeline definitions.
Show less
Key Features
- Connect: Discover repositories and configure pipelines by linking your GitHub instance to DevOps Change Velocity.
- Configure Notifications: Enable real-time notifications for commits, work items, and pipelines through automated Webhooks in GitHub, facilitating the creation of change policies.
- Permission Requirements: Base permissions of Read and Admin are necessary for discovering and configuring repositories within an organization.
- Authentication Methods: Options include Basic authentication and OAuth 2.0, allowing the use of custom actions from the GitHub marketplace and workflow secrets.
- Custom Actions: ServiceNow provides custom actions in the GitHub Marketplace for orchestration, enabling interaction with workflows.
Key Outcomes
By integrating GitHub with DevOps Change Velocity, customers can enhance their change management processes, automate notifications, and streamline the workflow management experience. The integration supports a structured onboarding process through the workspace, Service Catalog, or Classic experience, ensuring that users can efficiently configure and manage their GitHub resources.
Connect to your GitHub instance to discover repositories, plans, pipeline definitions and configure real-time notifications or polling to enable change traceability and automation.
GitHub integration overview
DevOps Change Velocity supports Plan (Plans), Code (Repository) and Orchestration (Actions) capabilities for the GitHub tool.
Both GitHub and GitHub Enterprise are supported.
- Connect: Discover repositories, plans, and pipeline definitions by connecting your GitHub instances to DevOps Change Velocity.
- Configure: Enable sending real-time notifications for commits, work items, and pipelines by automatically creating a Webhook (push, issues, and workflow_job) in GitHub so that this data can be used to create change policies.
- Discover: Base permission of Read.
- Configure: Base permission of Admin.
For repositories under an organization, you must not have the same repository configured in more than one tool on an instance. If the same repository is configured for multiple tools, then data is associated with a random tool as part of notifications events. If you want to configure the same repository in a different tool, you must delete the webhooks created from the first tool, untrack the repository under that tool, and then configure the same repository in the different tool.
Authentication methods
- Basic authentication
If you connect your GitHub instance with basic auth, you can use the custom actions from the GitHub marketplace. GitHub environments aren’t supported for basic auth connection.
- OAuth 2.0 credentials
- If you connect your GitHub instance with OAuth 2.0 credentials for Authorization code, you can use the custom actions from the GitHub marketplace and create secrets to use in workflows. For more information, see OAuth 2.0 credentials for GitHub Apps - Authorization Code.
- If you connect your GitHub instance with OAuth 2.0 credentials for GitHub Apps - JWT, you can use the custom actions from the GitHub marketplace, create secrets to use in workflows, and GitHub environments to deploy to an environment. For more information, see OAuth 2.0 credentials for GitHub Apps - JWT. For GitHub repositories under an organization, only one organization can be installed per tool (i.e - One GitHub App can be installed with One GitHub Org and with One GitHub tool). If you want to add more organizations, you can create separate tools and apps.
Custom actions by ServiceNow are available in GitHub Marketplace for the orchestration capability, to push information from Actions (workflows) and to pause or resume workflows from DevOps Change Velocity. For more information on custom actions, see ServiceNow DevOps custom actions from GitHub marketplace.
To capture the workflow data in DevOps Change Velocity, you must configure Secrets in your GitHub tool. For more information, see GitHub Actions configurations.
There are a few limitations for GitHub Actions support, see GitHub Actions configurations.
Get started
Use one of the following options to onboard GitHub. For a guided experience, use the workspace to onboard a tool. Alternatively, you can use the Service Catalog or Classic experience.