🐱Connect to GitHub

Source Code Management (SCM) Integration

Let’s get started with integrating GitHub with Resourcely. This step entails:

  • Adding the Resourcely GitHub App to your GitHub Organization

  • Configuring a Webhook for Resourcely

  • Choosing a Repository for Resourcely to Monitor

Adding the Resourcely App to your GitHub Organization

The Resourcely GitHub App is used to manage automated pull requests generated by Resourcely. Press the Connect to GitHub button to configure change management with GitHub.

You can now connect to GitHub by pressing the Connect to GitHub button. You will be redirected to the GitHub login.

After logging in, a new page will open up allowing you to select where you want to install the resourcelybot GitHub App. Here you should select the GitHub organization you will be integrating with Resourcely.

If you don't have permission to complete the installation of the Resourcely GitHub App, you can ask your admin for an installation ID.

Now that you have selected the appropriate GitHub Organization, you can further select which repositories you want Resourcely to watch.

The Resourcelybot GitHub App requires Read access to members and metadata, and Read and Write access to checks, code, issues, organization hooks, pull requests, and repository hooks. Note: Only the repository that will leverage Resourcely for infrastructure provisioning is required

Then press the Install & Authorize button to proceed. The Resourcely GitHub App is installed in your organization.

You can verify the App was installed by navigating to installed GitHub Apps settings. To learn more about GitHub Apps, see the following documentation:

Configuring a GitHub Webhook for Resourcely

GitHub Webhooks deliver notifications to an external web server whenever a defined event occurs on GitHub. To proceed to configure a GitHub webhook, click on the GitHub webhook Settings link and copy over the Payload URL and Webhook secret token provided in the following dialogue:

You must then configure the webhook with the following settings:

  • Content type: application/json

  • Which events would you like to trigger this webhook: Let me select individual events

    • Event triggers: Pull Requests, Pull Request Reviews

All other webhook settings can remain unchanged.

Once the webhook has been properly set up, scroll down to the bottom of the page and press the Add webhook button. You can now see that the webhook was added successfully.

Then head back to the Resourcely window and press the Continue button to proceed.

Choosing a Repository for Resourcely to Monitor

You must now choose the repository that hosts your Terraform code. This is the repository in which Resourcely will watch for commits and pull requests.

Press the Add a repository button and select a repository from the dropdown.

Only repositories you have access to in your GitHub Organization will be listed.

You can add more repositories to monitor by pressing the Add repository button.

To begin onboarding, only one repository is needed. However, you have the flexibility to add more later.

Press the Publish button to continue. You should now see that GitHub has been successfully integrated with Resourcely.

Note: If Auto-approve is toggled on, if guardrail validation passes on a pull-request it will be auto-approved.

Now that Resoucely has been fully integrated into GitHub, we must add the Resourcely CI/CD action to our project for Resourcely to validate our infrastructure resources. Proceed to Generate API Token

Last updated