GitHub Agents Setup
- Updated On 18 Nov 2020
- 2 Minutes To Read
Choosing your Agent
There are two GitHub Agents you can choose from:
- Install the CTO.ai GitHub App
- Send Events from GitHub Actions
1. Installing the CTO.ai GitHub App
With the GitHub app, you will be able to see direct actions taken on your projects like push events, merged Pull Requests, and opened Issues, just to name a few. In the near future we will be providing further insights and team synergy metrics to get you on the right foot the first time everytime.
Who can install the GitHub App
Any GitHub user can request to have the GitHub App installed in an organization they are part of. Only organization Owners are able to complete the installation process. This requires the organization Owner to also have an account with CTO.ai.
What are we collecting?
During the authentication and authorization process, you have the ability to listen to events for the whole organization or only for a collection of repositories in your organization. See the full list of webhooks from GitHub.
A soon to be released feature will allow you to pull a limited set of events from before our Agent was installed. This will be used to create a baseline of Insights. To see the event types we will be pulling, check out this list of events from GitHub.
How to setup
- Login to the CTO.ai Portal
- Click on the Install Workflow Agent button
- Click on the Install button on the top right
- Our Agent can be installed into multiple organizations so the button may say Configure if it is already installed in an organization you are a part of
- Choose the user or organization to install the CTO.ai Agent to
- Note: this user needs to be an Owner of the GitHub Organization to have sufficent privlages to complete the install
- Select whether to collect events from the entire organization or only selected repositories
- Upon returning to CTO.ai, you need to associate the Agent installation with a team. Data from GitHub will be associated with the team and will require selecting that team to view Insights.
- A new team will include you and a special GitHub user
- An existing team will have a special GitHub user added to it
2. Sending Events from GitHub Actions
- Install the CTO.ai CLI
- Get a Secret Key and ClientID
- While we are in Beta Contact Us and we'll send you your new credentials
- Generate the Token
How to setup
You can use HTTP requests to send Events from any DevOps tool to the CTO.ai Events API. Certain platforms such as GitHub Actions and CircleCI have pre-built integrations to make this even easier!
The CTO.ai GitHub Action allows you to easily flow all your metrics from your GitHub Action-based pipelines into the CTO.ai Insights Dashboard. Just drop the CTO.ai Workflow Agent into your
For more control over the Events you send, the CTO.ai GitHub Action also allows you to instrument your existing GitHub Workflows with calls to CTO.ai. Here, you can send any LifeCycle or Custom Event and manually place them at the point in your Workflow that makes the most sense. For more information on the types of LifeCycle and Custom Events you can send and track check out our Delivery Events and LifeCycle Events
- More information on CTO.ai GitHub Action integration can be found at the CTO.ai GitHub Action ReadMe.