@o3r/pipeline
v14.3.0
Published
A package that provides toolchain related helpers.
Readme
This package is an Otter Framework Module.
Description
This module contains tooling around DevOps toolchains.
How to install
ng add @o3r/pipelineDescription
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, onlyGitHubis supported.runner: The CI runner. Default isubuntu-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:
ng add @o3r/pipeline --runner=windows-latest --npmRegistry=https://custom-registry.example.comPrivate 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.
- name: Install
env:
COREPACK_NPM_REGISTRY: https://custom-registry.example.com
COREPACK_INTEGRITY_KEYS: ""
shell: bash
run: npm ciIf 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 and release process by creating a new release on GitHub and generating release notes.
