I'm Samuel Fajreldines

I am a specialist in the entire JavaScript and TypeScript ecosystem (including Node.js, React, Angular and Vue.js)

I am expert in AI and in creating AI integrated solutions

I am expert in DevOps and Serverless Architecture (AWS, Google Cloud and Azure)

I am expert in PHP and its frameworks (such as Codeigniter and Laravel).

Samuel Fajreldines

I am a specialist in the entire JavaScript and TypeScript ecosystem.

I am expert in AI and in creating AI integrated solutions.

I am expert in DevOps and Serverless Architecture

I am expert in PHP and its frameworks.

+55 (51) 99226-5039 samuelfajreldines@gmail.com
Home Page

GitLab CI for Node.js: A Guide to Continuous Integration

Introduction

In today's fast-paced development environment, Continuous Integration (CI) has become an indispensable practice for software teams aiming to deliver robust and reliable applications. GitLab CI stands out as a powerful tool that integrates seamlessly with GitLab repositories, providing a streamlined workflow for developers. In this post, we'll delve into what CI is, why it's essential, and how you can leverage GitLab CI to enhance your Node.js development workflow.

What is Continuous Integration (CI)?

Continuous Integration is a development practice where developers frequently integrate code changes into a central repository, followed by automated builds and tests. The primary goals of CI are to detect integration errors early, improve software quality, and reduce the time it takes to validate and release new software updates.

Key Benefits of CI:

  • Early Bug Detection: By integrating code regularly, teams can identify and fix defects quickly.
  • Improved Collaboration: CI encourages frequent code commits, fostering better communication among team members.
  • Faster Delivery: Automated builds and tests streamline the release process, reducing time-to-market.
  • Quality Assurance: Continuous testing ensures that code changes don't break existing functionality.

Introducing GitLab CI

GitLab CI is a built-in Continuous Integration service offered by GitLab. It allows you to run automated tests and deploy code with minimal setup. GitLab CI uses a file called .gitlab-ci.yml in the root of your repository to define the CI/CD pipeline.

Why Choose GitLab CI:

  • Integrated Platform: GitLab provides a single application for the entire DevOps lifecycle.
  • Flexibility: Supports multiple programming languages and frameworks.
  • Scalability: Easily scale your pipelines with GitLab Runners.
  • Visibility: Comprehensive pipeline visualization and monitoring.

Setting Up GitLab CI for a Node.js Project

Let's walk through the steps to set up GitLab CI for a Node.js application.

Prerequisites

  • A GitLab account.
  • A Node.js project hosted in a GitLab repository.
  • Basic understanding of YAML syntax.

Step 1: Create a .gitlab-ci.yml File

In the root directory of your project, create a file named .gitlab-ci.yml. This file defines the stages and jobs for your CI pipeline.

image: node:14

stages:
  - test

test_job:
  stage: test
  script:
    - npm install
    - npm test

Explanation:

  • image: Specifies the Docker image to use. Here, we're using Node.js version 14.
  • stages: Defines the stages of the pipeline. We have one stage called test.
  • test_job: This is a job that runs in the test stage.
  • script: The commands to execute. We install dependencies and run tests.

Step 2: Configure GitLab Runner (Optional)

If you want to run your jobs on your own infrastructure, you'll need to set up a GitLab Runner.

To configure a GitLab Runner:

  1. Install GitLab Runner on your server.
  2. Register the Runner with your GitLab instance.
  3. Specify the Runner in your .gitlab-ci.yml if necessary.

For most projects, GitLab's shared Runners are sufficient.

Step 3: Commit and Push Changes

Add the .gitlab-ci.yml file to your repository and commit the changes:

git add .gitlab-ci.yml
git commit -m "Add GitLab CI configuration"
git push origin main

Once pushed, GitLab will automatically detect the .gitlab-ci.yml file and start the CI pipeline.

Step 4: Monitor the Pipeline

Navigate to your project's CI/CD > Pipelines section in GitLab to monitor the pipeline's progress. You can view logs, artifacts, and pipeline statuses.

Advanced Configuration

GitLab CI offers extensive configurations to match your project's needs.

Using Cache

Caching reduces pipeline execution time by reusing downloaded dependencies.

cache:
  paths:
    - node_modules/

test_job:
  stage: test
  script:
    - npm install
    - npm test

Multiple Environments

Define different jobs for various environments like development, staging, and production.

stages:
  - test
  - deploy

deploy_staging:
  stage: deploy
  script:
    - npm run build
    - scp -r ./build user@staging-server:/var/www/app
  only:
    - main

Parallel Testing

Run tests in parallel to speed up the pipeline.

test_job:
  stage: test
  script:
    - npm install
    - npm test
  parallel: 4

Environment Variables

Securely manage sensitive data using environment variables.

  1. Go to Settings > CI/CD > Variables in your GitLab project.
  2. Add variables like API_KEY, DB_PASSWORD, etc.
  3. Access them in your .gitlab-ci.yml:
script:
  - npm run deploy -- --api-key=$API_KEY

Best Practices for GitLab CI with Node.js

  • Lock Node.js Version: Use a specific Node.js version to avoid inconsistencies.

    image: node:14.17.0

  • Use Linting and Formatting: Add linting steps to maintain code quality.

    script:
  - npm run lint
  - npm test

  • Implement Testing Strategies: Include unit, integration, and end-to-end tests.

  • Optimize Pipeline Speed: Only run necessary stages for specific branches or commits.

    only:
  - merge_requests
  - main

  • Artifacts and Dependencies: Manage build artifacts and dependencies efficiently.

    artifacts:
  paths:
    - build/

Troubleshooting Common Issues

Pipeline Fails Due to Missing Dependencies

Ensure that all dependencies are listed in your package.json and that you're using npm install or yarn install correctly.

Permission Denied Errors

Check file permissions and consider using chmod in your script:

script:
  - chmod +x ./deploy.sh
  - ./deploy.sh

Environment Variable Not Found

Verify that environment variables are correctly set in GitLab and that you're referencing them properly in the script.

Integrating Docker with GitLab CI

For applications that need to be containerized, you can integrate Docker into your GitLab CI pipeline.

image: docker:stable

services:
  - docker:dind

variables:
  DOCKER_DRIVER: overlay2

build_docker_image:
  stage: build
  script:
    - docker build -t my-node-app .
    - docker push my-node-app
  only:
    - main

Explanation:

  • services: Uses Docker-in-Docker to build images.
  • variables: Sets the Docker driver.
  • script: Builds and pushes the Docker image.

Conclusion

Implementing GitLab CI in your Node.js projects can significantly enhance your development workflow by automating testing, building, and deployment processes. By following the steps outlined in this guide and adopting best practices, you can set up a robust CI pipeline that accelerates development and maintains high code quality.

Embrace Continuous Integration with GitLab CI today and take your Node.js applications to the next level.

Additional Resources

Glossary

  • Continuous Integration (CI): A development practice where developers integrate code changes frequently.
  • GitLab Runner: An application that executes CI jobs with GitLab CI/CD.
  • Pipeline: A collection of stages and jobs executed in a specific order.

Resume

Experience

  • SecurityScoreCard

    Nov. 2023 - Present

    New York, United States

    Senior Software Engineer

    I joined SecurityScorecard, a leading organization with over 400 employees, as a Senior Full Stack Software Engineer. My role spans across developing new systems, maintaining and refactoring legacy solutions, and ensuring they meet the company's high standards of performance, scalability, and reliability.

    I work across the entire stack, contributing to both frontend and backend development while also collaborating directly on infrastructure-related tasks, leveraging cloud computing technologies to optimize and scale our systems. This broad scope of responsibilities allows me to ensure seamless integration between user-facing applications and underlying systems architecture.

    Additionally, I collaborate closely with diverse teams across the organization, aligning technical implementation with strategic business objectives. Through my work, I aim to deliver innovative and robust solutions that enhance SecurityScorecard's offerings and support its mission to provide world-class cybersecurity insights.

    Technologies Used:

    Node.js Terraform React Typescript AWS Playwright and Cypress