Merge pull request #669 from mikepenz/feature/667

Introduce new RELEASE_DIFF placeholder

README.md

@@ -295,6 +295,7 @@ Table of supported placeholders allowed to be used in the `template` and `empty_
 | `${{REPO}}`                | The repository name of the repo the changelog was generated for                                    | x         |
 | `${{FROM_TAG}}`            | Defines the 'start' from where the changelog did consider merged pull requests                     | x         |
 | `${{TO_TAG}}`              | Defines until which tag the changelog did consider merged pull requests                            | x         |
+| `${{RELEASE_DIFF}}`        | Introduces a link to the full diff between from tag and to tag releases                            | x         |
 | `${{CATEGORIZED_COUNT}}`   | The count of PRs which were categorized                                                            |           |
 | `${{UNCATEGORIZED_COUNT}}` | The count of PRs and changes which were not categorized. No label overlapping with category labels |           |
 | `${{IGNORED_COUNT}}`       | The count of PRs and changes which were specifically ignored from the changelog.                   |           |

__tests__/transform.test.ts

@@ -429,4 +429,23 @@ it('Commit SHA-1 in commitMode', async () => {
   expect(resultChangelog).toStrictEqual(
     `## 🚀 Features\n\nsha1-3\nsha1-1\n\n## 🐛 Fixes\n\nsha1-3\nsha1-2\n\n`
   )
+})
+
+it('Release Diff', async () => {
+  const customConfig = Object.assign({}, DefaultConfiguration)
+  customConfig.template = "${{RELEASE_DIFF}}"
+
+  const resultChangelog = buildChangelog(pullRequestsWithLabels, {
+    owner: 'mikepenz',
+    repo: 'release-changelog-builder-action',
+    fromTag: 'v2.8.0',
+    toTag: 'v2.8.1',
+    failOnError: false,
+    commitMode: true,
+    configuration: customConfig
+  })
+
+  expect(resultChangelog).toStrictEqual(
+    `https://github.com/mikepenz/release-changelog-builder-action/compare/v2.8.0...v2.8.1`
+  )
 })

dist/index.js

@@ -1343,6 +1343,7 @@ function fillAdditionalPlaceholders(text, options) {
     transformed = transformed.replace(/\${{REPO}}/g, options.repo);
     transformed = transformed.replace(/\${{FROM_TAG}}/g, options.fromTag);
     transformed = transformed.replace(/\${{TO_TAG}}/g, options.toTag);
+    transformed = transformed.replace(/\${{RELEASE_DIFF}}/g, `https://github.com/${options.owner}/${options.repo}/compare/${options.fromTag}...${options.toTag}`);
     return transformed;
 }
 exports.fillAdditionalPlaceholders = fillAdditionalPlaceholders;

src/transform.ts

@@ -228,6 +228,10 @@ export function fillAdditionalPlaceholders(
   transformed = transformed.replace(/\${{REPO}}/g, options.repo)
   transformed = transformed.replace(/\${{FROM_TAG}}/g, options.fromTag)
   transformed = transformed.replace(/\${{TO_TAG}}/g, options.toTag)
+  transformed = transformed.replace(
+    /\${{RELEASE_DIFF}}/g,
+    `https://github.com/${options.owner}/${options.repo}/compare/${options.fromTag}...${options.toTag}`
+  )
   return transformed
 }