fix(docker): Resolve build failure and clarify documentation #1783
Conversation
…ck to use the correct Yarn version and copying the yarn.lock file to satisfy the --immutable install flag. Fixes json-schema-org#1782
…-org#1782 Revised the Docker section to provide clearer, step-by-step instructions for building and running the development environment using Docker. Added details about directory navigation, image naming, port mapping, and live code updates.
This comment was marked as outdated.
This comment was marked as outdated.
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
There was a problem hiding this comment.
Welcome to the JSON Schema Community. Thanks a lot for creating your first pull request!! 🎉🎉 We are so excited you are here! We hope this is only the first of many! For more details check out README.md file.
This comment was marked as outdated.
This comment was marked as outdated.
built with Refined Cloudflare Pages Action⚡ Cloudflare Pages Deployment
|
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #1783 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 31 31
Lines 636 636
Branches 196 196
=========================================
Hits 636 636 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
This comment was marked as outdated.
This comment was marked as outdated.
3 similar comments
|
Hi @elyashium! Thanks a lot for your contribution! I noticed that the following required information is missing or incomplete: kind of change description Please update the PR description to include this information. You can find placeholders in the PR template for these items. Thanks a lot! |
|
Hi @elyashium! Thanks a lot for your contribution! I noticed that the following required information is missing or incomplete: kind of change description Please update the PR description to include this information. You can find placeholders in the PR template for these items. Thanks a lot! |
|
Hi @elyashium! Thanks a lot for your contribution! I noticed that the following required information is missing or incomplete: kind of change description Please update the PR description to include this information. You can find placeholders in the PR template for these items. Thanks a lot! |
This comment was marked as outdated.
This comment was marked as outdated.
What kind of change does this PR introduce?
A bugfix for the Docker build process and a documentation update.
Issue Number:
Screenshots/videos:
If relevant, did you update the documentation?
Yes, the
INSTALLATION.mdfile has been updated to provide clearer and more accurateinstructions for running the project with Docker.
Summary
This pull request resolves a critical failure in the Docker build process. The build was
failing for two reasons:
Dockerfiledid not enablecorepack, leading to a Yarn version mismatch as specifiedin
package.json.Dockerfiledid not copy theyarn.lockfile, causing theyarn install --immutablecommand to fail as it requires the lockfile to be present.
This PR corrects the
Dockerfileby adding the necessarycorepack enablecommand andincluding
yarn.lockin the files copied to the image.Additionally, the "Run locally using Docker" section of
INSTALLATION.mdhas beenrewritten to be more explicit, removing the reliance on
makeand providing direct,cross-platform
dockercommands to improve clarity and accessibility for all developers.Does this PR introduce a breaking change?
No, this PR fixes a broken process and makes it work as intended.
Checklist
Please ensure the following tasks are completed before submitting this pull request.