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

Update CONTRIBUTING.md for how to set up a Docker builder #4668

Merged
merged 2 commits into from
Apr 19, 2024

Conversation

louislam
Copy link
Owner

Previously, I was using buildkit (qemu) to build arm64/armv7 docker image.

However, for some reason, it is no longer working for arm64. It is extremely slow and npm ci --omit=dev always failed with npm ERR! errno ECONNRESET error. Tested on different PCs and different networks. Maybe our package-lock.json is getting big now.

To overcome the issue, now I set up a special Docker builder which will pass the arm64 build job to my real arm64 machine.

@@ -490,3 +490,30 @@ We have a few procedures we follow. These are documented here:

</p>
</details>

### Set up a Docker Builder
Copy link
Collaborator

Choose a reason for hiding this comment

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

Can we wrap this in a <details> block as the other ones above or move this to the Release part of the contribution guide? (making who we are adressing in this clearer)


### Set up a Docker Builder

- amd64, armv7 using local.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Bit unclear what is being documented here. what are these bullet points?

An introductory sentence why one would need/want to set up a docker builder might be helpfull for other devs that did not read this PR.

Copy link
Owner Author

Choose a reason for hiding this comment

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

It is a Docker config that is for me to build the multi arch images. Probably for myself only, can be improved if anyone else need this later.

CONTRIBUTING.md Outdated Show resolved Hide resolved
@CommanderStorm CommanderStorm added the area:documentation Improvements or additions to documentation label Apr 12, 2024
Co-authored-by: Frank Elsinga <frank@elsinga.de>
@louislam louislam marked this pull request as ready for review April 19, 2024 09:37
@louislam louislam merged commit 2957534 into master Apr 19, 2024
5 checks passed
@CommanderStorm CommanderStorm added this to the 2.0.0 milestone May 28, 2024
@CommanderStorm CommanderStorm deleted the louislam-patch-1 branch October 4, 2024 00:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants