Resourcely Documentation
LoginSign Up
  • Get Started
    • 🎱What is Resourcely?
    • 👋Why Resourcely
    • 🏃Quickstart
      • Terraform policies integrated into CI
      • Remediate policy violations in existing infrastructure
      • Templates for generating Terraform
      • Glossary
  • Concepts
    • Foundry
      • Create Blueprints with Foundry
      • Creating Guardrails with Foundry
      • lmport Terraform Modules
    • Guardrails
      • Writing your own Guardrails
      • Editing Guardrails
      • Releasing Guardrails
      • Enabling Inactive Guardrails
      • Guardrails in Action
        • 🐱GitHub Actions
        • 🦊GitLab Pipelines
    • Campaigns
      • Get started with Campaigns
      • Creating Campaigns
      • Remediate Resources
      • Campaign Agent
        • State File Support
          • Amazon Simple Storage Service (S3)
          • Google Cloud Storage (GCS)
          • HCP Terraform
          • Spacelift
        • Running Campaigns with GitHub Actions and a Repo-Hosted State File
        • Running Campaigns Locally
    • Blueprints
      • Authoring Your Own Blueprints
      • Using Built-in Resourcely Blueprints
      • Configuring Global Contexts
      • Deep Linking
    • Resources
      • Provisioning Infrastructure
      • Editing Infrastructure
      • Shopping Cart
      • Config Roots and Environments
    • Other Features and Settings
      • Global Values
      • Global Context
      • Metrics
      • Resourcely-cli
      • Resourcely.yaml
      • VCS Proxy
      • Settings
        • User management
        • Company Information
        • Notification Settings
        • Change Management
          • 🐱Connect to GitHub
          • 🦊Connect to Gitlab
        • Generate API Token
    • ✨Production Setup
      • Single Sign-On (SSO)
        • Auth0
        • AWS Single Sign-On
        • Azure AD
        • Google Workspace
        • JumpCloud
        • Okta
        • Omnissa Workspace ONE (formerly VMware)
        • OneLogin
        • Ping Identity
        • Other SAML / OIDC Providers
      • Source Code Management
        • Page
        • 🐱GitHub
        • 🦊GitLab
        • Atlassian Bitbucket
        • Azure Repos
  • Tutorials and guides
    • Remediation Use Cases
      • Apply tags to resources for automating backups
      • Implement centralized logging
    • Blueprints Use Cases
      • Automate Data Pipeline Creation
      • Encryption for GCP
      • AWS Account Factory
      • Streamline and govern AI
      • IAM Factory
      • Cost optimization for FinOps
      • Guardrails for Terraform Modules
    • Using the Resourcely Terraform Provider
      • Setup Resourcely Provider
      • Blueprints
      • Guardrails
      • Global Context
  • Integrate
    • CI/CD & Terraform Runners
      • Atlantis
      • 🐟AWS CodeBuild
      • Azure Pipelines
      • Buildkite
      • CircleCI
      • CloudBees CI
      • Codefresh
      • Digger
      • Env0
      • 🎏GitHub Actions
        • 🐱Local Plan
          • 🐹AWS with OpenID Connect
        • 🐶Terraform Cloud Integration
      • 🦊GitLab Pipelines
      • Harness
      • 🗻HashiCorp Cloud Platform (formerly Terraform Cloud)
      • Jenkins
      • Octopus Deploy
      • Scalr
      • 🌌Spacelift
      • Terramate
      • 🌎Terrateam
    • Cloud Providers
      • 🌨️Amazon Web Services (AWS)
      • 🤓Google Cloud Platform (GCP)
        • Guardrail Gaunlet at Google Cloud Next 2025
      • 💾Microsoft Azure
      • Alibaba Cloud
      • Huawei Cloud
      • IBM Cloud
      • Oracle Cloud Infrastructure (OCI)
      • Tencent Cloud
      • VMware vSphere
    • Developer Portals
      • Atlassian Compass
      • Backstage
      • Cortex
      • Harness IDP
      • Home grown internal developer portals
      • OpsLevel
      • Port
      • Roadie
    • ITSM
      • Atlassian Jira
      • FreshWorks
      • ServiceNow ITSM
      • ZenDesk
    • CSPM
      • Wiz
    • More Terraform Provider Integrations
      • 🚂ConductorOne Provider
      • Databricks Provider
      • Kubernetes Provider
      • 🐕Datadog Provider
      • ❄️Snowflake Provider
Powered by GitBook
On this page
  • Adding the Resourcely App to your GitHub Organization
  • Configuring a GitHub Webhook for Resourcely
  • Choosing a Repository for Resourcely to Monitor
  1. Concepts
  2. Other Features and Settings
  3. Settings
  4. Change Management

Connect to GitHub

Source Code Management (SCM) Integration

PreviousChange ManagementNextConnect to Gitlab

Last updated 9 months ago

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.

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.

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

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

🐱
navigating to installed GitHub Apps settings
LogoGitHub Apps documentation - GitHub DocsGitHub Docs
GitHub Apps documentation
Configure Change Management Home
Connect to GitHub
Install resourcelybot GitHub App
Install & Authorize resourcelybot
Installed GitHub Apps
Create GitHub Webhook
GitHub Webhook setup page
GitHub Webhook event triggers
Active Webhooks
Choose a repository
Select a repository from the list
Repository selected
GitHub integrated into Change Managment