-
Notifications
You must be signed in to change notification settings - Fork 8.2k
[feat] added next.js documentation -sample guide based on the next.js documentation #24402
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
Open
kristiyan-velkov
wants to merge
3
commits into
docker:main
Choose a base branch
from
kristiyan-velkov:feat/next-js-guide
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+2,075
−0
Open
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,54 @@ | ||
| --- | ||
| title: Next.js language-specific guide | ||
| linkTitle: Next.js | ||
| description: Containerize, develop, test, and deploy Next.js apps with Docker and Kubernetes | ||
| keywords: getting started, Next.js, next.js, docker, language, Dockerfile, CI/CD, Kubernetes | ||
| summary: | | ||
| This guide explains how to containerize Next.js applications, set up | ||
| development and testing in containers, automate builds with GitHub Actions, | ||
| and deploy to Kubernetes. | ||
| toc_min: 1 | ||
| toc_max: 2 | ||
| languages: [js] | ||
| tags: [frameworks] | ||
| params: | ||
| time: 20 minutes | ||
| --- | ||
|
|
||
| The Next.js language-specific guide shows you how to containerize a Next.js application using Docker, following best practices for creating efficient, production-ready containers. | ||
|
|
||
| [Next.js](https://nextjs.org/) is a React framework that enables server-side | ||
| rendering, static site generation, and full-stack capabilities. Docker | ||
| provides a consistent containerized environment from development to | ||
| production. | ||
|
|
||
| > **Acknowledgment** | ||
| > | ||
| > Docker extends its sincere gratitude to [Kristiyan Velkov](https://www.linkedin.com/in/kristiyan-velkov-763130b3/) for authoring this guide and contributing the official [Next.js Docker examples](https://github.com/vercel/next.js/tree/canary/examples/with-docker) to the Vercel Next.js repository, including the standalone and export output examples. As a Docker Captain and experienced engineer, his expertise in Docker, DevOps, and modern web development has made this resource invaluable for the community, helping developers navigate and optimize their Docker workflows. | ||
|
Check failure on line 27 in content/guides/nextjs/_index.md
|
||
|
|
||
| --- | ||
|
|
||
| ## What will you learn? | ||
|
|
||
| In this guide, you will learn how to: | ||
|
|
||
| - Containerize and run a Next.js application using Docker. | ||
| - Set up a local development environment for Next.js inside a container. | ||
| - Run tests for your Next.js application within a Docker container. | ||
| - Configure a CI/CD pipeline using GitHub Actions for your containerized app. | ||
| - Deploy the containerized Next.js application to a local Kubernetes cluster for testing and debugging. | ||
|
|
||
| To begin, you'll start by containerizing an existing Next.js application. | ||
|
|
||
| --- | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| Before you begin, make sure you're familiar with the following: | ||
|
|
||
| - Basic understanding of [JavaScript](https://developer.mozilla.org/en-US/docs/Web/JavaScript) or [TypeScript](https://www.typescriptlang.org/). | ||
| - Basic knowledge of [Node.js](https://nodejs.org/en) and [npm](https://docs.npmjs.com/about-npm) for managing dependencies and running scripts. | ||
| - Familiarity with [React](https://react.dev/) and [Next.js](https://nextjs.org/) fundamentals. | ||
| - Understanding of Docker concepts such as images, containers, and Dockerfiles. If you're new to Docker, start with the [Docker basics](/get-started/docker-concepts/the-basics/what-is-a-container.md) guide. | ||
|
|
||
| Once you've completed the Next.js getting started modules, you'll be ready to containerize your own Next.js application using the examples and instructions provided in this guide. | ||
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,332 @@ | ||
| --- | ||
| title: Automate your builds with GitHub Actions | ||
| linkTitle: Automate your builds with GitHub Actions | ||
| weight: 60 | ||
| keywords: CI/CD, GitHub Actions, Next.js | ||
| description: Learn how to configure CI/CD using GitHub Actions for your Next.js application. | ||
|
|
||
| --- | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| Complete all the previous sections of this guide, starting with [Containerize Next.js application](containerize.md). | ||
|
|
||
| You must also have: | ||
| - A [GitHub](https://github.com/signup) account. | ||
| - A verified [Docker Hub](https://hub.docker.com/signup) account. | ||
|
|
||
| --- | ||
|
|
||
| ## Overview | ||
|
|
||
| In this section, you'll set up a **CI/CD pipeline** using [GitHub Actions](https://docs.github.com/en/actions) to automatically: | ||
|
|
||
| - Build your Next.js application inside a Docker container. | ||
| - Run tests in a consistent environment. | ||
| - Push the production-ready image to [Docker Hub](https://hub.docker.com). | ||
|
|
||
| --- | ||
|
|
||
| ## Integrate GitHub and Docker Hub | ||
|
|
||
| To enable GitHub Actions to build and push Docker images, you'll securely | ||
| store your Docker Hub credentials in your new GitHub repository. | ||
|
|
||
| ### Step 1: Connect your GitHub repository to Docker Hub | ||
|
|
||
| 1. Create a Personal Access Token (PAT) from [Docker Hub](https://hub.docker.com) | ||
| 1. Go to your **Docker Hub account → Account Settings → Security**. | ||
| 2. Generate a new Access Token with **Read/Write** permissions. | ||
| 3. Name it something like `nextjs-sample`. | ||
| 4. Copy and save the token — you'll need it in Step 4. | ||
|
|
||
| 2. Create a repository in [Docker Hub](https://hub.docker.com/repositories/) | ||
| 1. Go to your **Docker Hub account → Create a repository**. | ||
| 2. For the Repository Name, use something descriptive — for example: `nextjs-sample`. | ||
| 3. Once created, copy and save the repository name — you'll need it in Step 4. | ||
|
|
||
| 3. Create a new [GitHub repository](https://github.com/new) for your Next.js project | ||
|
|
||
| 4. Add Docker Hub credentials as GitHub repository secrets | ||
|
|
||
| In your newly created GitHub repository: | ||
|
|
||
| 1. Navigate to: | ||
| **Settings → Secrets and variables → Actions → New repository secret**. | ||
|
|
||
| 2. Add the following secrets: | ||
|
|
||
| | Name | Value | | ||
| |-------------------|--------------------------------| | ||
| | `DOCKER_USERNAME` | Your Docker Hub username | | ||
| | `DOCKERHUB_TOKEN` | Your Docker Hub access token (created in Step 1) | | ||
| | `DOCKERHUB_PROJECT_NAME` | Your Docker Project Name (created in Step 2) | | ||
|
|
||
| These secrets let GitHub Actions authenticate securely with Docker Hub | ||
| during automated workflows. | ||
|
|
||
| 5. Connect Your Local Project to GitHub | ||
|
|
||
| Link your local project to the GitHub repository you just created by running the following command from your project root: | ||
|
|
||
| ```console | ||
| $ git remote set-url origin https://github.com/{your-username}/{your-repository-name}.git | ||
| ``` | ||
|
|
||
| >[!IMPORTANT] | ||
| >Replace `{your-username}` and `{your-repository}` with your actual GitHub username and repository name. | ||
|
|
||
| To confirm that your local project is correctly connected to the remote GitHub repository, run: | ||
|
|
||
| ```console | ||
| $ git remote -v | ||
| ``` | ||
|
|
||
| You should see output similar to: | ||
|
|
||
| ```console | ||
| origin https://github.com/{your-username}/{your-repository-name}.git (fetch) | ||
| origin https://github.com/{your-username}/{your-repository-name}.git (push) | ||
| ``` | ||
|
|
||
| This confirms that your local repository is properly linked and ready to push your source code to GitHub. | ||
|
|
||
| 6. Push Your Source Code to GitHub | ||
|
|
||
| Follow these steps to commit and push your local project to your GitHub repository: | ||
|
|
||
| 1. Stage all files for commit. | ||
|
|
||
| ```console | ||
| $ git add -A | ||
| ``` | ||
| This command stages all changes — including new, modified, and deleted files — preparing them for commit. | ||
|
|
||
|
|
||
| 2. Commit your changes. | ||
|
|
||
| ```console | ||
| $ git commit -m "Initial commit" | ||
| ``` | ||
| This command creates a commit that snapshots the staged changes with a descriptive message. | ||
|
|
||
| 3. Push the code to the `main` branch. | ||
|
|
||
| ```console | ||
| $ git push -u origin main | ||
| ``` | ||
| This command pushes your local commits to the `main` branch of the remote GitHub repository and sets the upstream branch. | ||
|
|
||
| Once completed, your code will be available on GitHub, and any GitHub Actions workflow you've configured will run automatically. | ||
|
|
||
| > [!NOTE] | ||
| > Learn more about the Git commands used in this step: | ||
| > - [Git add](https://git-scm.com/docs/git-add) – Stage changes (new, modified, deleted) for commit | ||
| > - [Git commit](https://git-scm.com/docs/git-commit) – Save a snapshot of your staged changes | ||
| > - [Git push](https://git-scm.com/docs/git-push) – Upload local commits to your GitHub repository | ||
| > - [Git remote](https://git-scm.com/docs/git-remote) – View and manage remote repository URLs | ||
|
|
||
| --- | ||
|
|
||
| ### Step 2: Set up the workflow | ||
|
|
||
| Now you'll create a GitHub Actions workflow that builds your Docker image, runs tests, and pushes the image to Docker Hub. | ||
|
|
||
| 1. Go to your repository on GitHub and select the **Actions** tab in the top menu. | ||
|
|
||
| 2. Select **Set up a workflow yourself** when prompted. | ||
|
|
||
| This opens an inline editor to create a new workflow file. By default, it will be saved to: | ||
| `.github/workflows/main.yml` | ||
|
|
||
|
|
||
| 3. Add the following workflow configuration to the new file: | ||
|
|
||
| ```yaml | ||
| # CI/CD – Next.js Application with Docker | ||
| # Builds the app, runs tests in a container, and pushes the production image to Docker Hub. | ||
|
|
||
| name: CI/CD – Next.js Application with Docker | ||
|
|
||
| on: | ||
| push: | ||
| branches: [main] | ||
| pull_request: | ||
| branches: [main] | ||
| types: [opened, synchronize, reopened] | ||
|
|
||
| jobs: | ||
| build-test-push: | ||
| name: Build, Test and Push Docker Image | ||
| runs-on: ubuntu-latest | ||
|
|
||
| steps: | ||
| # 1. Checkout source code | ||
| - name: Checkout source code | ||
| uses: actions/checkout@v5 | ||
| with: | ||
| fetch-depth: 0 | ||
|
|
||
| # 2. Set up Docker Buildx | ||
| - name: Set up Docker Buildx | ||
| uses: docker/setup-buildx-action@v4 | ||
|
|
||
| # 3. Cache Docker layers | ||
| - name: Cache Docker layers | ||
| uses: actions/cache@v5 | ||
| with: | ||
| path: /tmp/.buildx-cache | ||
| key: ${{ runner.os }}-buildx-${{ github.sha }} | ||
| restore-keys: ${{ runner.os }}-buildx- | ||
|
|
||
| # 4. Cache pnpm dependencies | ||
| - name: Cache pnpm dependencies | ||
| uses: actions/cache@v4 | ||
| with: | ||
| path: ~/.local/share/pnpm/store | ||
| key: ${{ runner.os }}-pnpm-${{ hashFiles('**/pnpm-lock.yaml') }} | ||
| restore-keys: ${{ runner.os }}-pnpm- | ||
|
|
||
| # 5. Extract metadata | ||
| - name: Extract metadata | ||
| id: meta | ||
| run: | | ||
| echo "REPO_NAME=${GITHUB_REPOSITORY##*/}" >> "$GITHUB_OUTPUT" | ||
| echo "SHORT_SHA=${GITHUB_SHA::7}" >> "$GITHUB_OUTPUT" | ||
|
|
||
| # 6. Build dev Docker image (for running tests) | ||
| - name: Build Docker image for tests | ||
| uses: docker/build-push-action@v6 | ||
| with: | ||
| context: . | ||
| file: Dockerfile.dev | ||
| tags: ${{ steps.meta.outputs.REPO_NAME }}-dev:latest | ||
| load: true | ||
| cache-from: type=local,src=/tmp/.buildx-cache | ||
| cache-to: type=local,dest=/tmp/.buildx-cache,mode=max | ||
|
|
||
| # 7. Run Vitest tests inside the container | ||
| # Use same package-manager detection as Dockerfile (no corepack at runtime; node user can't write to /usr/local/bin) | ||
| - name: Run tests | ||
| run: | | ||
| docker run --rm \ | ||
| --workdir /app \ | ||
| --entrypoint "" \ | ||
| -e CI=true \ | ||
| ${{ steps.meta.outputs.REPO_NAME }}-dev:latest \ | ||
| sh -c "if [ -f package-lock.json ]; then npm run test:run; elif [ -f yarn.lock ]; then yarn test:run; elif [ -f pnpm-lock.yaml ]; then pnpm run test:run; else npm run test:run; fi" | ||
| env: | ||
| CI: true | ||
| NODE_ENV: test | ||
| timeout-minutes: 10 | ||
|
|
||
| # 8. Log in to Docker Hub (only needed for push) | ||
| - name: Log in to Docker Hub | ||
| if: github.event_name == 'push' && github.ref == 'refs/heads/main' | ||
| uses: docker/login-action@v3 | ||
| with: | ||
| username: ${{ secrets.DOCKER_USERNAME }} | ||
| password: ${{ secrets.DOCKERHUB_TOKEN }} | ||
|
|
||
| # 9. Build and push production image (only on push to main) | ||
| - name: Build and push production image | ||
| if: github.event_name == 'push' && github.ref == 'refs/heads/main' | ||
| uses: docker/build-push-action@v6 | ||
| with: | ||
| context: . | ||
| file: Dockerfile | ||
| push: true | ||
| platforms: linux/amd64,linux/arm64 | ||
| tags: | | ||
| ${{ secrets.DOCKER_USERNAME }}/${{ secrets.DOCKERHUB_PROJECT_NAME }}:latest | ||
| ${{ secrets.DOCKER_USERNAME }}/${{ secrets.DOCKERHUB_PROJECT_NAME }}:${{ steps.meta.outputs.SHORT_SHA }} | ||
| cache-from: type=local,src=/tmp/.buildx-cache | ||
| cache-to: type=local,dest=/tmp/.buildx-cache,mode=max | ||
|
|
||
| ``` | ||
|
|
||
| This workflow performs the following tasks for your Next.js application: | ||
| - Triggers on every `push` or `pull request` targeting the `main` branch. | ||
| - Builds a development Docker image using `Dockerfile.dev`, optimized for testing. | ||
| - Executes unit tests using Jest inside a clean, containerized environment to ensure consistency. | ||
| - Halts the workflow immediately if any test fails — enforcing code quality. | ||
| - Caches both Docker build layers and npm dependencies for faster CI runs. | ||
| - Authenticates securely with Docker Hub using GitHub repository secrets. | ||
| - Builds a production-ready image using the `Dockerfile`. | ||
| - Tags and pushes the final image to Docker Hub with both `latest` and short SHA tags for traceability. | ||
|
|
||
| > [!NOTE] | ||
| > For more information about `docker/build-push-action`, refer to the [GitHub Action README](https://github.com/docker/build-push-action/blob/master/README.md). | ||
|
|
||
| --- | ||
|
|
||
| ### Step 3: Run the workflow | ||
|
|
||
| After you've added your workflow file, it's time to trigger and observe the CI/CD process in action. | ||
|
|
||
| 1. Commit and push your workflow file | ||
|
|
||
| Select "Commit changes…" in the GitHub editor. | ||
|
|
||
| - This push will automatically trigger the GitHub Actions pipeline. | ||
|
|
||
| 2. Monitor the workflow execution | ||
|
|
||
| 1. Go to the Actions tab in your GitHub repository. | ||
| 2. Click into the workflow run to follow each step: **build**, **test**, and (if successful) **push**. | ||
|
Check warning on line 276 in content/guides/nextjs/configure-github-actions.md
|
||
|
|
||
| 3. Verify the Docker image on Docker Hub | ||
|
|
||
| - After a successful workflow run, visit your [Docker Hub repositories](https://hub.docker.com/repositories). | ||
| - You should see a new image under your repository with: | ||
| - Repository name: `${your-repository-name}` | ||
| - Tags include: | ||
| - `latest` – represents the most recent successful build; ideal for quick testing or deployment. | ||
| - `<short-sha>` – a unique identifier based on the commit hash, useful for version tracking, rollbacks, and traceability. | ||
|
|
||
| > [!TIP] Protect your main branch | ||
| > To maintain code quality and prevent accidental direct pushes, enable branch protection rules: | ||
| > - Navigate to your **GitHub repo → Settings → Branches**. | ||
| > - Under Branch protection rules, select **Add rule**. | ||
| > - Specify `main` as the branch name. | ||
| > - Enable options like: | ||
| > - *Require a pull request before merging*. | ||
| > - *Require status checks to pass before merging*. | ||
| > | ||
| > This ensures that only tested and reviewed code is merged into `main` branch. | ||
| --- | ||
|
|
||
| ## Summary | ||
|
|
||
| In this section, you set up a complete CI/CD pipeline for your containerized Next.js application using GitHub Actions. | ||
|
|
||
| Here's what you accomplished: | ||
|
|
||
| - Created a new GitHub repository specifically for your project. | ||
| - Generated a secure Docker Hub access token and added it to GitHub as a secret. | ||
| - Defined a GitHub Actions workflow to: | ||
| - Build your application inside a Docker container. | ||
| - Run tests in a consistent, containerized environment. | ||
| - Push a production-ready image to Docker Hub if tests pass. | ||
| - Triggered and verified the workflow execution through GitHub Actions. | ||
| - Confirmed that your image was successfully published to Docker Hub. | ||
|
|
||
| With this setup, your Next.js application is now ready for automated testing and deployment across environments — increasing confidence, consistency, and team productivity. | ||
|
|
||
| --- | ||
|
|
||
| ## Related resources | ||
|
|
||
| Deepen your understanding of automation and best practices for containerized apps: | ||
|
|
||
| - [Introduction to GitHub Actions](/guides/gha.md) – Learn how GitHub Actions automate your workflows | ||
| - [Docker Build GitHub Actions](/manuals/build/ci/github-actions/_index.md) – Set up container builds with GitHub Actions | ||
| - [Workflow syntax for GitHub Actions](https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions) – Full reference for writing GitHub workflows | ||
| - [Compose file reference](/compose/compose-file/) – Full configuration reference for `compose.yaml` | ||
| - [Best practices for writing Dockerfiles](/develop/develop-images/dockerfile_best-practices/) – Optimize your image for performance and security | ||
|
|
||
| --- | ||
|
|
||
| ## Next steps | ||
|
|
||
| Next, learn how you can locally test and debug your Next.js workloads on Kubernetes before deploying. This helps you ensure your application behaves as expected in a production-like environment, reducing surprises during deployment. | ||
Oops, something went wrong.
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.