Skip to content

7. autolinks.md

Latest commit

 

History

History
69 lines (56 loc) · 2.63 KB

7. autolinks.md

File metadata and controls

69 lines (56 loc) · 2.63 KB

Configuring autolink references

To help streamline your workflow, you can use the REST API to add autolinks to external resources like JIRA issues and Zendesk tickets. For more information, see "Configuring autolinks to reference external resources."

Note

This section can be applied to repos/<file>.yml or suborgs/<file>.yml. It will most commonly appear in the individual repos though.

Example autolink definition

# These settings are synced to GitHub by https://github.com/FICO-1ES/1es-safe-settings
variables:
  - name: MY_AWESOME_VAR
    value: '845705'
  - name: my_lowercase_var
    value: I have spaces

AutoLink API Spec

Tip

GitHub's API documentation defines these inputs and types:

  1. Create an autolink reference for a repository

 key_prefix string ${\text{\color{orange}Required}}$

Either true to enable issues for this repository or false to disable them.

Default: true

 
autolinks:
  - key_prefix: JIRA-
    url_template: https://jira.example.com/browse/JIRA-<num>
...

 url_template string ${\text{\color{orange}Required}}$

Either true to enable issues for this repository or false to disable them.

Default: true

 
autolinks:
  - key_prefix: JIRA-
    url_template: https://jira.example.com/browse/JIRA-<num>
...

 is_alphanumeric boolean 

Whether this autolink reference matches alphanumeric characters. If true, the <num> parameter of the url_template matches alphanumeric characters A-Z (case insensitive), 0-9, and -. If false, this autolink reference only matches numeric characters.

Default: true

 
autolinks:
  - key_prefix: JIRA-
    url_template: https://jira.examole.com/browse/JIRA-<num>
    is_alphanumeric: false
...