Commit 3f1db624 authored by Mathis Goichon's avatar Mathis Goichon
Browse files

docs: update kicker to fit with template generalization 



Signed-off-by: default avatarMathis Goichon <mathisgoichon@gmail.com>
parent 7c47553c

kicker.json

+29 −18
Original line number Diff line number Diff line
@@ -5,8 +5,8 @@ 
  "kind": "build",

  "variables": [

    {

      "name": "NPM_CONFIG_REGISTRY",

      "description": "NPM [registry](https://docs.npmjs.com/configuring-your-registry-settings-as-an-npm-enterprise-user)",

      "name": "CONFIG_REGISTRY",

      "description": "npm [registry](https://docs.npmjs.com/cli/v8/using-npm/registry)    ",

      "type": "url",

      "advanced": true

    },
@@ -15,6 +15,12 @@ 
      "description": "The Docker image used to run Node.js - **set the version required by your project**",

      "default": "node:lts-alpine"

    },

    {

      "name": "NODE_MANAGER",

      "description": "The package manager used by your project (npm or yarn) - **if undefined, automatic detection**",

      "default": "none",

      "advanced": true

    },

    {

      "name": "NODE_PROJECT_DIR",

      "description": "Node project root directory",
@@ -29,7 +35,7 @@ 
    },

    {

      "name": "NODE_BUILD_ARGS",

      "description": "NPM [build](https://docs.npmjs.com/cli/build.html) arguments",

      "description": "npm [run script](https://docs.npmjs.com/cli/v8/commands/npm-run-script) arguments - yarn [run script](https://classic.yarnpkg.com/en/docs/cli/run) arguments",

      "default": "run build --prod",

      "advanced": true

    },
@@ -41,7 +47,7 @@ 
    },

    {

      "name": "NODE_TEST_ARGS",

      "description": "NPM [test](https://docs.npmjs.com/cli/test.html) arguments",

      "description": "npm [test](https://docs.npmjs.com/cli/v8/commands/npm-test) arguments - yarn [test](https://classic.yarnpkg.com/en/docs/cli/test) arguments",

      "default": "test -- --coverage --bail",

      "advanced": true

    },
@@ -54,14 +60,14 @@ 
  ],

  "features": [

    {

      "id": "npm-lint",

      "name": "npm lint",

      "description": "npm lint analysis",

      "id": "node-lint",

      "name": "node lint",

      "description": "node lint analysis",

      "enable_with": "NODE_LINT_ENABLED",

      "variables": [

        {

          "name": "NODE_LINT_ARGS",

          "description": "NPM [run-script](https://docs.npmjs.com/cli/run-script.html) arguments to execute the lint analysis",

          "description": "npm [run script](https://docs.npmjs.com/cli/v8/commands/npm-run-script) arguments to execute the lint analysis - yarn [run script](https://classic.yarnpkg.com/en/docs/cli/run) arguments to execute the lint analysis",

          "default": "run lint",

          "advanced": true

        },
@@ -74,38 +80,43 @@ 
      ]

    },

    {

      "id": "npm-audit",

      "name": "npm audit",

      "description": "npm audit analysis",

      "id": "node-audit",

      "name": "node audit",

      "description": "node audit analysis",

      "disable_with": "NODE_AUDIT_DISABLED",

      "variables": [

        {

          "name": "NODE_AUDIT_ARGS",

          "description": "NPM [audit](https://docs.npmjs.com/cli/audit) arguments",

          "description": "npm [audit](https://docs.npmjs.com/cli/v8/commands/npm-audit) arguments - yarn [audit](https://classic.yarnpkg.com/en/docs/cli/audit) arguments",

          "default": "--audit-level=low"

        },

        {

          "name": "NODE_AUDIT_JSON_PATH",

          "description": "NPM [audit](https://docs.npmjs.com/cli/audit) JSON report path",

          "description": "JSON audit report path",

          "default": "reports/npm-audit-report.json",

          "advanced": true

        }

      ]

    },

    {

      "id": "npm-outdated",

      "name": "npm outdated",

      "description": "npm outdated analysis",

      "id": "node-outdated",

      "name": "node outdated",

      "description": "node outdated analysis",

      "disable_with": "NODE_OUTDATED_DISABLED",

      "variables": [

        {

          "name": "NODE_OUTDATED_SILENT",

          "description": "Set to `false` to enable job fails when dependencies are not up to date",

          "default": true

        },

        {

          "name": "NODE_OUTDATED_ARGS",

          "description": "NPM [outdated](https://docs.npmjs.com/cli/outdated) arguments",

          "description": "npm [outdated](https://docs.npmjs.com/cli/v8/commands/npm-outdated) arguments - yarn [outdated](https://classic.yarnpkg.com/lang/en/docs/cli/outdated/) arguments",

          "default": "--long"

        },

        {

          "name": "NODE_OUTDATED_JSON_PATH",

          "description": "NPM [outdated](https://docs.npmjs.com/cli/outdated) JSON report path",

          "description": "JSON outdated report path",

          "default": "reports/npm-outdated-report.json",

          "advanced": true

        }