aberlaas-setup 2.10.0

package/LICENSE

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) Tim Carry (tim@pixelastic.com)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/lib/circleci.js

@@ -0,0 +1,60 @@
+import { _ } from 'golgoth';
+import { consoleError, consoleInfo, consoleSuccess } from 'firost';
+import circleCiHelper from './helpers/circleci.js';
+import githubHelper from './helpers/github.js';
+
+export default {
+  /**
+   * Attempt to automatically follow the repo in CircleCI if possible, otherwise
+   * display the link to follow it manually
+   * @returns {boolean} True if enabled, false otherwise
+   */
+  async enable() {
+    const { username, repo } = await githubHelper.repoData();
+    const projectUrl = `https://app.circleci.com/pipelines/github/${username}/${repo}`;
+    const followUrl = `https://app.circleci.com/projects/project-setup/github/${username}/${repo}`;
+
+    // Fail early if no token available
+    if (!circleCiHelper.hasToken()) {
+      this.__consoleError(
+        `[circleci]: No CIRCLECI_TOKEN found, please visit ${followUrl} to enable manually.`,
+      );
+      return false;
+    }
+
+    // Do nothing if already enabled
+    if (await this.isEnabled()) {
+      this.__consoleInfo(`CircleCI already enabled: ${projectUrl}`);
+      return true;
+    }
+
+    // Follow the repo
+    await this.followRepo();
+    this.__consoleSuccess(`CircleCI enabled: ${projectUrl}`);
+    return true;
+  },
+  /**
+   * Check if CircleCI is already enabled for this project
+   * @returns {boolean} True if already enabled, false otherwise
+   */
+  async isEnabled() {
+    // There is no endpoint to check if a project is followed or not, so we get
+    // the list of all followed projects and check if the current one is in it
+    const allProjects = await circleCiHelper.api('projects');
+    const { username, repo } = await githubHelper.repoData();
+    const thisProject = _.find(allProjects, { username, reponame: repo });
+    return !!thisProject;
+  },
+  /**
+   * Automatically follow the repo on CircleCI.
+   */
+  async followRepo() {
+    const { username, repo } = await githubHelper.repoData();
+    await circleCiHelper.api(`project/github/${username}/${repo}/follow`, {
+      method: 'post',
+    });
+  },
+  __consoleInfo: consoleInfo,
+  __consoleSuccess: consoleSuccess,
+  __consoleError: consoleError,
+};

package/lib/github.js

@@ -0,0 +1,42 @@
+import { consoleError, consoleSuccess } from 'firost';
+import githubHelper from './helpers/github.js';
+
+export default {
+  /**
+   * Configure the GitHub repo with default settings:
+   * - Do not enable merge commits on PR
+   * - Automatically delete branches after PR merge
+   * @returns {boolean} True if enabled, false otherwise
+   */
+  async enable() {
+    const { username, repo } = await githubHelper.repoData();
+    const repoUrl = `https://github.com/${username}/${repo}`;
+    const manualUrl = `${repoUrl}/settings`;
+
+    // Fail early if no token available
+    if (!githubHelper.hasToken()) {
+      this.__consoleError(
+        `[github]: No GITHUB_TOKEN found, please visit ${manualUrl} to configure manually.`,
+      );
+      return false;
+    }
+
+    const settings = {
+      allow_merge_commit: false,
+      allow_rebase_merge: true,
+      allow_squash_merge: true,
+      delete_branch_on_merge: true,
+    };
+
+    await githubHelper.octokit('repos.update', {
+      owner: username,
+      repo,
+      ...settings,
+    });
+
+    this.__consoleSuccess(`GitHub repo configured: ${repoUrl}`);
+    return true;
+  },
+  __consoleSuccess: consoleSuccess,
+  __consoleError: consoleError,
+};

package/lib/main.js

