Example: Issue links

To link issues to an issuetracker (e.g. Jira or GitHub) you have 2 options:

Using issueBaseUrl (simple)

See also → API-Ref

HTML

<release-notes-displayer 
    issueBaseUrl="http://localhost/issue"
    data='[
    {
        "notes": [
            "[Changed] Something changed #444"
        ],
        "version": "1.0.1"
    },
    {
        "notes": [
            "[Added] Added something #1",
            "[Fixed] Fixed something #2",
            "[Improved] Improved something #FakeNumber",
            "[Removed] Removed something #3"
        ],
        "version": "1.0.0"
    }]' />

Using issueLinkGenerator (more complex - more options)

See also → API-Ref

HTML

<release-notes-displayer 
    id='rn'
    data='[
    {
        "notes": [
            "[Changed] Something changed #99999999"
        ],
        "version": "1.0.1"
    },
    {
        "notes": [
            "[Added] Added something #1",
            "[Fixed] Fixed something #2",
            "[Improved] Improved something #FakeNumber #-3",
            "[Removed] Removed something #3"
        ],
        "version": "1.0.0"
    }]' />

JavaScript

// Find links in the format I-{number}
document.getElementById('rn').issueMatching = /(I\-\d+)/i;

// Build custom link
document.getElementById('rn').issueLinkGenerator = (issueKey) => {
    var normalizedIssueKey = issueKey.substring(2);
    // If the issueNumber is greater than 1 Mio then skip
    if(normalizedIssueKey > 1_000_000) {
        return null;
    }

    return "http://localhost/i/" + normalizedIssueKey + "/overview?theme=dark";
};