1.1.1 • Published 3 months ago

@khulnasoft/remote-nx v1.1.1

Weekly downloads
-
License
MPL-2.0
Repository
-
Last release
3 months ago

@khulnasoft/remote-nx

@khulnasoft/remote-nx

This project implements a task runner for @nrwl/nx that caches build artifacts in the Khulnasoft Remote Cache.

Table of Contents

Setup

Let's assume you already have a Khulnasoft Account. For the rest of the guide you will need a Khulnasoft Access Token and your team ID. You can create a khulnasoft access token in your account settings. Your team ID can be found under your team settings page.

Have those handy as we'll need them to authorize your monorepo to Khulnasoft's remote cache.

Usage

npm install --save-dev @khulnasoft/remote-nx

In your nx.json file you will find a tasksRunnerOptions field. Update this field so that it's using the installed @khulnasoft/remote-nx

{
  "tasksRunnerOptions": {
    "default": {
      "runner": "@khulnasoft/remote-nx",
      "options": {
        "cacheableOperations": ["build", "test", "lint", "e2e"],
        "token": "<token>",
        "teamId": "<teamId>"
      }
    }
  }
}

You can specify your token and teamId in your nx.json or set them as environment variables.

ParameterDescription Environment Variable / .envnx.json
Khulnasoft Access TokenKhulnasoft access token with access to the provided teamNX_KHULNASOFT_REMOTE_CACHE_TOKENtoken
Khulnasoft Team ID (optional)The Khulnasoft Team ID that should share the Remote CacheNX_KHULNASOFT_REMOTE_CACHE_TEAMteamId

Run it 🚀

Clear your local cache and rebuild your project.

nx reset
nx build

Advanced Configuration

OptionDescription
verboseSet to receive full stack traces whenever errors occur. Best used for debugging. Default: false
silentSet to mute success and info logs. Default: false
dotenvSet to false to disable reading .env into process.env. Default: true
dotenvPathSet to read .env files from a different folder.
"tasksRunnerOptions": {
  "default": {
    "runner": "@khulnasoft/remote-nx",
    "options": {
      "verbose": true,
      "silent": true
    }
  }
}

Credit to nx-remotecache-custom examples.