devicons/devicon

[FEATURE REQUEST] Build and Test via Github Actions

Open

#1,389 opened on Sep 22, 2022

View on GitHub
 (2 comments) (1 reaction) (0 assignees)CSS (11,625 stars) (2,448 forks)batch import
devopsgood first issue

Description

Would be nice if each PR triggered a build and test of the branch. That way it would be a bit more robust, and less likely to let through bugs that crash the site. Especially useful for dependency updates.

As referenced here:

@Panquesito7 did you test it locally? Also, did you see the changelog?

I haven't tested it locally (we could use Gitpod to deploy the page, though). The changelog or commits seem to be to fix a security issue. https://github.com/devicons/devicon/security/dependabot/6

No need to deploy imo. Just a simple build and run would suffice. If it runs, and the code checks are all green, it probably should work.

We could add a build step to the CodeQL workflow though. Maybe just add npm ci, npm build and npm test? Can probably just be added as a replacement of these lines: https://github.com/devicons/devicon/blob/1119b9f84c0290e0f0b38982099a2bd027a48bf1/.github/workflows/codeql-analysis.yml#L45-L55

Originally posted by @Snailedlt in https://github.com/devicons/devicon/issues/1385#issuecomment-1254783495

Contributor guide

Tech stack
cssjavascriptgithub actions
Domain
ci cddevopstooling
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
basic knowledge of GitHub Actionsfamiliarity with npm commands
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75
Research direction
The issue requests adding a build and test step to the existing CodeQL workflow. Start by examining the current workflow file at .github/workflows/codeql analysis.yml, specifically lines 45-55. Then, add steps for 'npm ci', 'npm run build' (if a build script exists), and 'npm test' after the 'Initialize CodeQL' step. Ensure the workflow triggers on pull requests to the main branch. Refer to the original comment for context and test the changes locally or in a fork.