Skip to content

CI workflow refactor #52

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 18 commits into
base: master
Choose a base branch
from
Open

CI workflow refactor #52

wants to merge 18 commits into from
+250 −182

Conversation

mertssmnoglu
Copy link

@mertssmnoglu mertssmnoglu commented May 17, 2025 •
edited
Loading

Call for Contribution, Coveralls Page

This PR is created for making the CI pipeline stable again for future developments. The changes are very similar to express's CI pipeline to make sure expressjs organization follows the same or similar CI conditions.

Inspired by expressjs/express#5599 and compression ci

Changes Summary

  • Add specific lint job for the CI
  • Set default action permission to contents: read
  • Use SHA hashes for action versions
  • Cover all available nodejs releases
    • nodejs 0.8, 0.10, 0.12
    • iojs 1.8, 2.5, 3.3
    • nodejs 4 to 24
  • Prefer ubuntu-latest as a base runner.
  • Use capitalized run names. like Lint, Test and Coverage

zizmor report

 INFO zizmor: skipping impostor-commit: can't run without a GitHub API token
 INFO zizmor: skipping ref-confusion: can't run without a GitHub API token
 INFO zizmor: skipping known-vulnerable-actions: can't run without a GitHub API token
 INFO zizmor: skipping forbidden-uses: audit not configured
 INFO zizmor: skipping stale-action-refs: can't run without a GitHub API token
 INFO audit: zizmor: 🌈 completed .github/workflows/ci.yml
No findings to report. Good job!

Questions ❓

Do we want manual workflow triggering?

@mertssmnoglu
build(ci): add lint job to CI workflow
aee8b6b 
Signed-off-by: Mert Şişmanoğlu <mertssmnoglu@gmail.com>
@mertssmnoglu
build(ci): update coverage job to include permissions and use specifi…
72cf486 
…c action versions

Signed-off-by: Mert Şişmanoğlu <mertssmnoglu@gmail.com>
@bjohansebas
Copy link
Member

Is using latest version of ubuntu is a good practice? What about using ubuntu-24.04?

Yes, it's a good practice, especially in open source, since it reduces our maintenance burden. GitHub has secure machines, so there's no risk.

Should we remove deprecated node (and io.js) versions from the test matrix?

Nope, in Express there's another CI (see https://github.com/expressjs/express/blob/4.x/.github/workflows/iojs.yml), which covers support for io.js

@mertssmnoglu
build(ci): add iojs CI workflow to cover iojs tests
14e2be0 
Signed-off-by: Mert Şişmanoğlu <mertssmnoglu@gmail.com>
@mertssmnoglu
Copy link
Author

Should we remove deprecated node (and io.js) versions from the test matrix?

Nope, in Express there's another CI (see https://github.com/expressjs/express/blob/4.x/.github/workflows/iojs.yml), which covers support for io.js

I didn't notice this, thanks you so much.
14e2be0 This is basically a copy of the express 4.x iojs ci with package read permission and version fixings.

@mertssmnoglu
build(ci): remove unnecessary 'npm install' step from iojs CI workflow
423ade6 
- vhost package has 0 core dependency

Signed-off-by: Mert Şişmanoğlu <mertssmnoglu@gmail.com>
@mertssmnoglu
Copy link
Author

iojs CI is failing when the step runs 'npm install'
Can it be a dependency problem?

npm install

npm ERR! Linux 6.11.0-1014-azure
npm ERR! argv "/home/runner/.nvm/versions/io.js/v1.8.4/bin/iojs" "/home/runner/.nvm/versions/io.js/v1.8.4/bin/npm" "install"
npm ERR! node v1.8.4
npm ERR! npm  v2.9.0
npm ERR! path /home/runner/work/vhost/vhost/node_modules/eslint-plugin-markdown/node_modules/mdast-util-from-markdown/node_modules/@types/mdast/package.json
npm ERR! code ENOTDIR
npm ERR! errno -20
npm ERR! syscall open

npm ERR! ENOTDIR: not a directory, open '/home/runner/work/vhost/vhost/node_modules/eslint-plugin-markdown/node_modules/mdast-util-from-markdown/node_modules/@types/mdast/package.json'
npm ERR! 
npm ERR! If you need help, you may report this error at:
npm ERR!     <https://github.com/npm/npm/issues>

npm ERR! Please include the following file with any support request:
npm ERR!     /home/runner/work/vhost/vhost/npm-debug.log
Error: Process completed with exit code 236.

I removed 'npm install' steps because vhost has 0 dependency. 423ade6

@bjohansebas
Copy link
Member

I removed 'npm install' steps because vhost has 0 dependency

We still need to install the devDependencies to run the tests. So that command is necessary

