Commit f7fa527a authored by Pierre Smeyers's avatar Pierre Smeyers
Browse files

feat: migrate to CI/CD component 

⚠️ requires GitLab 16.6 or later
parent 2bd72f18

.gitlab-ci.yml

+1 −1
Original line number Diff line number Diff line
@@ -10,7 +10,7 @@ include: 
    file: '/templates/validation.yml'

  - project: 'to-be-continuous/bash'

    ref: '3.3'

    file: 'templates/gitlab-ci-bash.yml'

    file: '/templates/gitlab-ci-bash.yml'

  - project: 'to-be-continuous/semantic-release'

    ref: '3.7'

    file: '/templates/gitlab-ci-semrel.yml'

README.md

+54 −29
Original line number Diff line number Diff line
@@ -6,28 +6,53 @@ More precisely, it can be used by all projects based on [npm](https://www.npmjs. 


## Usage



In order to include this template in your project, add the following to your `gitlab-ci.yml`:

This template can be used both as a [CI/CD component](https://docs.gitlab.com/ee/ci/components/#use-a-component-in-a-cicd-configuration) 

or using the legacy [`include:project`](https://docs.gitlab.com/ee/ci/yaml/index.html#includeproject) syntax.



### Use as a CI/CD component



Add the following to your `gitlab-ci.yml`:



```yaml

include:

  # 1: include the component

  - component: gitlab.com/to-be-continuous/node/gitlab-ci-node@3.10.1

    # 2: set/override component inputs

    inputs:

      image: "registry.hub.docker.com/library/node:20" # ⚠ this is only an example

      lint-enabled: "true"

```



### Use as a CI/CD template (legacy)



Add the following to your `gitlab-ci.yml`:



```yaml

include:

  # 1: include the template

  - project: 'to-be-continuous/node'

    ref: '3.10.1'

    file: '/templates/gitlab-ci-node.yml'



variables:

  # 2: set/override template variables

  NODE_IMAGE: "registry.hub.docker.com/library/node:20" # ⚠ this is only an example

  NODE_LINT_ENABLED: "true"

```



## Global configuration



The Node.js template uses some global configuration used throughout all jobs.



| Name                   | Description                                                                                      | Default value     |

| Input / Variable | Description                                                                                      | Default value     |

|------------------------|--------------------------------------------------------------------------------------------------|-------------------|

| `NODE_IMAGE`           | The Docker image used to run Node.js <br/>:warning: **set the version required by your project** | `registry.hub.docker.com/library/node:lts-alpine` |

| `NODE_MANAGER`         | The package manager used by your project (one of `npm`, `yarn` or `pnpm`)<br/>**If undefined, automatic detection** | _none_ (auto) |

| `NODE_CONFIG_REGISTRY` | Main npm [registry](https://docs.npmjs.com/cli/v8/using-npm/registry) to use                     | _none_            |

| `NODE_CONFIG_SCOPED_REGISTRIES` | Space separated list of npm [scoped registries](https://docs.npmjs.com/cli/v8/using-npm/scope#associating-a-scope-with-a-registry) (formatted as `@somescope:https://some.npm.registry/some/repo @anotherscope:https://another.npm.registry/another/repo`) | _none_ |

| `NODE_PROJECT_DIR`     | Node project root directory                                                                      | `.`               |

| `NODE_SOURCE_DIR`      | Sources directory                                                                                | `src`             |

| `NODE_INSTALL_EXTRA_OPTS`| Extra options to install project dependencies (either [`npm ci`](https://docs.npmjs.com/cli/ci.html/), [`yarn install`](https://yarnpkg.com/cli/install) or [`pnpm install`](https://pnpm.io/cli/install)) | _none_ |

| `image` / `NODE_IMAGE` | The Docker image used to run Node.js <br/>:warning: **set the version required by your project** | `registry.hub.docker.com/library/node:lts-alpine` |

| `manager` / `NODE_MANAGER` | The package manager used by your project (one of `npm`, `yarn` or `pnpm`)<br/>**If undefined, automatic detection** | _none_ (auto) |

| `config-registry` / `NODE_CONFIG_REGISTRY` | Main npm [registry](https://docs.npmjs.com/cli/v8/using-npm/registry) to use                     | _none_            |

| `config-scoped-registries` / `NODE_CONFIG_SCOPED_REGISTRIES` | Space separated list of npm [scoped registries](https://docs.npmjs.com/cli/v8/using-npm/scope#associating-a-scope-with-a-registry) (formatted as `@somescope:https://some.npm.registry/some/repo @anotherscope:https://another.npm.registry/another/repo`) | _none_ |

| `project-dir` / `NODE_PROJECT_DIR` | Node project root directory                                                                      | `.`               |

| `source-dir` / `NODE_SOURCE_DIR` | Sources directory                                                                                | `src`             |

| `install-extra-opts` / `NODE_INSTALL_EXTRA_OPTS` | Extra options to install project dependencies (either [`npm ci`](https://docs.npmjs.com/cli/ci.html/), [`yarn install`](https://yarnpkg.com/cli/install) or [`pnpm install`](https://pnpm.io/cli/install)) | _none_ |



### Using scoped registries
@@ -70,10 +95,10 @@ The Node template features a job `node-lint` that performs Node.js source code * 


It is bound to the `test` stage, and uses the following variable:



| Name                     | Description                                                                                                                                                                                                                | Default value                 |

| Input / Variable | Description                                                                                                                                                                                                                | Default value                 |

|--------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------|

| `NODE_LINT_ENABLED`      | Set to `true` to enable lint analysis                                                                                                                                                                                      | _none_ (disabled)             |

| `NODE_LINT_ARGS`         | npm [run script](https://docs.npmjs.com/cli/v8/commands/npm-run-script) arguments to execute the lint analysis <br/> yarn [run script](https://classic.yarnpkg.com/en/docs/cli/run) arguments to execute the lint analysis <br/> pnpm [run script](https://pnpm.io/cli/run) arguments to execute the lint analysis| `run lint`                    |

| `lint-enabled` / `NODE_LINT_ENABLED` | Set to `true` to enable lint analysis                                                                                                                                                                                      | _none_ (disabled)             |

| `lint-args` / `NODE_LINT_ARGS` | npm [run script](https://docs.npmjs.com/cli/v8/commands/npm-run-script) arguments to execute the lint analysis <br/> yarn [run script](https://classic.yarnpkg.com/en/docs/cli/run) arguments to execute the lint analysis <br/> pnpm [run script](https://pnpm.io/cli/run) arguments to execute the lint analysis| `run lint`                    |



The job generates a lint report that you will find here: `NODE_PROJECT_DIR/reports/node-lint.xslint.json`.
@@ -86,12 +111,12 @@ for jobs dependency reasons (some jobs such as SONAR analysis have a dependency 


This job is bound to the `build` stage, and uses the following variables:



| Name                          | Description                                                                                                                                                       | Default value         |

| Input / Variable | Description                                                                                                                                                       | Default value         |

|-------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------|

| `NODE_BUILD_DISABLED`         | Set to `true` to disable build                                                                                                                                    | _none_ (enabled)      |

| `NODE_BUILD_DIR`              | Variable to define build directory                                                                                                                                | `dist`                |

| `NODE_BUILD_ARGS`             | npm [run script](https://docs.npmjs.com/cli/v8/commands/npm-run-script) arguments <br/> yarn [run script](https://classic.yarnpkg.com/en/docs/cli/run) arguments <br/> pnpm [run script](https://pnpm.io/cli/run) arguments | `run build --prod`    |

| `NODE_TEST_ARGS`              | npm [test](https://docs.npmjs.com/cli/v8/commands/npm-test) arguments <br/> yarn [test](https://classic.yarnpkg.com/en/docs/cli/test) arguments  <br/> pnpm [test](https://pnpm.io/cli/test) arguments                                    | `test -- --coverage`  |

| `build-dir` / `NODE_BUILD_DIR` | Variable to define build directory                                                                                                                                | `dist`                |

| `build-args` / `NODE_BUILD_ARGS` | npm [run script](https://docs.npmjs.com/cli/v8/commands/npm-run-script) arguments <br/> yarn [run script](https://classic.yarnpkg.com/en/docs/cli/run) arguments <br/> pnpm [run script](https://pnpm.io/cli/run) arguments | `run build --prod`    |

| `test-args` / `NODE_TEST_ARGS` | npm [test](https://docs.npmjs.com/cli/v8/commands/npm-test) arguments <br/> yarn [test](https://classic.yarnpkg.com/en/docs/cli/test) arguments  <br/> pnpm [test](https://pnpm.io/cli/test) arguments                                    | `test -- --coverage`  |





#### Unit Tests and Code Coverage reports
@@ -301,10 +326,10 @@ The Node template features a job `node-audit` that performs an audit ([npm audit 


It is bound to the `test` stage.



| Name                   | Description                                                                                                                                           | Default value                    |

| Input / Variable | Description                                                                                                                                           | Default value                    |

|------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------|

| `NODE_AUDIT_DISABLED`  | Set to `true` to disable npm audit                                                                                                                    | _none_ (enabled)                 |

| `NODE_AUDIT_ARGS`      | npm [audit](https://docs.npmjs.com/cli/v8/commands/npm-audit) arguments <br/> yarn [audit](https://classic.yarnpkg.com/en/docs/cli/audit) arguments <br/> pnpm [audit](https://pnpm.io/cli/audit) arguments      | `--audit-level=low`              |

| `audit-disabled` / `NODE_AUDIT_DISABLED` | Set to `true` to disable npm audit                                                                                                                    | _none_ (enabled)                 |

| `audit-args` / `NODE_AUDIT_ARGS` | npm [audit](https://docs.npmjs.com/cli/v8/commands/npm-audit) arguments <br/> yarn [audit](https://classic.yarnpkg.com/en/docs/cli/audit) arguments <br/> pnpm [audit](https://pnpm.io/cli/audit) arguments      | `--audit-level=low`              |



In addition to a textual report in the console, this job produces the following report, kept for one day:
@@ -319,10 +344,10 @@ The Node template features a job `node-outdated` that performs outdated analysis 


It is bound to the `test` stage.



| Name                      | Description                                                                                                                                                           | Default value                      |

| Input / Variable | Description                                                                                                                                                           | Default value                      |

|---------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------|

| `NODE_OUTDATED_DISABLED`  | Set to `true` to disable npm outdated                                                                                                                                 | _none_ (enabled)                   |

| `NODE_OUTDATED_ARGS`      | npm [outdated](https://docs.npmjs.com/cli/v8/commands/npm-outdated) arguments <br/> yarn [outdated](https://classic.yarnpkg.com/lang/en/docs/cli/outdated/) arguments  <br/> pnpm [outdated](https://pnpm.io/cli/outdated) arguments | `--long`                           |

| `outdated-disabled` / `NODE_OUTDATED_DISABLED` | Set to `true` to disable npm outdated                                                                                                                                 | _none_ (enabled)                   |

| `outdated-args` / `NODE_OUTDATED_ARGS` | npm [outdated](https://docs.npmjs.com/cli/v8/commands/npm-outdated) arguments <br/> yarn [outdated](https://classic.yarnpkg.com/lang/en/docs/cli/outdated/) arguments  <br/> pnpm [outdated](https://pnpm.io/cli/outdated) arguments | `--long`                           |



The job generates an outdated report that you will find here: `NODE_PROJECT_DIR/reports/npm-outdated-report.json`.
@@ -332,11 +357,11 @@ This job generates a [SBOM](https://cyclonedx.org/) file listing installed packa 


It is bound to the `test` stage, and uses the following variables:



| Name                  | Description                            | Default value     |

| Input / Variable | Description                            | Default value     |

| --------------------- | -------------------------------------- | ----------------- |

| `NODE_SBOM_DISABLED` | Set to `true` to disable this job | _none_ |

| `NODE_SBOM_VERSION` | The version of @cyclonedx/cyclonedx-npm used to emit SBOM | _none_ (uses latest) |

| `NODE_SBOM_OPTS` | Options for @cyclonedx/cyclonedx-npm used for SBOM analysis | `--omit dev` |

| `sbom-disabled` / `NODE_SBOM_DISABLED` | Set to `true` to disable this job | _none_ |

| `sbom-version` / `NODE_SBOM_VERSION` | The version of @cyclonedx/cyclonedx-npm used to emit SBOM | _none_ (uses latest) |

| `sbom-opts` / `NODE_SBOM_OPTS` | Options for @cyclonedx/cyclonedx-npm used for SBOM analysis | `--omit dev` |



### `node-publish` job
@@ -347,10 +372,10 @@ When enabled, it is executed on a Git tag with a semantic versioning pattern (`v 


It uses the following variables:



| Name                       | Description                                                                 | Default value     |

| Input / Variable | Description                                                                 | Default value     |

|----------------------------|-----------------------------------------------------------------------------|-------------------|

| `NODE_PUBLISH_ENABLED`     | Set to `true` to enable the publish job                                     | _none_ (disabled) |

| `NODE_PUBLISH_ARGS`        | npm [publish](https://docs.npmjs.com/cli/v8/commands/npm-publish) extra arguments<br/>yarn [publish](https://classic.yarnpkg.com/lang/en/docs/cli/publish/) extra arguments <br/>pnpm [publish](https://pnpm.io/cli/publish) extra arguments | _none_ |

| `publish-enabled` / `NODE_PUBLISH_ENABLED` | Set to `true` to enable the publish job                                     | _none_ (disabled) |

| `publish-args` / `NODE_PUBLISH_ARGS` | npm [publish](https://docs.npmjs.com/cli/v8/commands/npm-publish) extra arguments<br/>yarn [publish](https://classic.yarnpkg.com/lang/en/docs/cli/publish/) extra arguments <br/>pnpm [publish](https://pnpm.io/cli/publish) extra arguments | _none_ |

| :lock: `NODE_PUBLISH_TOKEN`| npm publication registry authentication token                              | _none_ |



#### Configure the target registry

bumpversion.sh

+2 −2
Original line number Diff line number Diff line
@@ -27,13 +27,13 @@ if [[ "$curVer" ]]; then 
  log_info "Bump version from \\e[33;1m${curVer}\\e[0m to \\e[33;1m${nextVer}\\e[0m (release type: $relType)..."



  # replace in README

  sed -e "s/ref: '$curVer'/ref: '$nextVer'/" README.md > README.md.next

  sed -e "s/ref: *'$curVer'/ref: '$nextVer'/" -e "s/ref: *\"$curVer\”/ref: \”$nextVer\”/" -e "s/component: *\(.*\)@$curVer/component: \1@$nextVer/" README.md > README.md.next

  mv -f README.md.next README.md



  # replace in template and variants

  for tmpl in templates/*.yml

  do

    sed -e "s/\"$curVer\"/\"$nextVer\"/" "$tmpl" > "$tmpl.next"

    sed -e "s/command: *\[\"--service\", \"\(.*\)\", \"$curVer\"\]/command: [\"--service\", \"\1\", \"$nextVer\"]/" "$tmpl" > "$tmpl.next"

    mv -f "$tmpl.next" "$tmpl"

  done

else

kicker.json

+2 −0
Original line number Diff line number Diff line
@@ -3,6 +3,8 @@ 
  "description": "Build, test and analyse your JavaScript/TypeScript/[Node.js](https://nodejs.org/) projects",

  "template_path": "templates/gitlab-ci-node.yml",

  "kind": "build",

  "prefix": "node",

  "is_component": true,

  "variables": [

    {

      "name": "NODE_CONFIG_REGISTRY",

logo.png

−4.15 KiB (17.8 KiB)
Loading image diff...