Skip to content
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.

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

story: refactor Node dependency pins #295

Open
15 tasks
wesley-dean-flexion opened this issue May 14, 2024 · 0 comments
Open
15 tasks

story: refactor Node dependency pins #295

wesley-dean-flexion opened this issue May 14, 2024 · 0 comments
Assignees

Comments

@wesley-dean-flexion
Copy link
Collaborator

wesley-dean-flexion commented May 14, 2024

Describe the User Story

As a security engineer, so that Node dependencies can be managed by automated tooling (e.g., Depenabot, Renovate, npm audit, etc.), I would like Node dependencies specifications to be removed from source files (e.g., the Dockerfile) and placed, instead, in a file intended for dependency tracking (e.g., package.json).

Acceptance Criteria

Definition of Done

  • Acceptance criteria met
  • Usability tests passed - this user story should be easy to use by real users
  • Code refactored for clarity - code must be clean, self-documenting code
  • Dependency Rule followed - higher-level code should not depend directly on lower-level code
  • Source code merged
  • Unit test coverage of our code > 90%
  • Security reviewed and reported - includes vulnerability and compliance scanning
  • Code quality checks passed
  • Build process updated if needed
  • API documentation updated if needed

Additional Information

If a package.json (or similar.. whatever) approach is used, the setup action becomes more generalized from "install this version of this package" to "install the required dependencies"

steps:
- uses: actions/setup-node@v4
- run: npm ci

This applies not only to GitHub Actions at runtime, but also Docker image builds. So, it would go from

RUN npm install ...

to

WORKDIR /destination/
COPY file /destination/
RUN npm ci

Related Feature Request

#257

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants