jprdonnelly/docs
1
0
Fork 0
mirror of synced 2025-12-19 09:57:42 -05:00
Code Issues Projects Releases Wiki Activity

Shave a minute off of Docker image build (#54478)

Browse Source
This commit is contained in:
Kevin Heis
2025-02-20 10:44:49 -08:00
committed by GitHub
parent ae3589cbbb
commit eed068d058
6 changed files with 81 additions and 167 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
.dockerignore
View File

@@ -8,5 +8,4 @@ node_modules/
tests/ tests/
# Folder is cloned during the preview + prod workflows, the assets are merged into other locations for use before the build # Folder is cloned during the preview + prod workflows, the assets are merged into other locations for use before the build
docs-early-access/ docs-early-access/
# During the preview deploy untrusted user code may be cloned into this directory README.md
user-code/

3
.gitignore vendored
View File

@@ -27,9 +27,6 @@ broken_links.md
# still have these files on their disk. # still have these files on their disk.
lib/redirects/.redirects-cache*.json lib/redirects/.redirects-cache*.json
# During the preview deploy untrusted user code may be cloned into this directory
# We ignore it from git to keep things deterministic
user-code/
# Logs from scripts # Logs from scripts
*/logs/ */logs/

187
Dockerfile
View File

@@ -1,44 +1,46 @@
# This Dockerfile is used solely for production deployments to Moda # This Dockerfile is used solely for production deployments to Moda
# For staging deployments, see src/deployments/staging/Dockerfile
# For building this file locally, see src/deployments/production/README.md # For building this file locally, see src/deployments/production/README.md
# Environment variables are set in the Moda configuration:
# config/moda/configuration/*/env.yaml
# -------------------------------------------------------------------------------- # ---------------------------------------------------------------
# BASE IMAGE # BASE STAGE: Install linux dependencies and set up the node user
# -------------------------------------------------------------------------------- # ---------------------------------------------------------------
# To update the sha: # To update the sha:
# https://github.com/github/gh-base-image/pkgs/container/gh-base-image%2Fgh-base-noble # https://github.com/github/gh-base-image/pkgs/container/gh-base-image%2Fgh-base-noble
FROM ghcr.io/github/gh-base-image/gh-base-noble:20250131-172559-g0fd5a2edc AS base FROM ghcr.io/github/gh-base-image/gh-base-noble:20250131-172559-g0fd5a2edc AS base
# Install curl for Node install and determining the early access branch
# Install git for cloning docs-early-access & translations repos # Install git for cloning docs-early-access & translations repos
# Install curl for determining the early access branch
RUN apt-get -qq update && apt-get -qq install --no-install-recommends git curl
# Install Node.js latest LTS # Install Node.js latest LTS
# https://github.com/nodejs/release#release-schedule # https://github.com/nodejs/release#release-schedule
# Ubuntu's apt-get install nodejs is _very_ outdated # Ubuntu's apt-get install nodejs is _very_ outdated
RUN curl -sL https://deb.nodesource.com/setup_22.x | bash - # Must run as root
RUN apt-get install -y nodejs RUN apt-get -qq update && apt-get -qq install --no-install-recommends curl git \
RUN node --version && curl -sL https://deb.nodesource.com/setup_22.x | bash - \
&& apt-get install -y nodejs \
&& node --version
# This directory is owned by the node user # Create the node user and home directory
RUN useradd -ms /bin/bash node ARG APP_HOME="/home/node/app" # Define in base so all child stages inherit it
ARG APP_HOME=/home/node/app RUN useradd -ms /bin/bash node \
RUN mkdir -p $APP_HOME && chown -R node:node $APP_HOME && mkdir -p $APP_HOME && chown -R node:node $APP_HOME
# -----------------------------------------------------------------
# CLONES STAGE: Clone docs-internal, early-access, and translations
# -----------------------------------------------------------------
FROM base AS clones
USER node:node
WORKDIR $APP_HOME WORKDIR $APP_HOME
# Switch to root to ensure we have permissions to copy, chmod, and install
USER root
# Copy in build scripts
COPY src/deployments/production/build-scripts/*.sh ./build-scripts/
# Make scripts executable
RUN chmod +x build-scripts/*.sh
# We need to copy over content that will be merged with early-access # We need to copy over content that will be merged with early-access
COPY content ./content COPY --chown=node:node content content/
COPY assets ./assets COPY --chown=node:node assets assets/
COPY data ./data COPY --chown=node:node data data/
# Copy in build scripts and make them executable
COPY --chown=node:node --chmod=+x \
src/deployments/production/build-scripts/*.sh build-scripts/
# Use the mounted --secret to: # Use the mounted --secret to:
# - 1. Fetch the docs-internal repo # - 1. Fetch the docs-internal repo
@@ -46,111 +48,77 @@ COPY data ./data
# - 3. Fetch each translations repo to the repo/translations directory # - 3. Fetch each translations repo to the repo/translations directory
# We use --mount-type=secret to avoid the secret being copied into the image layers for security # We use --mount-type=secret to avoid the secret being copied into the image layers for security
# The secret passed via --secret can only be used in this RUN command # The secret passed via --secret can only be used in this RUN command
RUN --mount=type=secret,id=DOCS_BOT_PAT_READPUBLICKEY \ RUN --mount=type=secret,id=DOCS_BOT_PAT_READPUBLICKEY,mode=0444 \
# We don't cache because Docker can't know if we need to fetch new content from remote repos # We don't cache because Docker can't know if we need to fetch new content from remote repos
echo "Don't cache this step by printing date: $(date)" && \ echo "Don't cache this step by printing date: $(date)" && \
. ./build-scripts/fetch-repos.sh . ./build-scripts/fetch-repos.sh
# Give node user access to the copied content since we cloned as root # -----------------------------------------
RUN chown -R node:node $APP_HOME/content # DEPENDENCIES STAGE: Install node packages
RUN chown -R node:node $APP_HOME/assets # -----------------------------------------
RUN chown -R node:node $APP_HOME/data FROM base AS dependencies
# Give node user access to translations repos USER node:node
RUN chown -R node:node $APP_HOME/translations
# Change back to node to make sure we don't run anything as the root user
USER node
# ---------------
# ALL DEPS Image
# ---------------
FROM base AS all_deps
ARG APP_HOME=/home/node/app
USER node
WORKDIR $APP_HOME WORKDIR $APP_HOME
# Copy what is needed to run npm ci # Copy what is needed to run npm ci
COPY --chown=node:node package.json package-lock.json ./ COPY --chown=node:node package.json package-lock.json ./
RUN npm ci --no-optional --registry https://registry.npmjs.org/ RUN npm ci --omit=optional --registry https://registry.npmjs.org/
# --------------- # -----------------------------------------
# BUILDER Image # BUILD STAGE: Prepare for production stage
# --------------- # -----------------------------------------
FROM all_deps AS builder FROM base AS build
USER node:node
ARG APP_HOME=/home/node/app
USER node
WORKDIR $APP_HOME WORKDIR $APP_HOME
# Copy what is needed to:
# 1. Build the app
# 2. run warmup-remotejson script
# 3. run precompute-pageinfo script
# Dependencies
COPY --chown=node:node --from=all_deps $APP_HOME/node_modules $APP_HOME/node_modules
# Content with merged early-access content
COPY --chown=node:node --from=base $APP_HOME/data ./data
COPY --chown=node:node --from=base $APP_HOME/assets ./assets
COPY --chown=node:node --from=base $APP_HOME/content ./content
# Source code # Source code
COPY --chown=node:node --from=all_deps $APP_HOME/package.json ./ COPY --chown=node:node src src/
COPY src ./src COPY --chown=node:node package.json ./
COPY next.config.js ./ COPY --chown=node:node next.config.js ./
COPY tsconfig.json ./ COPY --chown=node:node tsconfig.json ./
# 1. Build # From the clones stage
RUN npm run build COPY --chown=node:node --from=clones $APP_HOME/data data/
COPY --chown=node:node --from=clones $APP_HOME/assets assets/
COPY --chown=node:node --from=clones $APP_HOME/content content/
COPY --chown=node:node --from=clones $APP_HOME/translations translations/
# 2. Warm up the remotejson cache # From the dependencies stage
RUN npm run warmup-remotejson COPY --chown=node:node --from=dependencies $APP_HOME/node_modules node_modules/
# 3. Precompute the pageinfo cache # Generate build files
RUN npm run precompute-pageinfo -- --max-versions 2 RUN npm run build \
&& npm run warmup-remotejson \
&& npm run precompute-pageinfo -- --max-versions 2 \
&& npm prune --production
# Prune deps for prod image # -------------------------------------------------
RUN npm prune --production # PRODUCTION STAGE: What will run on the containers
# -------------------------------------------------
# --------------------------------------------------------------------------------
# PRODUCTION IMAGE
# --------------------------------------------------------------------------------
FROM base AS production FROM base AS production
USER node:node
ARG APP_HOME=/home/node/app
USER node
WORKDIR $APP_HOME WORKDIR $APP_HOME
# Copy the content with merged early-access content # Source code
COPY --chown=node:node --from=base $APP_HOME/data ./data COPY --chown=node:node src src/
COPY --chown=node:node --from=base $APP_HOME/assets ./assets COPY --chown=node:node package.json ./
COPY --chown=node:node --from=base $APP_HOME/content ./content COPY --chown=node:node next.config.js ./
COPY --chown=node:node tsconfig.json ./
# Include cloned translations # From clones stage
COPY --chown=node:node --from=base $APP_HOME/translations ./translations COPY --chown=node:node --from=clones $APP_HOME/data data/
COPY --chown=node:node --from=clones $APP_HOME/assets assets/
COPY --chown=node:node --from=clones $APP_HOME/content content/
COPY --chown=node:node --from=clones $APP_HOME/translations translations/
# Copy prod dependencies # From dependencies stage (*modified in build stage)
COPY --chown=node:node --from=builder $APP_HOME/package.json ./ COPY --chown=node:node --from=build $APP_HOME/node_modules node_modules/
COPY --chown=node:node --from=builder $APP_HOME/node_modules $APP_HOME/node_modules
# Copy built artifacts needed at runtime for the server # From build stage
COPY --chown=node:node --from=builder $APP_HOME/.next $APP_HOME/.next COPY --chown=node:node --from=build $APP_HOME/.next .next/
COPY --chown=node:node --from=build $APP_HOME/.remotejson-cache ./
# Copy cache files generated during build scripts COPY --chown=node:node --from=build $APP_HOME/.pageinfo-cache.json.br* ./
COPY --chown=node:node --from=builder $APP_HOME/.remotejson-cache ./.remotejson-cache
COPY --chown=node:node --from=builder $APP_HOME/.pageinfo-cache.json.br* ./.pageinfo-cache.json.br
# Copy only what's needed to run the server
COPY --chown=node:node --from=builder $APP_HOME/src ./src
COPY --chown=node:node --from=builder $APP_HOME/.remotejson-cache ./.remotejson-cache
COPY --chown=node:node --from=builder $APP_HOME/.pageinfo-cache.json.br* ./.pageinfo-cache.json.br
COPY --chown=node:node --from=builder $APP_HOME/next.config.js ./
COPY --chown=node:node --from=builder $APP_HOME/tsconfig.json ./
# - - -
# Environment variables are set in the Moda
# configuration: config/moda/configuration/*/env.yaml
# - - -
# This makes it possible to set `--build-arg BUILD_SHA=abc123` # This makes it possible to set `--build-arg BUILD_SHA=abc123`
# and it then becomes available as an environment variable in the docker run. # and it then becomes available as an environment variable in the docker run.
@@ -158,5 +126,6 @@ ARG BUILD_SHA
ENV BUILD_SHA=$BUILD_SHA ENV BUILD_SHA=$BUILD_SHA
# Entrypoint to start the server # Entrypoint to start the server
# Note: Currently we have to use tsx because we have a mix of `.ts` and `.js` files with multiple import patterns # Note: Currently we have to use tsx because
# we have a mix of `.ts` and `.js` files with multiple import patterns
CMD ["node_modules/.bin/tsx", "src/frame/server.ts"] CMD ["node_modules/.bin/tsx", "src/frame/server.ts"]

4
contributing/deployments.md
View File

@@ -2,9 +2,9 @@
Staging and production deployments are automated by a deployer service created and maintained by @github/docs-engineering. Staging and production deployments are automated by a deployer service created and maintained by @github/docs-engineering.
### Preview deployments ### Review deployments
When a pull request contains only content changes, it can be previewed without a deployment. Code changes will require a deployment. GitHub Staff can deploy such a PR to a staging environment. TBD
### Production deployments ### Production deployments

45
package-lock.json generated
View File

@@ -114,7 +114,6 @@
"@types/connect-timeout": "0.0.39", "@types/connect-timeout": "0.0.39",
"@types/cookie": "0.6.0", "@types/cookie": "0.6.0",
"@types/cookie-parser": "1.4.7", "@types/cookie-parser": "1.4.7",
"@types/elasticsearch": "^5.0.43",
"@types/event-to-promise": "^0.7.5", "@types/event-to-promise": "^0.7.5",
"@types/express": "4.17.21", "@types/express": "4.17.21",
"@types/imurmurhash": "^0.1.4", "@types/imurmurhash": "^0.1.4",
@@ -150,18 +149,13 @@
"http-status-code": "^2.1.0", "http-status-code": "^2.1.0",
"husky": "^9.1.4", "husky": "^9.1.4",
"json-schema-merge-allof": "^0.8.1", "json-schema-merge-allof": "^0.8.1",
"kill-port": "2.0.1",
"lint-staged": "^15.2.9", "lint-staged": "^15.2.9",
"markdownlint": "^0.34.0", "markdownlint": "^0.34.0",
"markdownlint-rule-search-replace": "^1.2.0", "markdownlint-rule-search-replace": "^1.2.0",
"mdast-util-gfm-table": "^2.0.0",
"micromark-extension-gfm-table": "^2.0.0",
"mkdirp": "^3.0.0", "mkdirp": "^3.0.0",
"mockdate": "^3.0.5", "mockdate": "^3.0.5",
"nock": "^14.0.0", "nock": "^14.0.0",
"nodemon": "3.1.3", "nodemon": "3.1.3",
"npm-merge-driver-install": "^3.0.0",
"nth-check": "2.1.1",
"prettier": "^3.3.2", "prettier": "^3.3.2",
"rimraf": "^6.0.0", "rimraf": "^6.0.0",
"robots-parser": "^3.0.0", "robots-parser": "^3.0.0",
@@ -4114,12 +4108,6 @@
"@types/ms": "*" "@types/ms": "*"
} }
}, },
"node_modules/@types/elasticsearch": {
"version": "5.0.43",
"resolved": "https://registry.npmjs.org/@types/elasticsearch/-/elasticsearch-5.0.43.tgz",
"integrity": "sha512-N+MpzURpDCWd7zaJ7CE1aU+nBSeAABLhDE0lGodQ0LLftx7ku6hjTXLr9OAFZLSXiWL3Xxx8jts485ynrcm5NA==",
"dev": true
},
"node_modules/@types/estree": { "node_modules/@types/estree": {
"version": "1.0.6", "version": "1.0.6",
"resolved": "https://registry.npmjs.org/@types/estree/-/estree-1.0.6.tgz", "resolved": "https://registry.npmjs.org/@types/estree/-/estree-1.0.6.tgz",
@@ -8244,11 +8232,6 @@
"url": "https://github.com/sponsors/ljharb" "url": "https://github.com/sponsors/ljharb"
} }
}, },
"node_modules/get-them-args": {
"version": "1.3.2",
"dev": true,
"license": "MIT"
},
"node_modules/get-tsconfig": { "node_modules/get-tsconfig": {
"version": "4.7.5", "version": "4.7.5",
"resolved": "https://registry.npmjs.org/get-tsconfig/-/get-tsconfig-4.7.5.tgz", "resolved": "https://registry.npmjs.org/get-tsconfig/-/get-tsconfig-4.7.5.tgz",
@@ -9933,18 +9916,6 @@
"json-buffer": "3.0.1" "json-buffer": "3.0.1"
} }
}, },
"node_modules/kill-port": {
"version": "2.0.1",
"dev": true,
"license": "MIT",
"dependencies": {
"get-them-args": "1.3.2",
"shell-exec": "1.0.2"
},
"bin": {
"kill-port": "cli.js"
}
},
"node_modules/kind-of": { "node_modules/kind-of": {
"version": "6.0.3", "version": "6.0.3",
"license": "MIT", "license": "MIT",
@@ -12392,17 +12363,6 @@
"url": "https://github.com/sponsors/sindresorhus" "url": "https://github.com/sponsors/sindresorhus"
} }
}, },
"node_modules/npm-merge-driver-install": {
"version": "3.0.0",
"dev": true,
"license": "Apache-2.0",
"bin": {
"npm-merge-driver-install": "src/install.js",
"npm-merge-driver-is-installed": "src/is-installed.js",
"npm-merge-driver-merge": "src/merge.js",
"npm-merge-driver-uninstall": "src/uninstall.js"
}
},
"node_modules/npm-run-path": { "node_modules/npm-run-path": {
"version": "4.0.1", "version": "4.0.1",
"dev": true, "dev": true,
@@ -13940,11 +13900,6 @@
"node": ">=8" "node": ">=8"
} }
}, },
"node_modules/shell-exec": {
"version": "1.0.2",
"dev": true,
"license": "MIT"
},
"node_modules/side-channel": { "node_modules/side-channel": {
"version": "1.0.6", "version": "1.0.6",
"resolved": "https://registry.npmjs.org/side-channel/-/side-channel-1.0.6.tgz", "resolved": "https://registry.npmjs.org/side-channel/-/side-channel-1.0.6.tgz",

6
package.json
View File

@@ -344,7 +344,6 @@
"@types/connect-timeout": "0.0.39", "@types/connect-timeout": "0.0.39",
"@types/cookie": "0.6.0", "@types/cookie": "0.6.0",
"@types/cookie-parser": "1.4.7", "@types/cookie-parser": "1.4.7",
"@types/elasticsearch": "^5.0.43",
"@types/event-to-promise": "^0.7.5", "@types/event-to-promise": "^0.7.5",
"@types/express": "4.17.21", "@types/express": "4.17.21",
"@types/imurmurhash": "^0.1.4", "@types/imurmurhash": "^0.1.4",
@@ -380,18 +379,13 @@
"http-status-code": "^2.1.0", "http-status-code": "^2.1.0",
"husky": "^9.1.4", "husky": "^9.1.4",
"json-schema-merge-allof": "^0.8.1", "json-schema-merge-allof": "^0.8.1",
"kill-port": "2.0.1",
"lint-staged": "^15.2.9", "lint-staged": "^15.2.9",
"markdownlint": "^0.34.0", "markdownlint": "^0.34.0",
"markdownlint-rule-search-replace": "^1.2.0", "markdownlint-rule-search-replace": "^1.2.0",
"mdast-util-gfm-table": "^2.0.0",
"micromark-extension-gfm-table": "^2.0.0",
"mkdirp": "^3.0.0", "mkdirp": "^3.0.0",
"mockdate": "^3.0.5", "mockdate": "^3.0.5",
"nock": "^14.0.0", "nock": "^14.0.0",
"nodemon": "3.1.3", "nodemon": "3.1.3",
"npm-merge-driver-install": "^3.0.0",
"nth-check": "2.1.1",
"prettier": "^3.3.2", "prettier": "^3.3.2",
"rimraf": "^6.0.0", "rimraf": "^6.0.0",
"robots-parser": "^3.0.0", "robots-parser": "^3.0.0",