Skip to content

javascript.md

Latest commit

 

History

History
162 lines (113 loc) · 6.47 KB

javascript.md

File metadata and controls

162 lines (113 loc) · 6.47 KB
title Build and publish a Node.js package
description Learn how to use Azure Pipelines to build, deploy, and test a Node.js app.
ms.assetid 5BB4D9FA-DCCF-4661-B52B-0C42006A2AE5
ms.topic how-to
ms.custom devx-track-js, freshness-fy22q2
ms.date 05/27/2025
monikerRange <= azure-devops

Build and publish a Node.js package

[!INCLUDE version-lt-eq-azure-devops]

You can build, test, and deploy Node.js apps as part of your Azure Pipelines continuous integration and continuous delivery (CI/CD) system. Learn how to use a pipeline to create a Node.js package with Node Package Manager (npm) and publish a pipeline artifact.

The example pipeline automates the process of building, testing, and packaging a Node.js application, making it ready for further deployment or distribution.

Prerequisites

[!INCLUDE ecosystems-prerequisites]

Fork the sample code

Fork the sample Express.js server app.

  1. Go to the js-e2e-express-server repository.
  2. Select Fork in the upper-right corner of the page.
  3. Select your GitHub account. By default, the fork is named the same as the parent repository, but you can give it a different name.

Important

During the following procedures, you might be prompted to create a GitHub service connection or redirected to GitHub to sign in, install Azure Pipelines, or authorize Azure Pipelines. Follow the instructions on the screen to complete the process. For more information, see Access to GitHub repositories.

Create your pipeline

YAML

  1. In your Azure DevOps project, select Pipelines > Create Pipeline, then select GitHub as the location of your source code.
  2. On the Select a repository screen, select your forked sample repository.
  3. On the Configure your pipeline screen, select Starter pipeline. Azure Pipelines generates a YAML file named azure-pipelines.yml for your pipeline.
  4. Select the dropdown caret next to Save and run, select Save, then select Save again. The file is saved to your forked GitHub repository.
  5. On the next screen, select Edit.

Build the package and publish an artifact

Edit the azure-pipelines.yml file as follows.

  1. Replace the file contents with the following code.

    trigger:
  - main

pool:
  vmImage: 'ubuntu-latest'

variables:
  nodeVersion: '18.x'

steps:
  # Install Node.js
  - task: UseNode@1
    inputs:
      version: $(nodeVersion)
    displayName: 'Install Node.js'

  # Install dependencies
  - script: |
      npm install
    displayName: 'Install dependencies'

  # Build the project
  - script: |
      npm run build
    displayName: 'Build project'

  # Run tests
  - script: |
      npm test
    displayName: 'Run tests'

  # Copy project files to artifact staging directory
  - task: CopyFiles@2
    inputs:
      sourceFolder: '$(Build.SourcesDirectory)'
      contents: |
        src/**
        public/**
      targetFolder: '$(Build.ArtifactStagingDirectory)'
    displayName: 'Copy project files'

  # Publish pipeline artifact
  - task: PublishPipelineArtifact@1
    inputs:
      artifactName: 'nodejs-app'
      targetPath: '$(Build.ArtifactStagingDirectory)'
    displayName: 'Publish pipeline artifact'

In the updated pipeline, you'll:

  • Install Node.js: The UseNode@1 task installs the specified Node.js version (18.x).
  • Install dependencies: The npm install command installs the required dependencies for the Node.js project.
  • Build the project: The npm run build command builds the Node.js project.
  • Run Tests: The npm test command runs the project's test suite.
  • Copy files: The CopyFiles@2 task copies the necessary project files (for example, src/** and public/**) to the artifact staging directory.
  • Publish pipeline artifact: The PublishPipelineArtifact@1 task publishes the files from the artifact staging directory as a pipeline artifact named nodejs-app.

Run your pipeline

Select Validate and save, then Save, Run, and Run again.

After your pipeline runs, verify that the job ran successfully and that you see a published artifact.

::: moniker range="<=azure-devops"

:::image type="content" source="media/node-artifact-run.png" alt-text="Screenshot of successful pipeline run with an artifact.":::

::: moniker-end

Classic

  1. Select GitHub as the source for your code.

  2. Under Repository, select your forked repository and Continue.

  3. Select Empty pipeline, and select Apply.

  4. Under Agent specification in the right pane, select ubuntu-latest.

  5. In the left pane, add the following tasks to the pipeline in order. For each task, select the + in Agent job 1, select the task at right and select Add, and configure the task if necessary.

    1. npm

    2. npm

      • Display name: npm test
      • Command: custom
      • Command and arguments: test

    3. Publish Test Results

    4. Archive files

      • Root folder or file to archive: $(System.DefaultWorkingDirectory)
      • Prepend root folder name to archive paths: Uncheck

    5. Publish build artifacts

  6. Select Save & queue, and then select Save and run.

    :::image type="content" source="media/classic-node.png" alt-text="Screenshot of the classic pipeline.":::

Congratulations, you successfully created and ran a pipeline that built and tested a Node.js package. To extend your pipeline, you can:

Next steps

[!div class="nextstepaction"] Configure JavaScript