Note: While the term 'pull request' is used throughout this documentation, the equivalent terminology in GitLab is 'merge request'.

Setting up Nexus IQ for SCM

Required Token Permissions

Steps to Use SCM Features

Follow the steps listed below to enable automated pull requests and automated commit feedback:

Optional: Configure Git Client

Git repository cloning is required for the following IQ for SCM features:

• Automated Pull Requests,
• Pull Request Commenting,
• Instant Risk Profile
• Continuous Risk Profile.

IQ for SCM features work without any additional software by using the bundled JGit application library. JGit is a Java implementation of git that supports all git functionality necessary for IQ for SCM.

JGit does not support two git clone features that can improve performance:  shallow clone  and  sparse checkout. Shallow clones allow us to clone the minimal amount of git history.  Sparse checkouts allow us to checkout only the necessary files to enable IQ for SCM features. These two git clone features provide large disk-space savings, increased time performance, and reduced network traffic.

If a native git client is installed and available on the system path, then it will be preferred over JGit. If you are having problems with native git, this behavior can be overridden by forcing the usage of java git (JGit). Note that native git is required in order to use SSH for git operations.

If a native git client is installed but is not on the system path, the fully qualified path to the executable can also be specified.

In IQ Server Release 140 and later

NEW IN RELEASE 140

Use the source control configuration REST API.

In IQ Server Release 139 and prior

In your config.yml file you may specify the gitImplementation and/or the gitExecutable.

sourceControl:
  gitImplementation: java
  gitExecutable: /usr/bin/git

Minimum Git Client Version

If the native git client is installed and available on the path it is preferred. The minimum git version that has been tested is version 2.16.0.

SSH for Git Operations

NEW IN IQ SERVER RELEASE 126

SSH can now be used for Git operations such as the clone, fetch, and push. To enable SSH, select the option Use SSH for Git Operations in the configuration screen. 

On Root Organization:

On a Child Organization or an Application:

SSH requires native git and a properly configured SSH key that is available to IQ. Configuring an SSH key is beyond the scope of this help document. Please consult your security or operations team.

Some important notes

• Using a passwordless SSH key is the simplest option, and requires no extra configuration. However this is considered the least secure option as anyone who has access to the system can then access what the SSH key can access. Only use this in a fully trusted environment.
• The Git for Windows installer provides an option to choose a bundled version of SSH, or to use an external (or previously installed version). If the former is chosen then SSH will only be available in Git Bash meaning that IQ would have to be running in that context. If the latter is chosen, then the SSH key should be configured per the chosen implementation (e.g. OpenSSH for Windows, Putty)
• On Linux most traditional setups should work as long as the context of the SSH agent is available to IQ. Sometimes this will involve ensuring that the SSH_AUTH_SOCK environment variable is properly set and available.

Protecting the Target Branch

In some source control systems, the target branch can be protected from merges with a failing IQ Policy Evaluation as described in the appropriate section below for your SCM system.

Protecting the Target Branch in Azure DevOps

To protect your target branch on Azure DevOps, you will need to create and configure a Branch Policy.

1. Navigate to Repos → Branches in the left menu, and find the branch that you want to configure the policy on (typically main or  develop ). From the context menu, select the  Branch policies  option

2. Scroll down to find  Status checks. Select the  +  button

3. Fill the form with the next information

Status to check * → Security/IQ Policy Evaluation

Policy requirement → Required

The rest of the values can use the default options

Here is a link with more information about how to configure a branch policy in AzDO:

https://docs.microsoft.com/en-us/azure/devops/repos/git/pr-status-policy?view=azure-devops

Protecting the Target Branch in Bitbucket Cloud

Bitbucket Cloud has two options for protecting the target branches from merges with a failing IQ Policy Evaluation.

1. For all accounts, users get notified when they don't have that number of successful builds for the most recent commit.
2. For premium accounts, users won't be able to merge if their pull request has unresolved merge checks

Click Settings, then Branch permissions, then Add a branch permission.

In the Add a branch permission dialog, select the desired branch option as well as the desired write access and merge access. In the Merge checks section select the option Check the last commit for at least 1 successful build and no failed builds.

This will inform users that the requirements are not fulfilled when trying to merge, but it will not prevent the merge.

Premium accounts have the additional ability to prevent the merge.

This will prevent users from merging a pull request with a failed build.

See these pages for more information:

• https://confluence.atlassian.com/bitbucket/suggest-or-require-checks-before-a-merge-856691474.html
• https://bitbucket.org/blog/protect-your-master-branch-with-merge-checks

Protecting the Target Branch in Bitbucket Server

The target branch can be protected from merges with a failing IQ Policy Evaluation by configuring a Merge check. Merge checks are a repository-wide setting and can also be enforced for all repositories.

Click the drop-down next to Minimum successful builds and choose Enabled. In the next dialog choose the desired minimum number of successful builds.

See this page for more information: https://confluence.atlassian.com/bitbucketserver/checks-for-merging-pull-requests-776640039.html

Protecting the Target Branch in GitHub

The target branch can be protected from merges with a failing IQ Policy Evaluation by configuring a branch protection rule in the repository's settings under Branches.

In the branch protection rule:

• Add a new rule or edit an existing rule. 
• Check Require status checks to pass before merging. 
• Check IQ Policy Evaluation.
• Save Changes

493

See this page for more information: https://help.github.com/en/github/administering-a-repository/enabling-required-status-checks

Protecting the Target Branch in GitLab

GitLab projects can be configured to prevent merge requests from being merged if their pipeline did not succeed.  A failing IQ policy evaluation will cause the pipeline to fail, which in turn will prevent the merge request from being able to be merged.  You can enable this feature via the project settings as shown below.  See this page for more information:  https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html#only-allow-merge-requests-to-be-merged-if-the-pipeline-succeeds

Testing the Configuration

NEW IN IQ SERVER RELEASE 97

To test the configuration for pull request support, click the 'Test Configuration' button in the application source control configuration screen.

The 'Test Configuration' button is available once any changes have been saved with the 'Update' button.

There are three checks that are run:

• Is the configuration complete? This check ensures that are required configuration options are in place. This includes all required options, some of which may be inherited from the organization.
• Is the repository private? Repositories must be private or internal to enable all SCM features.  Support for public repositories is limited.
• Does the token have sufficient permissions? This check will ensure the provided token has the necessary permissions or privileges to create pull requests. See the required token permissions section above for full details.