In this page

Typical problems and solutions

Commit policy configuration problems

I see the ".commitpolicy.yml: Failed to read the configuration file from the branch <foo>!" message.

Make sure the ".commitpolicy.yml" configuration file exists in the root directory of the branch "foo".

I see the ".commitpolicy.yml: The configuration file is too large!" message.

The size of the ".commitpolicy.yml" configuration file is limited. Under normal circumstances, you shouldn't encounter this issue. If you do, it's likely that the file contains excessive or unnecessary content, which should be removed to stay within the size limit.

I see the ".commitpolicy.yml: Failed to parse the configuration file!" message.

Check the YAML syntax of the .commitpolicy.yml configuration file for indentation errors, missing colons, or other formatting issues. The error message from the parser often points to the exact line or problem in the file - try to interpret it carefully. If needed, you can use an online YAML validator to help identify issues.

I see the ".commitpolicy.yml: foo.bar: Invalid option! (use "true" or "false")" message.

Update the foo.bar parameter in the .commitpolicy.yml configuration file to use either true or false. Only these two boolean values are accepted (case-insensitive).

I see the ".commitpolicy.yml: foo.bar: Invalid value!" message.

Correct the value of the foo.bar parameter in the ".commitpolicy.yml" configuration file based on the expected format or allowed values defined in the configuration reference. Be sure to wrap all parameter values in quotes to avoid parsing errors caused by special characters in YAML.

I see the ".commitpolicy.yml: foo.bar: Unsupported parameter! (fix the name or remove)" message.

Remove or correct the foo.bar parameter in the ".commitpolicy.yml" configuration file, as it is not recognized by the app. The most likely reason is a typo in the name of a supported parameter.

I see the ".commitpolicy.yml: No parameter defined!" message.

Add at least one valid configuration parameter to the ".commitpolicy.yml" configuration file to define the commit policy.

I see the ".commitpolicy.yml: vcs-connection.id: Value must not be blank!" message.

Set a valid vcs-connection.id value in the ".commitpolicy.yml" configuration file. The corresponding VCS connection must be configured on the VCS Connections screen provided by the Better Commit Policy for Jira Cloud app.

I see the ".commitpolicy.yml: vcs-connection.id: Invalid VCS connection ID <abc123>!" message.

Check whether the VCS connection configuration at the vcs-connection.id value in the ".commitpolicy.yml" configuration file exists. The corresponding VCS connection must be configured on the VCS Connections screen provided by the Better Commit Policy for Jira Cloud app.

I see the ".commitpolicy.yml: vcs-connection.id: VCS connection <abc123> is disabled or it contains an unexpected workspace URL!" message.

Check whether the VCS connection configuration at the vcs-connection.id value in the ".commitpolicy.yml" configuration file is enabled and matches your Bitbucket workspace URL . The corresponding VCS connection must be configured on the VCS Connections screen provided by the Better Commit Policy for Jira Cloud app.

I see the ".commitpolicy.yml: vcs-connection.id: You have more VCS connections than the maximum 5 allowed!" message.

Reduce the number of VCS connections by deleting unused ones.

I see the "Enable the "Commit policy satisfied" custom merge check for this repository (if not already) and re-run the check." message.

Enable custom merge checks, it should automatically run the check for all existing pull requests. If it doesn't, run the merge check manually.

I see the "Destination branch <foo> not found!" message.

Make sure the pull request’s destination branch, "foo", exists in the repository and hasn’t been deleted or renamed. If needed, update the pull request to use a valid destination branch.

I see the "Check blocked due to too many commits in this pull request!" message.

The number of commits in a pull request is limited for several reasons. Reduce the number of commits to check by squashing them, splitting the pull request into smaller ones, or skipping the check by adding #skipcheck_pr (or your custom skip pattern) to the pull request title.

I see the "Check did not complete in time. Try again later (or with fewer commits)." message.

If the check times out, it’s most likely due to a temporary slowdown in the environment (Jira Cloud, Bitbucket, or Atlassian Forge). Wait a few minutes and try running the check again. If the check continues to fail after a few retries, try reducing the number of commits in the pull request and run the check again.

Questions?

Ask us any time.