Generic Ticketing

Generic ticketing integration

If you use a ticketing system on your project, sfdx-hardis can use it to enrich its integrations.

sfdx-hardis automatically analyzes commits and Pull Request descriptions to collect tickets and build their URLs.

You need to define two properties in .sfdx-hardis.yml, or two environment variables in your CI/CD configuration.

It is recommended to store these properties in .sfdx-hardis.yml, so that the VS Code SFDX Hardis extension can use them for UI features.

Regular expression used to detect your ticketing system identifiers in commit and Pull Request texts.

You can use https://regex101.com/ to check your Regular Expression.

Example: ([R|I][0-9]+-[0-9]+) to detect EasyVista references, which can look like I240103-0133 or R230904-0026

Template string used to build a hyperlink from a ticket identifier.

It must contain a {REF} segment, which is replaced by the ticket identifier.

Example: https://instance.easyvista.com/index.php?ticket={REF}

If you are using GitLab, you need to update the Merge Request settings.

Go to Project -> Settings -> Merge Requests

Update Merge Commit Message Template with the following value:

%{title} Merge branch '%{source_branch}' into '%{target_branch}'

%{issues}

See merge request %{reference}

%{description}

%{all_commits}

Update Squash Commit Message Template with the following value:

%{title} Merge branch '%{source_branch}' into '%{target_branch}'

%{issues}

See merge request %{reference}

%{description}

%{all_commits}

This integration uses the following variables, which must be available from the pipelines or in .sfdx-hardis.yml: