@o3r/pipeline 11.4.0-prerelease.45

package/LICENSE

@@ -0,0 +1,26 @@
+Copyright Amadeus SAS
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+this list of conditions and the following disclaimer in the documentation and/or
+other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its contributors
+may be used to endorse or promote products derived from this software without
+specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package/README.md

@@ -0,0 +1,61 @@
+<h1 align="center">Otter Pipeline</h1>
+<p align="center">
+  <img src="https://raw.githubusercontent.com/AmadeusITGroup/otter/main/assets/logo/otter.png" alt="Super cute Otter!" width="40%"/>
+</p>
+
+This package is an [Otter Framework Module](https://github.com/AmadeusITGroup/otter/tree/main/docs/core/MODULE.md).
+<br />
+<br />
+
+## Description
+
+[![Stable Version](https://img.shields.io/npm/v/@o3r/pipeline?style=for-the-badge)](https://www.npmjs.com/package/@o3r/pipeline)
+[![Bundle Size](https://img.shields.io/bundlephobia/min/@o3r/pipeline?color=green&style=for-the-badge)](https://www.npmjs.com/package/@o3r/pipeline)
+
+This module contains tooling around DevOps toolchains.
+
+## How to install
+
+```shell
+ng add @o3r/pipeline
+```
+
+## Description
+
+The `ng add` schematic for Otter Pipeline helps you set up a DevOps pipeline for your frontend project. This schematic configures the necessary CI runner and npm registry settings to streamline your development workflow.
+
+### Properties
+
+- `toolchain`: The DevOps toolchain to create. For now, only `GitHub` is supported.
+- `runner`: The CI runner. Default is `ubuntu-latest`.
+- `npmRegistry`: A custom npm registry. By default, the public one (https://registry.npmjs.org) will be used.
+
+### Usage
+
+Here is an example of how to use the `ng add` schematics with parameters:
+
+```shell
+ng add @o3r/pipeline --runner=windows-latest --npmRegistry=https://custom-registry.example.com
+```
+
+### Private NPM Registry
+
+When a custom npm registry is provided, the schematic will automatically create a `.npmrc` (or a `.yarnrc`) file with the specified registry.
+Additionally, it will set the necessary environment variables for the install task.
+
+```yaml
+- name: Install
+  env:
+    COREPACK_NPM_REGISTRY: https://custom-registry.example.com
+    COREPACK_INTEGRITY_KEYS: ""
+  shell: bash
+  run: npm ci
+```
+
+If you choose to run the schematic without specifying an `npmRegistry`, you may need to manually apply these changes afterwards.
+
+### GitHub workflow
+
+The generated pipeline ensures that your code is built, tested and linted on every push or pull request to the main and release branches.
+
+It also automates the versioning thanks to the [Otter - New Version GitHub Action](https://github.com/AmadeusITGroup/otter/tree/main/tools/github-actions/new-version#readme) and release process by creating a new release on GitHub and generating release notes.

package/collection.json

@@ -0,0 +1,14 @@
+{
+  "$schema": "https://raw.githubusercontent.com/angular/angular-cli/master/packages/angular_devkit/schematics/collection-schema.json",
+  "schematics": {
+    "ng-add": {
+      "description": "Add Otter Pipeline to the project.",
+      "factory": "./schematics/ng-add/index#ngAdd",
+      "schema": "./schematics/ng-add/schema.json",
+      "aliases": [
+        "install",
+        "i"
+      ]
+    }
+  }
+}

package/migration.json

@@ -0,0 +1,5 @@
+{
+  "$schema": "https://raw.githubusercontent.com/angular/angular-cli/master/packages/angular_devkit/schematics/collection-schema.json",
+  "schematics": {
+  }
+}

package/package.json

@@ -0,0 +1,168 @@
+{
+  "name": "@o3r/pipeline",
+  "version": "11.4.0-prerelease.45",
+  "publishConfig": {
+    "access": "public"
+  },
+  "typings": "./src/public_api.d.ts",
+  "main": "src/public_api.js",
+  "description": "A package that provides toolchain related helpers.",
+  "keywords": [
+    "toolchain",
+    "pipeline",
+    "otter",
+    "otter-module"
+  ],
+  "scripts": {
+    "nx": "nx",
+    "ng": "yarn nx",
+    "test": "yarn nx test pipeline",
+    "copy:templates": "yarn cpy 'schematics/**/templates{-*,}/**/*' dist/schematics",
+    "prepare:build:builders": "yarn cpy '{collection,migration}.json' dist && yarn cpy 'schematics/**/schema.json' dist/schematics && yarn copy:templates",
+    "prepare:publish": "prepare-publish ./dist && yarn write-git-hash",
+    "build:source": "tsc -b tsconfig.build.json && yarn cpy package.json dist/",
+    "build:builders": "tsc -b tsconfig.builders.json --pretty && yarn copy:templates && yarn generate-cjs-manifest",
+    "build": "yarn nx build pipeline",
+    "postbuild": "patch-package-json-main"
+  },
+  "exports": {
+    "./package.json": {
+      "default": "./package.json"
+    },
+    ".": {
+      "default": "./src/public_api.js",
+      "typings": "./src/public_api.d.ts"
+    }
+  },
+  "dependencies": {
+    "js-yaml": "^4.1.0",
+    "tslib": "^2.6.2"
+  },
+  "peerDependencies": {
+    "@o3r/schematics": "^11.4.0-prerelease.45",
+    "@o3r/telemetry": "^11.4.0-prerelease.45"
+  },
+  "peerDependenciesMeta": {
+    "@o3r/schematics": {
+      "optional": true
+    },
+    "@o3r/telemetry": {
+      "optional": true
+    }
+  },
+  "devDependencies": {
+    "@angular-devkit/architect": "~0.1802.0",
+    "@angular-devkit/core": "~18.2.0",
+    "@angular-devkit/schematics": "~18.2.0",
+    "@angular-eslint/eslint-plugin": "~18.3.0",
+    "@compodoc/compodoc": "^1.1.19",
+    "@nx/eslint-plugin": "~19.5.0",
+    "@nx/jest": "~19.5.0",
+    "@nx/js": "~19.5.0",
+    "@o3r/build-helpers": "^11.4.0-prerelease.45",
+    "@o3r/eslint-plugin": "^11.4.0-prerelease.45",
+    "@o3r/schematics": "^11.4.0-prerelease.45",
+    "@o3r/telemetry": "^11.4.0-prerelease.45",
+    "@o3r/test-helpers": "^11.4.0-prerelease.45",
+    "@schematics/angular": "~18.2.0",
+    "@stylistic/eslint-plugin-ts": "~2.4.0",
+    "@types/jest": "~29.5.2",
+    "@types/js-yaml": "^4.0.5",
+    "@types/node": "^20.0.0",
+    "@typescript-eslint/eslint-plugin": "^7.14.1",
+    "@typescript-eslint/parser": "^7.14.1",
+    "@typescript-eslint/utils": "^7.14.1",
+    "cpy-cli": "^5.0.0",
+    "eslint": "^8.57.0",
+    "eslint-import-resolver-node": "^0.3.9",
+    "eslint-plugin-jest": "~28.8.0",
+    "eslint-plugin-jsdoc": "~48.11.0",
+    "eslint-plugin-prefer-arrow": "~1.2.3",
+    "eslint-plugin-unicorn": "^54.0.0",
+    "jest": "~29.7.0",
+    "jest-junit": "~16.0.0",
+    "jsonc-eslint-parser": "~2.4.0",
+    "nx": "~19.5.0",
+    "pid-from-port": "^1.1.3",
+    "ts-jest": "~29.2.0",
+    "ts-node": "~10.9.2",
+    "type-fest": "^4.10.2",
+    "typescript": "~5.5.4"
+  },
+  "engines": {
+    "node": "^18.19.1 || ^20.11.1 || >=22.0.0"
+  },
+  "schematics": "./collection.json",
+  "ng-update": {
+    "migrations": "./migration.json"
+  },
+  "contributors": [
+    {
+      "name": "Yannick Adam",
+      "url": "https://github.com/yannickadam",
+      "email": "yannickadam@users.noreply.github.com"
+    },
+    {
+      "name": "Kilian Panot",
+      "url": "https://github.com/kpanot",
+      "email": "kpanot@users.noreply.github.com"
+    },
+    {
+      "name": "Jeremy Bourgeois",
+      "url": "https://github.com/jbourgeois-1A",
+      "email": "jbourgeois-1A@users.noreply.github.com"
+    },
+    {
+      "name": "Pierre Henri Ginoux",
+      "url": "https://github.com/pginoux-1A",
+      "email": "pginoux-1A@users.noreply.github.com"
+    },
+    {
+      "name": "Mircea Vasile Rednic",
+      "url": "https://github.com/mrednic-1A",
+      "email": "mrednic-1A@users.noreply.github.com"
+    },
+    {
+      "name": "Stephane Dalle",
+      "url": "https://github.com/sdalle-1A",
+      "email": "sdalle-1A@users.noreply.github.com"
+    },
+    {
+      "name": "Nicolas Hoffmann",
+      "url": "https://github.com/nhoffmann-1A",
+      "email": "nhoffmann-1A@users.noreply.github.com"
+    },
+    {
+      "name": "Victor Scaiceanu",
+      "url": "https://github.com/vscaiceanu-1a",
+      "email": "vscaiceanu-1A@users.noreply.github.com"
+    },
+    {
+      "name": "Florian Paul",
+      "url": "https://github.com/fpaul-1A",
+      "email": "fpaul-1A@users.noreply.github.com"
+    },
+    {
+      "name": "Corinne Paulve",
+      "url": "https://github.com/cpaulve-1A",
+      "email": "cpaulve-1A@users.noreply.github.com"
+    },
+    {
+      "name": "Matthieu Crouzet",
+      "url": "https://github.com/matthieu-crouzet",
+      "email": "matthieu-crouzet@users.noreply.github.com"
+    },
+    {
+      "name": "Salome Do",
+      "url": "https://github.com/sdo-1A",
+      "email": "sdo-1A@users.noreply.github.com"
+    }
+  ],
+  "bugs": "https://github.com/AmadeusITGroup/otter/issues",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/AmadeusITGroup/otter.git"
+  },
+  "license": "BSD-3-Clause",
+  "homepage": "https://amadeusitgroup.github.io/otter/"
+}

package/schematics/ng-add/index.d.ts

@@ -0,0 +1,8 @@
+import { Rule } from '@angular-devkit/schematics';
+import type { NgAddSchematicsSchema } from './schema';
+/**
+ * Add an Otter CI pipeline to an Angular project
+ * @param options
+ */
+export declare const ngAdd: (options: NgAddSchematicsSchema) => Rule;
+//# sourceMappingURL=index.d.ts.map

package/schematics/ng-add/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../schematics/ng-add/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAgD,IAAI,EAAiB,MAAM,4BAA4B,CAAC;AAC/G,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,UAAU,CAAC;AAyEtD;;;GAGG;AACH,eAAO,MAAM,KAAK,YAAa,qBAAqB,KAAG,IAQtD,CAAC"}

package/schematics/ng-add/index.js

@@ -0,0 +1,85 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ngAdd = void 0;
+const schematics_1 = require("@angular-devkit/schematics");
+const js_yaml_1 = require("js-yaml");
+const path = require("node:path");
+const fs = require("node:fs");
+/**
+ * Add an Otter CI pipeline to an Angular Project
+ * @param options
+ */
+function ngAddFn(options) {
+    return async (tree, context) => {
+        const packageJsonPath = path.resolve(__dirname, '..', '..', 'package.json');
+        const ownPackageJson = JSON.parse(fs.readFileSync(packageJsonPath, { encoding: 'utf8' }));
+        const commitHash = ownPackageJson.o3rConfig?.commitHash;
+        const ownVersion = ownPackageJson.version;
+        const actionVersionString = commitHash ? `${commitHash} # v${ownVersion}` : ownVersion;
+        let packageManager = 'npm';
+        try {
+            const schematics = await Promise.resolve().then(() => require('@o3r/schematics'));
+            packageManager = schematics.getPackageManager({ workspaceConfig: schematics.getWorkspaceConfig(tree) });
+        }
+        catch {
+            packageManager = tree.exists('/yarn.lock') ? 'yarn' : 'npm';
+        }
+        context.logger.info(`Setting up pipeline for package manager: "${packageManager}" `);
+        const setupCommand = packageManager === 'yarn' ? 'yarn install --immutable' : 'npm ci';
+        const baseTemplateSource = (0, schematics_1.apply)((0, schematics_1.url)(`./templates/${options.toolchain}`), [
+            (0, schematics_1.template)({
+                ...options,
+                packageManager,
+                setupCommand,
+                actionVersionString,
+                dot: '.'
+            }),
+            (0, schematics_1.move)(tree.root.path)
+        ]);
+        const npmRegistryRule = () => {
+            if (!options.npmRegistry) {
+                return tree;
+            }
+            if (packageManager === 'yarn') {
+                const yarnrcPath = '/.yarnrc.yml';
+                if (!tree.exists(yarnrcPath)) {
+                    tree.create(yarnrcPath, (0, js_yaml_1.dump)({ 'npmRegistryServer': options.npmRegistry }, { indent: 2 }));
+                }
+                else {
+                    const yarnrcContent = (0, js_yaml_1.load)(tree.readText(yarnrcPath));
+                    yarnrcContent.npmRegistryServer = options.npmRegistry;
+                    tree.overwrite(yarnrcPath, (0, js_yaml_1.dump)(yarnrcContent, { indent: 2 }));
+                }
+            }
+            else if (packageManager === 'npm') {
+                const npmrcPath = '/.npmrc';
+                const npmRegistry = `registry=${options.npmRegistry}`;
+                if (!tree.exists(npmrcPath)) {
+                    tree.create(npmrcPath, npmRegistry);
+                }
+                else {
+                    const npmrcContent = tree.readText(npmrcPath);
+                    tree.overwrite(npmrcPath, npmrcContent.concat(`\n${npmRegistry}`));
+                }
+            }
+            return tree;
+        };
+        const rules = [
+            (0, schematics_1.mergeWith)(baseTemplateSource, schematics_1.MergeStrategy.Overwrite),
+            npmRegistryRule
+        ];
+        return () => (0, schematics_1.chain)(rules)(tree, context);
+    };
+}
+/**
+ * Add an Otter CI pipeline to an Angular project
+ * @param options
+ */
+const ngAdd = (options) => async (_, { logger }) => {
+    return await Promise.resolve().then(() => require('@o3r/schematics')).catch(() => {
+        logger.warn(`You are trying to add '@o3r/pipeline' on a project that does not have '@o3r/schematics' as a dependency.
+        Please run 'ng add @o3r/schematics' before for a more robust setup. Trying to guess the package manager.`);
+    }).then((schematics) => schematics ? schematics.createSchematicWithMetricsIfInstalled(ngAddFn)(options) : ngAddFn(options));
+};
+exports.ngAdd = ngAdd;
+//# sourceMappingURL=index.js.map

package/schematics/ng-add/schema.d.ts

@@ -0,0 +1,12 @@
+import type { SchematicOptionObject } from '@o3r/schematics';
+type Toolchains = 'github';
+export interface NgAddSchematicsSchema extends SchematicOptionObject {
+    /** The DevOps toolchain to create */
+    toolchain: Toolchains;
+    /** The CI runner */
+    runner: string;
+    /** A custom npm registry */
+    npmRegistry?: string | undefined;
+}
+export {};
+//# sourceMappingURL=schema.d.ts.map

package/schematics/ng-add/schema.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema.d.ts","sourceRoot":"","sources":["../../../schematics/ng-add/schema.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,iBAAiB,CAAC;AAE7D,KAAK,UAAU,GAAG,QAAQ,CAAC;AAE3B,MAAM,WAAW,qBAAsB,SAAQ,qBAAqB;IAElE,qCAAqC;IACrC,SAAS,EAAE,UAAU,CAAC;IAEtB,oBAAoB;IACpB,MAAM,EAAE,MAAM,CAAC;IAEf,4BAA4B;IAC5B,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAClC"}

package/schematics/ng-add/schema.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=schema.js.map

package/schematics/ng-add/schema.json

@@ -0,0 +1,35 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "ngAddSchematicsSchema",
+  "title": "Add Otter o3r-pipeline",
+  "description": "ngAdd Otter o3r-pipeline",
+  "properties": {
+    "toolchain": {
+      "description": "The DevOps toolchain to create.",
+      "type": "string",
+      "default": "github",
+      "enum": [
+        "github"
+      ],
+      "x-prompt": {
+        "message": "Which DevOps toolchain would you like to generate?",
+        "type": "list",
+        "items": [
+          { "value": "github", "label": "GITHUB - Setup, build, test and basic code checks for a GitHub project." }
+        ]
+      }
+    },
+    "runner": {
+      "type": "string",
+      "description": "The CI runner.",
+      "default": "ubuntu-latest"
+    },
+    "npmRegistry": {
+      "type": "string",
+      "description": "A custom npm registry (the public one will be used by default)."
+    }
+  },
+  "additionalProperties": true,
+  "required": [
+  ]
+}

package/schematics/ng-add/templates/github/__dot__github/actions/setup/action.yml

@@ -0,0 +1,21 @@
+name: Setup and Install
+description: Sets up Node.js and installs dependencies
+
+runs:
+  using: "composite"
+  steps:
+    - uses: actions/setup-node@0a44ba7841725637a19e28fa30b79a866c81b0a6 # v4.0.4
+      with:
+        node-version: 20
+        cache: <%= packageManager %>
+    - name: Enable Corepack
+      shell: bash
+      run: corepack enable
+    - name: Install
+<% if (npmRegistry) { %>
+      env:
+        COREPACK_NPM_REGISTRY: <%= npmRegistry %>
+        COREPACK_INTEGRITY_KEYS: ""
+<% } %>
+      shell: bash
+      run: <%= setupCommand %>

package/schematics/ng-add/templates/github/__dot__github/workflows/main.yml

@@ -0,0 +1,66 @@
+name: Main CI
+
+env:
+  DEFAULT_BRANCH: main
+  DEFAULT_BRANCH_PRERELEASE_NAME: prerelease
+  RELEASE_BRANCH_REGEX: 'release\/(0|[1-9]\d*)\.(0|[1-9]\d*)(\.0-(?:next|prerelease|rc))?$'
+
+on:
+  push:
+    branches:
+      - main
+      - 'release/*'
+  pull_request:
+    branches:
+      - main
+      - 'release/*'
+
+jobs:
+  build:
+    runs-on: <%= runner %>
+    steps:
+      - uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
+      - uses: ./.github/actions/setup
+      - name: Build
+        run: <%= packageManager %> run build
+
+  unit-tests:
+    runs-on: <%= runner %>
+    steps:
+      - uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
+      - uses: ./.github/actions/setup
+      - name: Unit tests
+        run: <%= packageManager %> run test
+
+  lint:
+    runs-on: <%= runner %>
+    steps:
+      - uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
+      - uses: ./.github/actions/setup
+      - name: Lint
+        run: <%= packageManager %> run lint
+
+  release:
+    permissions:
+      contents: write
+    runs-on: <%= runner %>
+    outputs:
+      nextVersionTag: ${{ steps.new-version.outputs.nextVersionTag }}
+    steps:
+      - uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
+      - name: New version
+        if: github.event_name != 'merge_group'
+        id: new-version
+        uses: AmadeusITGroup/otter/tools/github-actions/new-version@<%= actionVersionString %>
+        with:
+          defaultBranch: ${{ env.DEFAULT_BRANCH }}
+          defaultBranchPrereleaseName: ${{ env.DEFAULT_BRANCH_PRERELEASE_NAME }}
+          releaseBranchRegExp: ${{ env.RELEASE_BRANCH_REGEX }}
+      - name: Create release
+        if: github.event_name != 'pull_request'
+        uses: AmadeusITGroup/otter/tools/github-actions/release@<%= actionVersionString %>
+        with:
+          version: ${{ steps.newVersion.outputs.nextVersionTag }}
+          target: ${{ github.ref_name }}
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

package/schematics/package.json

@@ -0,0 +1,3 @@
+{
+  "type": "commonjs"
+}

package/src/public_api.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=public_api.d.ts.map

package/src/public_api.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"public_api.d.ts","sourceRoot":"","sources":["../../src/public_api.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC"}

package/src/public_api.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=public_api.js.map

package/src/public_api.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"public_api.js","sourceRoot":"","sources":["../../src/public_api.ts"],"names":[],"mappings":""}