This pipeline demonstrates the definition of a simple pipeline that builds and publishes an npm package. An example Pipelines DSL is used to show how to use integrations, resources, and steps to construct a simple, automated workflow.
This example shows the following:
Create a GitHub Integration and Artifactory Integration or JFrog Platform Access Token Integration .
Add a Pipeline Source.
Build npm components using the NpmBuild native step.
Publish the npm component using the NpmPublish native step.
See it Live!
Click here to see this quickstart in action.
A successful run of the pipeline in this quickstart looks like this:
Before you Begin
Before trying this quickstart, ensure that you have:
A GitHub account. This is required for forking the example repository.
A JFrog Platform account, or self-hosted JFrog Pipelines.
Set up Artifactory as an npm Registry. Create three repositories:
A remote npm registry. Remote Repositories defined in Artifactory serve as a caching proxy for a registry managed at a remote URL such as
https://registry.npmjs.org. Artifacts (such as TGZ files) requested from a remote repository are cached on demand.A local npm registry.
A virtual npm registry. A Virtual Repository defined in Artifactory aggregates packages from both local and remote repositories. This allows you to access both locally hosted npm packages and remote proxied npm registries from a single URL defined for the virtual repository.
When adding the virtual npm registry, ensure that both the remote and local npm registries are selected, and the Default Deployment Repository is set to the local npm registry.
At least one node pool. This is the set of nodes that all pipeline steps will execute in. For more information, see Managing Pipelines Node Pools.
Run the Pipeline
Perform the steps below to build and push your npm image:. For a detailed look at the Npm Build Pipeline Example yaml, see Npm Build Example: pipelines.yml.
Fork the repository
The Pipelines DSL for this example is available in the npm-example repository in the JFrog GitHub account.
The DSL file is a yaml file that contains the pipeline definitions. This example uses two yaml files:
pipelines.yml, which contains the declarations for all the resources and workflow steps required to run the pipeline.values.yml, which contains the values required for the pipelines.yml file.
For a full breakup of all the resources, pipelines and steps used in the yml file, see Npm Build Example: pipelines.yml .
Fork this repository to your account or organization. This is important since you need admin access to repositories that are used as Pipeline Sources or GitRepo resources, in order to add webhooks to these repositories and listen for change events.
Sign in to Artifactory
Sign in to JFrog Platform with your Artifactory credentials.
Add Integrations
a. Go to Administration | Pipelines | Integrations to add two integrations:
GitHub Integration: This integration is used to add the Pipeline source, as well as the GitRepo resource defined in values.yml.
Artifactory Integration or JFrog Platform Access Token Integration : This integration is used to authenticate with Artifactory to download npm depedencies from Artifactory, and to pack and upload the built package to Artifactory.
b. Write down the names of both GitHub and Artifactory integrations as these are required for the next step. Ensure that the names are unique and easy to remember.
Update values.yml and pipelines.yml
The pipelines configuration is available in the
values.ymlfile. Edit this file in your fork of this repo and replace the following:Tag
Description
Example
gitProviderProvide the name of the Github integration you added in the previous step.
gitProvider: my_githubpathProvide the path to your fork of this repository.
path: myuser/project-examplesEdit the
pipelines.ymlfile and replace the following:Tag
Description
Example
sourceArtifactoryProvide your Artifactory integration.
sourceArtifactory: artrepositoryNameProvide the name of the npm repository in Artifactory.
repositoryName: npm-virtualNote
All pipeline definitions are global across JFrog Pipelines within a Project. The names of your pipelines and resources need to be unique within the Project in JFrog Pipelines.
Add Pipeline Sources
The Pipeline Source represents the git repository where our pipelines definition files are stored. A pipeline source connects to the repository through an integration, which we added in step 3.
In your left navigation bar, go to Administration | Pipelines | Pipeline Sources. Click on Add a Pipeline Source and then choose From YAML. Follow instructions to Add a Pipeline Source. This automatically adds your configuration to the platform and pipelines are created based on your YAML.
Execute the Pipeline
After your Pipeline Source is synced successfully, navigate to Pipelines | My Pipelines in the left navbar to see the newly added pipeline. In this example,
npm_example_pipeline_jfpis the name of our pipeline. Click the name of the pipeline. This renders a real-time, interactive, diagram of the pipeline and the results of its most current run.
You can trigger the pipeline by committing a change to your repository, or by manually triggering it through the UI. The steps in the pipeline execute in sequence. Multiple steps can execute in parallel if the node pool has multiple build nodes available.
Once the pipeline has completed, a new run is listed.
