This repository has been archived by the owner on Aug 21, 2024. It is now read-only.
Fixed and improved Docker build caching. #7988
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
barankyle
force-pushed
the
docker-build-cache
branch
2 times, most recently
from
58f6be6
to
c2014ae
Compare
barankyle
requested review from
HexaField and
hanzlamateen
and removed request for
HexaField
| @@ -71,8 +71,8 @@ | |||
| const buildErrors = fs.readFileSync(`${options.service}-build-error.txt`).toString() | |||
| const builderRun = fs.readFileSync('builder-run.txt').toString() | |||
| if (options.isDocker) { | |||
| const hasError = /ERROR:/.test(buildErrors) | |||
| if (hasError) { | |||
| const cacheMissRegex = new RegExp(`${options.service}:latest_${process.env.RELEASE_NAME}: not found`) | |||
Check failure
Code scanning / CodeQL
Regular expression injection
HexaField
reviewed
May 18, 2023
Builder build process caching was not working because it was a multi-stage build. The default inline cache only caches the final stage of a multi-stage build, which almost always results in cache misses on the earlier stages. All builds in the builder were not being cached at all. Converted builds to explicitly use buildx. buildx build has support for automatically pushing tags, so separate steps for tagging and pushing images have been removed. In order to cache multi-stage builds, buildx has an option to cache everything. This has to be done with a cache target of something other than inline cache (which includes cache in the image). There is an option to use a Docker repository, but currently this is not supported by ECR. For now, using S3 as the cache target (another built-in option) for service images, and GH Actions cache for builder image. An issue has been opened to switch to the repo for the service images once it's supported. Commented out running npm install when each project is installed. This appeared to be causing issues where some packages, particularly semver, were not fully installed properly by the end, leading to errors when those packages were referenced. There is now a single npm install after installing all projects.
barankyle
force-pushed
the
docker-build-cache
branch
from
c2014ae
to
a58f421
Compare
hanzlamateen
approved these changes
May 18, 2023
| - name: restore package.json | ||
| run: mv package.jsonmoved package.json | ||
| - name: Expose GitHub Runtime | ||
| uses: crazy-max/ghaction-github-runtime@v2 |
There was a problem hiding this comment.
crazy-max/ghaction-github-runtime@v2 is used to access STORAGE_AWS_ACCESS_KEYs?
There was a problem hiding this comment.
It's actually to access some GitHub Actions environment variables used for caching Docker cache within GH Actions.
There was a problem hiding this comment.
It's actually to access some GitHub Actions environment variables used for caching Docker cache within GH Actions.
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Builder build process caching was not working because it was a multi-stage build.
The default inline cache only caches the final stage of a multi-stage build, which
almost always results in cache misses on the earlier stages. All builds in the builder
were not being cached at all.
Converted builds to explicitly use buildx. buildx build has support for automatically
pushing tags, so separate steps for tagging and pushing images have been removed.
In order to cache multi-stage builds, buildx has an option to cache everything. This
has to be done with a cache target of something other than inline cache (which includes
cache in the image). There is an option to use a Docker repository, but currently this
is not supported by ECR. For now, using S3 as the cache target (another built-in option)
for service images, and GH Actions cache for builder image.
An issue has been opened to switch to the repo for the service images once it's supported.
Commented out running npm install when each project is installed. This appeared to be causing
issues where some packages, particularly semver, were not fully installed properly by the
end, leading to errors when those packages were referenced. There is now a single npm
install after installing all projects.
References
closes #insert number here
Checklist
QA Steps
List any additional steps required to QA the changes of this PR, as well as any supplemental images or videos.