refactor(ci): to not use circleci but only github by tdeekens · Pull Request #1936 · commercetools/nodejs

tdeekens · 2025-03-17T14:39:42Z

Summary

This repository contains library code mainly. We settled on using GitHub Actions for these kind of repos. At the same time this repo already used GitHub Actions for releasing the library. In addition to using CircleCI for building, testing and linting. This duality of CI is not ideal and should be homogenized.

For this to work I imported credentials from CircleCI to GitHub. I also updated some very old documentation links I found.

One approved the branch protection will be updated. Then the CircleCI project delted.

changeset-bot · 2025-03-17T14:39:56Z

⚠️ No Changeset found

Latest commit: b70124a

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

codecov · 2025-03-17T15:32:56Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 97.76%. Comparing base (5c86d1b) to head (b70124a).
Report is 1 commits behind head on master.

Additional details and impacted files

@@           Coverage Diff           @@
##           master    #1936   +/-   ##
=======================================
  Coverage   97.76%   97.76%           
=======================================
  Files         147      147           
  Lines        4786     4786           
  Branches     1283     1283           
=======================================
  Hits         4679     4679           
  Misses        104      104           
  Partials        3        3

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Copilot

Pull Request Overview

This PR refactors the CI/CD configuration by removing CircleCI support and standardizing on GitHub Actions across the repository. Key changes include:

Introducing a composite GitHub Action in .github/actions/ci/action.yml for dependency installation and Node.js setup.
Creating new GitHub Actions workflows for quality checks and regression testing.
Updating release workflows and documentation to reference GitHub Actions instead of CircleCI/Travis.

Reviewed Changes

Copilot reviewed 8 out of 8 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
.github/actions/ci/action.yml	Adds a composite GitHub Action to install dependencies
.github/workflows/quality.yml	Adds a workflow for linting, type checking, and testing
.github/workflows/regression.yml	Adds a workflow for regression testing with multiple Node.js versions
docs/README.md	Updates CI badge from Travis CI to GitHub Actions
.github/workflows/release.yml	Refactors the release workflow to use the new composite action
docs/cli/csv-parser-price.md	Replaces Travis with GitHub Actions CI badge
docs/cli/csv-parser-orders.md	Replaces Travis with GitHub Actions CI badge

docs/cli/csv-parser-price.md

docs/cli/csv-parser-orders.md

tdeekens · 2025-03-17T18:53:04Z

.github/actions/ci/action.yml

@@ -0,0 +1,22 @@
+name: CI


This is re-used among the actions.

tdeekens · 2025-03-17T18:53:23Z

.github/workflows/quality.yml

+  pull_request:
+
+jobs:
+  linting:


We start with lining. So static analysis.

tdeekens · 2025-03-17T18:53:34Z

.github/workflows/quality.yml

+      - name: Lint
+        run: pnpm lint
+
+  type-checking:


Type checking runs in parallel.

tdeekens · 2025-03-17T18:53:45Z

.github/workflows/quality.yml

+
+  testing:
+    name: Testing
+    needs: [linting, type-checking]


We only test once our static analysis finished.

tdeekens · 2025-03-17T18:54:23Z

.github/workflows/quality.yml

+      - name: Integration tests
+        run: pnpm test:integration
+
+  regression-testing:


We isolate out the integration tests. The idea is that we consider this regression testing. Where we run on the nvmrc's version of Node.js before. Then we test if our changes cause regressions on older versions of Node.js

tdeekens · 2025-03-17T18:54:47Z

.github/workflows/quality.yml

+      matrix:
+        version: [18, 20]
+      fail-fast: true
+      max-parallel: 1


This is important. We run against one project in integration tests. We can't run in parallel.

tdeekens · 2025-03-17T18:54:58Z

docs/README.md

 <p align="center">
-  <a href="https://travis-ci.org/commercetools/nodejs">
-    <img alt="Travis CI Status" src="https://img.shields.io/travis/commercetools/nodejs/master.svg?style=flat-square&label=travis">
+  <a href="https://github.com/commercetools/nodejs/actions">


Noticed. These were wrong for a long time.

tdeekens · 2025-03-18T07:36:53Z

Note, that tests all pass. The failure indication is due to the configured branch protections which I would change once this is approved.

ajimae · 2025-03-18T10:09:21Z

.github/workflows/quality.yml

+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        version: [18, 20]


I think it will be better if we set this matrix to [20, 22], since 18 is now in maintenance mode.

We test 22 in the regular testing flow. That's defined in the .nvmrc and what we develop with. v18 is not EoL and we officially still support it. Hence I would argue to also regression test for it. If we drop it, we should officially do so using the engines field and a major release. Keep in mind that with the latest major release we require >= Node.js v18 - prior we said to support v12 even.

Hope this makes sense. In a nutshell: let's not release major and deprecate Node.js v18 support in a migration to GitHub Actions.

Sure, this make sense.

ajimae · 2025-03-18T10:29:46Z

I believe we will also need to migrate over the secrets/env variables for the integration tests, and remove the nodejs repository from the list of CircleCI projects and also in list of configured apps on Github (I don't have the permission to do this though). I can see it's still trying to run these tests without its configuration file. I can help with the secrets for the test.

tdeekens · 2025-03-18T10:34:03Z

I believe we will also need to migrate over the secrets/env variables for the integration tests, and remove the nodejs repository from the list of CircleCI projects and also in list of configured apps on Github (I don't have the permission to do this though). I can see it's still trying to run these tests without its configuration file. I can help with the secrets for the test.

I've migrated everything over and tests run to completion on the PR. If you approve the PR I would take care of the clean up and remove CircleCI entirely.

ajimae · 2025-03-18T10:35:47Z

I believe we will also need to migrate over the secrets/env variables for the integration tests, and remove the nodejs repository from the list of CircleCI projects and also in list of configured apps on Github (I don't have the permission to do this though). I can see it's still trying to run these tests without its configuration file. I can help with the secrets for the test.

I've migrated everything over and tests run to completion on the PR. If you approve the PR I would take care of the clean up and remove CircleCI entirely.

I just saw this now, awesome 🎉 🎉

tdeekens · 2025-03-18T10:36:50Z

I believe we will also need to migrate over the secrets/env variables for the integration tests, and remove the nodejs repository from the list of CircleCI projects and also in list of configured apps on Github (I don't have the permission to do this though). I can see it's still trying to run these tests without its configuration file. I can help with the secrets for the test.

I've migrated everything over and tests run to completion on the PR. If you approve the PR I would take care of the clean up and remove CircleCI entirely.

I just saw this now, awesome 🎉 🎉

Is this the stamp or approval? 😆

ajimae

LGTM

tdeekens · 2025-03-18T10:39:21Z

CircleCI won't build anymore
Branch protection updated to reflect GitHub

Merging now and cleaning up secrets in CircleCI.

barbara79 · 2025-03-18T14:16:32Z

Thank you! sorry for the delay LGTM

* refactor(ci): to not use circleci but only github * refactor: to have one regression job

tdeekens requested review from barbara79 and Copilot March 17, 2025 16:09

tdeekens self-assigned this Mar 17, 2025

Copilot AI reviewed Mar 17, 2025

View reviewed changes

docs/cli/csv-parser-price.md Outdated Show resolved Hide resolved

docs/cli/csv-parser-orders.md Outdated Show resolved Hide resolved

refactor(ci): to not use circleci but only github

0d2a583

tdeekens force-pushed the drop-circleci branch from 711bab8 to 0d2a583 Compare March 17, 2025 18:40

refactor: to have one regression job

b70124a

tdeekens commented Mar 17, 2025

View reviewed changes

tdeekens requested a review from islam3zzat March 17, 2025 18:55

tdeekens marked this pull request as ready for review March 17, 2025 19:03

ajimae reviewed Mar 18, 2025

View reviewed changes

ajimae approved these changes Mar 18, 2025

View reviewed changes

tdeekens merged commit 01e862a into master Mar 18, 2025
10 of 11 checks passed

tdeekens deleted the drop-circleci branch March 18, 2025 10:39

barbara79 pushed a commit that referenced this pull request Mar 19, 2025

refactor(ci): to not use circleci but only github (#1936)

c23d6fe

* refactor(ci): to not use circleci but only github * refactor: to have one regression job

Conversation

tdeekens commented Mar 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Uh oh!

changeset-bot bot commented Mar 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

⚠️ No Changeset found

Uh oh!

codecov bot commented Mar 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

tdeekens commented Mar 18, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ajimae commented Mar 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

tdeekens commented Mar 18, 2025

Uh oh!

ajimae commented Mar 18, 2025

Uh oh!

tdeekens commented Mar 18, 2025

Uh oh!

ajimae left a comment

Choose a reason for hiding this comment

Uh oh!

tdeekens commented Mar 18, 2025

Uh oh!

Uh oh!

barbara79 commented Mar 18, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

tdeekens commented Mar 17, 2025 •

edited

Loading

changeset-bot bot commented Mar 17, 2025 •

edited

Loading

codecov bot commented Mar 17, 2025 •

edited

Loading

ajimae commented Mar 18, 2025 •

edited

Loading