jmcdo29 / jmcdo29/nest-docker-template

[Feature] Improve GitHub CI for Dockerfile

Open
#20 4 comments 0 reactions 0 assignees View on GitHub
Dominant language
TypeScript
Stars
41
Forks
5
PR merge metrics
No merged PRs in 30d

Description

I think could be a great idea to have a GitHub CI to check Dockerfile build issues. Do you agree?

I never did specifically something like it before but I think it is totally possible:
1. Pull Oficial NestJS Repository (https://github.com/nestjs/nest)
2. Change directory to "nest/sample/01-cats-app"
3. Replace sample nestjs project Dockerfile (if exists)
4. Run unit tests

This can detect problems in libraries like Prisma and bcryptjs in some circumstances.

Possible problem: A bug in the NestJS sample repository can lead to a "wrong" failed to build. I don't think because is a relevant problem because:
1. This probability only will happen when NodeJS has a breaking change (e.g. change from NodeJS v16 -> v17)
2. You can use the sha256 commit hash to pull the GitHub repository at a specific point in the history but I think we can test this approach first and check if is necessary later.
3. You can only remove this CI later. No other change is necessary 😁
4. @jmcdo29 is a relevant contributor on the NestJS project and can help if something breaks out 😁

What do you think? Can I develop this integration (CI) and submit a PR? Is it a good idea?

Contributor guide

No contributing guide indexed for this repository

Research direction

The proposal names GitHub CI, the Dockerfile, and nest/sample/01-cats-app in the NestJS repository; start by inspecting the repository's CI configuration and the sample application's Dockerfile and tests. Define how the NestJS revision is selected and what build or test failures should fail CI; done means the workflow detects relevant Dockerfile and unit-test problems without treating unrelated sample-repository failures as project failures.

Written by the indexing model from the issue text.

Assessment

Tech stack
docker, github-actions, node.js, typescript
Domain
build-system, ci-cd, testing
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.