We need to remove the linter for those versions :), like it’s being done in compression (https://github.com/expressjs/compression/blob/5f13b148d2a1a2daaa8647e03592214bb240bf18/.github/workflows/ci.yml#L204).

@mertssmnoglu
build(ci): enhance CI workflow with concurrency and update Node.js ve…
7ff64c3 
…rsions

- update trigger on
- concurrency
- permissions
- pinned action versions

Signed-off-by: Mert Şişmanoğlu <mertssmnoglu@gmail.com>
@mertssmnoglu
build(ci): update download-artifact action to version 4.3.0 for colle…
e05092a 
…cting coverage reports

Signed-off-by: Mert Şişmanoğlu <mertssmnoglu@gmail.com>
@mertssmnoglu
build(ci): add names to test and coverage jobs for clarity
75d8337 
Signed-off-by: Mert Şişmanoğlu <mertssmnoglu@gmail.com>
@mertssmnoglu
Copy link
Author

We need to remove the linter for those versions :), like it’s being done in compression (https://github.com/expressjs/compression/blob/5f13b148d2a1a2daaa8647e03592214bb240bf18/.github/workflows/ci.yml#L204).

Okay. So this CI is similar to compress

I was thinking about using 2 separate workflow like in express but I think ci.yml will cover all versions. If everything goes well I can remove iojs.yml from this PR.

(ℹ️ I couldn't test it locally with act because it's ubuntu images are a bit different)

@mertssmnoglu mertssmnoglu marked this pull request as ready for review May 20, 2025 20:31
@mertssmnoglu
build(ci): disable credential persistence for checkout actions
c912f90 
Signed-off-by: Mert Şişmanoğlu <mertssmnoglu@gmail.com>
@mertssmnoglu mertssmnoglu mentioned this pull request May 20, 2025
Merged
bjohansebas
bjohansebas reviewed May 24, 2025
View reviewed changes
@UlisesGascon
Copy link
Member

We are almost there! Great work @mertssmnoglu!

Seems like we need to fix the artifacts (ref):

Run actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02
With the provided path, there will be 2 files uploaded
Artifact name is valid!
Root directory input is valid!
Error: Failed to CreateArtifact: Received non-retryable error: Failed request: (409) Conflict: an artifact with this name already exists on the workflow run

@UlisesGascon
Copy link
Member

I solved the conflicts that I generated when I merged #50 👍

@UlisesGascon UlisesGascon mentioned this pull request Jun 5, 2025
Closed
bjohansebas
bjohansebas reviewed Jun 6, 2025
View reviewed changes
mertssmnoglu and others added 2 commits June 6, 2025 14:05
@mertssmnoglu @bjohansebas
fix(ci): redundant 'permissions' field
e724829 
Co-authored-by: Sebastian Beltran <bjohansebas@gmail.com>
@mertssmnoglu
style(ci): format ci.yml
866cfe7 
Signed-off-by: Mert Şişmanoğlu <mertssmnoglu@gmail.com>
@mertssmnoglu
Copy link
Author

mertssmnoglu commented Jun 6, 2025 •
edited
Loading

We are almost there! Great work @mertssmnoglu!

Seems like we need to fix the artifacts (ref):

Run actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02
With the provided path, there will be 2 files uploaded
Artifact name is valid!
Root directory input is valid!
Error: Failed to CreateArtifact: Received non-retryable error: Failed request: (409) Conflict: an artifact with this name already exists on the workflow run

I found a solution(walkaround) actions/upload-artifact#480 (comment)
0568f26

@mertssmnoglu
fix(ci): avoid coverage artifact conflicts and enable merging of mult…
0568f26 
…iple reports

Signed-off-by: Mert Şişmanoğlu <mertssmnoglu@gmail.com>
@mertssmnoglu
Copy link
Author

mertssmnoglu commented Jun 6, 2025 •
edited
Loading

Do you want manual workflow triggering? @bjohansebas

Added b79cf04

@mertssmnoglu
fix(ci): remove multiple artifact merge step
5306ea7 
Signed-off-by: Mert Şişmanoğlu <mertssmnoglu@gmail.com>
mertssmnoglu
mertssmnoglu commented Jun 6, 2025
View reviewed changes
.github/workflows/ci.yml
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think merge-multiple does the same job in the previous step. Removed Merge coverage reports extra step for testing purposes. If CI fails I will remove merge-multiple and re-add extra step.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I removed merge-multiple and re-add this 'Merge coverage reports' extra step

37b35a3

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it seems the coverage still isn't working properly, it's strange

@mertssmnoglu
fix(ci): add 'Merge coverage reports' step
37b35a3 
Signed-off-by: Mert Şişmanoğlu <mertssmnoglu@gmail.com>
@mertssmnoglu
feat(ci): enable manual triggering of workflows with workflow_dispatch
b79cf04 
Signed-off-by: Mert Şişmanoğlu <mertssmnoglu@gmail.com>
bjohansebas
bjohansebas reviewed Jun 28, 2025
View reviewed changes
mertssmnoglu and others added 2 commits July 12, 2025 09:46
@mertssmnoglu
fix(ci): update coverage report paths to use node version instead of …
521e19f 
…name

Signed-off-by: Mert Şişmanoğlu <mertssmnoglu@gmail.com>
@mertssmnoglu @bjohansebas
fix(ci): remove pull request types
9b581ed 
Co-authored-by: Sebastian Beltran <bjohansebas@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@bjohansebas bjohansebas bjohansebas left review comments

@rxmarbles rxmarbles rxmarbles approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@mertssmnoglu @bjohansebas @UlisesGascon @rxmarbles
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy