/npm-example

Primary LanguageJavaScript

NPM Example

Overview

Artifactory provides full support for managing npm packages and ensures optimal and reliable access to npmjs.org. It also allows aggregating multiple npm registries under a virtual repository Artifactory, which provides access to all your npm packages through a single URL for both upload and download.

You may store exhaustive build information in Artifactory by running your npm builds with JFrog CLI. JFrog CLI collects build-info from your build agents and then publishes it to Artifactory. Once published, the build info can be viewed in the Build Browser under Builds. For more details on npm build integration using JFrog CLI, please refer to Building npm Packages in the JFrog CLI User Guide.

This Example

This example demonstrates how to build an npm project using JFrog CLI. The build does the following:

  1. Downloads its npm depedencies from Artifactory.
  2. Packs and uploads the built package to Artifactory.
  3. Records and publishes build-info to Artifactory.

Prerequisite

  1. Make sure your local machine has npm version 5.4.0 or above installed and that npm is included in the PATH. To verify this, run npm -v.
  2. Make sure your local machine has JFrog CLI version 1.13.1 or above installed and that jfrog is included in the PATH. To verify this, run jfrog -v.
  3. Make sure you're using a non-OSS JFrog Artifactory with version 5.5.2 or above.

Creating Repositories

Create the following repositories on your Artifactory instance.

  1. A remote npm repository named npm-remote. Make sure the repository has https://registry.npmjs.org configured as its URL (this is the default when creating the repository).
  2. A local repository named npm-local.
  3. A virtual repository named npm.
  4. Include the npm-remote and npm-local repositories as part of the new npm virtual repository.
  5. Set npm-local as the Default Deployment Repository of the new npm virtual repository.

Running the Example

CD to the root project directory.

Configure Artifactory:
> jfrog rt c

Build the project and record the depedencies as part of the build-info.
> jfrog rt npmi npm --build-name my-npm-build --build-number 1

Add environment variables to the build-info.
> jfrog rt bce my-npm-build 1

Add git information to the build-info.
> jfrog rt bag my-npm-build 1

Pack and publish the npm package to Artifactory, while recording it as artifact in the build-info.
> jfrog rt npmp npm  --build-name my-npm-build --build-number 1

Publish the build info to Artifactory.
> jfrog rt bp my-npm-build 1

npm-example