@@ -0,0 +1,52 @@
+import { _ } from 'golgoth';
+import github from './github.js';
+import circleci from './circleci.js';
+import renovate from './renovate.js';
+
+export default {
+  /**
+   * Enable external services.
+   * Will enable CircleCI, GitHub and Renovate by default.
+   * @param {object} cliArgs CLI Argument object, as created by minimist
+   */
+  async run(cliArgs = {}) {
+    const defaultServices = {
+      circleci: true,
+      renovate: true,
+      github: true,
+    };
+    const cliServices = _.omit(cliArgs, ['_']);
+    const servicesToEnable = {
+      ...defaultServices,
+      ...cliServices,
+    };
+
+    if (servicesToEnable.github) {
+      await this.github();
+    }
+    if (servicesToEnable.circleci) {
+      await this.circleci();
+    }
+    if (servicesToEnable.renovate) {
+      await this.renovate();
+    }
+  },
+  /**
+   * Configure GitHub
+   */
+  async github() {
+    await github.enable();
+  },
+  /**
+   * Enable CircleCI
+   */
+  async circleci() {
+    await circleci.enable();
+  },
+  /**
+   * Enable renovate
+   */
+  async renovate() {
+    await renovate.enable();
+  },
+};

package/lib/renovate.js

@@ -0,0 +1,54 @@
+import { consoleError, consoleSuccess } from 'firost';
+import githubHelper from './helpers/github.js';
+
+export default {
+  renovateId: 2471197,
+  /**
+   * Returns the GitHub repository Id
+   * @returns {number} Repository Id
+   */
+  async getRepositoryId() {
+    const { username, repo } = await githubHelper.repoData();
+    const { id } = await githubHelper.octokit('repos.get', {
+      owner: username,
+      repo,
+    });
+    return id;
+  },
+  /**
+   * Attempt to automatically add the current repo to renovate, otherwise
+   * display the link to do it manually
+   * @returns {boolean} True if enabled, false otherwise
+   */
+  async enable() {
+    const { username, repo } = await githubHelper.repoData();
+    const manualUrl = `https://github.com/settings/installations/${this.renovateId}`;
+    const renovateDashboardUrl = `https://app.renovatebot.com/dashboard#github/${username}/${repo}`;
+
+    // Fail early if no token available
+    if (!githubHelper.hasToken()) {
+      this.__consoleError(
+        `[renovate]: No GITHUB_TOKEN found, please visit ${manualUrl} to enable manually.`,
+      );
+      return false;
+    }
+
+    try {
+      const repositoryId = await this.getRepositoryId();
+      await githubHelper.octokit('apps.addRepoToInstallation', {
+        installation_id: this.renovateId,
+        repository_id: repositoryId,
+      });
+    } catch (_err) {
+      this.__consoleError(
+        `Renovate is not installed with this GitHub account, please visit ${manualUrl} to install it first.`,
+      );
+      return false;
+    }
+
+    this.__consoleSuccess(`Renovate enabled: ${renovateDashboardUrl}`);
+    return true;
+  },
+  __consoleSuccess: consoleSuccess,
+  __consoleError: consoleError,
+};

package/package.json

@@ -0,0 +1,43 @@
+{
+  "name": "aberlaas-setup",
+  "type": "module",
+  "description": "aberlaas setup helper: Setup third parties like GitHub, Netlify or CircleCI",
+  "version": "2.10.0",
+  "repository": "pixelastic/aberlaas",
+  "homepage": "https://projects.pixelastic.com/aberlaas/",
+  "author": "Tim Carry (@pixelastic)",
+  "license": "MIT",
+  "files": [
+    "lib/*.js"
+  ],
+  "exports": {
+    ".": "./lib/main.js"
+  },
+  "main": "./lib/main.js",
+  "engines": {
+    "node": ">=18.18.0"
+  },
+  "scripts": {
+    "build": "../../scripts/local/build",
+    "build:prod": "../../scripts/local/build-prod",
+    "cms": "../../scripts/local/cms",
+    "serve": "../../scripts/local/serve",
+    "ci": "../../scripts/local/ci",
+    "release": "../../scripts/local/release",
+    "update": "node ../../scripts/meta/update.js",
+    "test:meta": "../../scripts/local/test-meta",
+    "test": "../../scripts/local/test",
+    "test:watch": "../../scripts/local/test-watch",
+    "compress": "../../scripts/local/compress",
+    "lint": "../../scripts/local/lint",
+    "lint:fix": "../../scripts/local/lint-fix"
+  },
+  "dependencies": {
+    "@octokit/rest": "21.0.2",
+    "aberlaas-helper": "^2.10.0",
+    "firost": "4.3.0",
+    "golgoth": "2.4.0",
+    "parse-github-repo-url": "1.4.1"
+  },
+  "gitHead": "bcdaf87c198a588e02b5539c222f611e356d3079"
+}