Add 5.5.0-gm and 5.5.0 changelog (#574)

* Update README and CHANGELOG

* Add script to automatically link issues inside README.md

* Add #573 to README

* Add documentation for regex used in link-readme-issues script

* Fix linking for Franz issues

* Add linking for GitHub users

* Link more contributors

* Link more contributors

* Fix information about "npm run link-readme" command

* Add recipes to changelog

* Add 5.5.0 changelog

1 files changed, 53 insertions, 0 deletions

diff --git a/src/scripts/link-readme.js b/src/scripts/link-readme.js
new file mode 100644
index 000000000..223451d84
--- /dev/null
+++ b/src/scripts/link-readme.js
@@ -0,0 +1,53 @@
+/**
+ * Script that automatically creates links to issues and users inside README.md
+ *
+ * e.g. "#123" => "[#123](https://github.com/getferdi/ferdi/issues/123)"
+ * and  "franz/#123" => "[franz#123](https://github.com/meetfranz/franz/issues/123)"
+ * and "@abc" => "[@abc](https://github.com/abc)"
+ */
+
+const fs = require('fs-extra');
+const path = require('path');
+
+console.log('Linking issues and PRs in README.md');
+
+const readmepath = path.join(__dirname, '../../', 'README.md');
+
+// Read README.md
+let readme = fs.readFileSync(readmepath, 'utf-8');
+
+let replacements = 0;
+
+// Replace Ferdi issues
+// Regex matches strings that don't begin with a "[", i.e. are not already linked and
+// don't begin with "franz", i.e. are not Franz issues, followed by a "#" and 3 digits to indicate
+// a GitHub issue, and not ending with a "]"
+readme = readme.replace(/(?<!\[|franz)#\d{3}(?!\])/gi, (match) => {
+  const issueNr = match.replace('#', '');
+  replacements += 1;
+  return `[#${issueNr}](https://github.com/getferdi/ferdi/issues/${issueNr})`;
+});
+
+// Replace Franz issues
+// Regex matches strings that don't begin with a "[", i.e. are not already linked
+// followed by a "franz#" and 3 digits to indicate
+// a GitHub issue, and not ending with a "]"
+readme = readme.replace(/(?<!\[)franz#\d{3,}(?!\])/gi, (match) => {
+  const issueNr = match.replace('franz#', '');
+  replacements += 1;
+  return `[franz#${issueNr}](https://github.com/meetfranz/franz/issues/${issueNr})`;
+});
+
+// Link GitHub users
+// Regex matches strings that don't begin with a "[", i.e. are not already linked
+// followed by a "@" and at least one word character and not ending with a "]"
+readme = readme.replace(/(?<!\[)@\w+(?!\])/gi, (match) => {
+  const username = match.replace('@', '');
+  replacements += 1;
+  return `[@${username}](https://github.com/${username})`;
+});
+
+// Write to file
+fs.writeFileSync(readmepath, readme);
+
+console.log(`Added ${replacements} strings`);