ci: add release automation (#7656)

2021-10-27 02:53:46 +02:00
parent 626fad2e71
commit d3e914280d
13 changed files with 2227 additions and 2006 deletions
--- a/release.config.js
+++ b/release.config.js
@@ -0,0 +1,114 @@
+/**
+ * Semantic Release Config
+ */
+
+const fs = require('fs').promises;
+const path = require('path');
+
+// Get env vars
+const ref = process.env.GITHUB_REF;
+const serverUrl = process.env.GITHUB_SERVER_URL;
+const repository = process.env.GITHUB_REPOSITORY;
+const repositoryUrl = serverUrl + '/' + repository;
+
+// Declare params
+const resourcePath = './.releaserc/';
+const templates = {
+  main: { file: 'template.hbs', text: undefined },
+  header: { file: 'header.hbs', text: undefined },
+  commit: { file: 'commit.hbs', text: undefined },
+  footer: { file: 'footer.hbs', text: undefined },
+};
+
+// Declare semantic config
+async function config() {
+
+  // Get branch
+  const branch = ref.split('/').pop();
+  console.log(`Running on branch: ${branch}`);
+
+  // Set changelog file
+  const changelogFile = `./changelogs/CHANGELOG_${branch}.md`;
+  console.log(`Changelog file output to: ${changelogFile}`);
+
+  // Load template file contents
+  await loadTemplates();
+
+  const config = {
+    branches: [
+      'release',
+      { name: 'alpha', prerelease: true },
+      { name: 'beta', prerelease: true },
+      'next-major',
+      // Long-Term-Support branches
+      // { name: 'release-1', range: '1.x.x', channel: '1.x' },
+      // { name: 'release-2', range: '2.x.x', channel: '2.x' },
+      // { name: 'release-3', range: '3.x.x', channel: '3.x' },
+      // { name: 'release-4', range: '4.x.x', channel: '4.x' },
+    ],
+    dryRun: false,
+    debug: true,
+    ci: true,
+    tagFormat: '${version}',
+    plugins: [
+      ['@semantic-release/commit-analyzer', {
+        preset: 'angular',
+        releaseRules: [
+          { type: 'docs', scope: 'README', release: 'patch' },
+          { scope: 'no-release', release: false },
+        ],
+        parserOpts: {
+          noteKeywords: [ 'BREAKING CHANGE', 'BREAKING CHANGES', 'BREAKING' ],
+        },
+      }],
+      ['@semantic-release/release-notes-generator', {
+        preset: 'angular',
+        parserOpts: {
+          noteKeywords: ['BREAKING CHANGE', 'BREAKING CHANGES', 'BREAKING']
+        },
+        writerOpts: {
+          commitsSort: ['subject', 'scope'],
+          mainTemplate: templates.main.text,
+          headerPartial: templates.header.text,
+          commitPartial: templates.commit.text,
+          footerPartial: templates.footer.text,
+        },
+      }],
+      ['@semantic-release/changelog', {
+        'changelogFile': changelogFile,
+      }],
+      ['@semantic-release/npm', {
+        'npmPublish': true,
+      }],
+      ['@semantic-release/git', {
+        assets: [changelogFile, 'package.json', 'package-lock.json', 'npm-shrinkwrap.json'],
+      }],
+      ['@semantic-release/github', {
+        successComment: getReleaseComment(),
+        labels: ['type:ci'],
+        releasedLabels: ['state:released<%= nextRelease.channel ? `-\${nextRelease.channel}` : "" %>']
+      }],
+    ],
+  };
+
+  return config;
+}
+
+async function loadTemplates() {
+  for (const template of Object.keys(templates)) {
+    const text = await readFile(path.resolve(__dirname, resourcePath, templates[template].file));
+    templates[template].text = text;
+  }
+}
+
+async function readFile(filePath) {
+  return await fs.readFile(filePath, 'utf-8');
+}
+
+function getReleaseComment() {
+  const url = repositoryUrl + '/releases/tag/${nextRelease.gitTag}';
+  const comment = '🎉 This change has been released in version [${nextRelease.version}](' + url + ')';
+  return comment;
+}
+
+module.exports = config();