Getting StartedSetup GitHub Integration

Set Up GitHub Integration

DevGuard integrates with GitHub to provide a seamless experience for developers. This guide will walk you through the steps to set up the integration.

Steps

Go to Organization Settings & Click on Add a GitHub App

Go to Organization Settings

Click on Install GitHub App, Then Authorize Your GitHub Account

Install GitHub App

Choose the Organization or User You Want to Integrate with DevGuard

Choose the Organization or User

Select Repositories to Integrate with DevGuard

You can choose all repositories or specific repositories. Then, click on Install. Select Repositories

If the integration is successful, you will see your chosen user or organization in the organization settings. You can change the settings at any time by clicking on Manage GitHub App. You can also add more repositories by clicking on Add a GitHub App. the integration is successful

Select Your Corresponding GitHub Project

If the integration is successful, you will see your chosen GitHub project in the asset settings. You can change the settings at any time by clicking on Change. You can remove the integration by clicking on Remove Connection. The integration is successful

Create a Personal Access Token

Go to the security control center of the asset and click on Create Personal Access Token. Then copy the token.

You can find more information about the DevGuard Personal Access Token here.

Create a Personal Access Token

Store the Token in Your GitHub Repository Secrets

For instructions on storing the token in your GitHub repository secrets, refer to the GitHub documentation.

Add a Pipeline Configuration File

You can now copy the code snippet and add it to your pipeline configuration file.

If you don’t have a pipeline configuration file, create one by adding a new file in the root directory of your repository. The file should be located in the .github/workflows/ directory and have a .yml extension. Refer to the GitHub documentation for more details on creating a pipeline configuration file.

Finally, push the changes to your repository.
Add a Pipeline Configuration File

You have successfully integrated your GitHub repository with DevGuard. You can now start using DevGuard to secure your codebase.

Next Steps

Manage your security settings and monitor your codebase using DevGuard. For more information, refer to the Mange Risks guide.