Skip to content

# Flow diagram for Next.js workflow job steps #178

@Dargon789

Description

@Dargon789

Reviewer's Guide

Adds a new GitHub Actions workflow to build a Next.js project, cache dependencies and build artifacts, and deploy the static output to GitHub Pages on pushes to master or manual dispatch.

Flow diagram for Next.js workflow job steps

flowchart TD
  A[Trigger workflow
  push to master or workflow_dispatch] --> B[Job build starts on ubuntu-latest]
  B --> C[Checkout repository
  actions/checkout@v4]
  C --> D[Detect package manager
  set manager, command, runner]
  D --> E[Setup Node 20
  actions/setup-node@v4
  cache by manager]
  E --> F[Setup Pages
  configure-pages@v5
  static_site_generator next]
  F --> G[Restore cache
  actions/cache@v4
  path .next/cache]
  G --> H[Install dependencies
  manager command]
  H --> I[Build with Next.js
  runner next build]
  I --> J[Upload artifact
  upload-pages-artifact@v3
  path ./out]
  J --> K[Job deploy starts on ubuntu-latest
  needs build]
  K --> L[Deploy to GitHub Pages
  deploy-pages@v4
  environment github-pages]
  L --> M[Pages site available at page_url]
Loading

File-Level Changes

Change Details Files
Introduce a GitHub Actions workflow to build and deploy a Next.js site to GitHub Pages.
  • Configure workflow triggers to run on pushes to the master branch and on manual dispatch.
  • Set GitHub Pages-related permissions and concurrency to allow controlled, single-flight deployments.
  • Add a build job that checks out the repo, detects the package manager, sets up Node and GitHub Pages, restores Next.js cache, installs dependencies, builds the Next.js app, and uploads the build output as a Pages artifact.
  • Add a deploy job that depends on the build job and publishes the uploaded artifact to GitHub Pages, exposing the deployed page URL via the environment configuration.
.github/workflows/nextjs.yml

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Originally posted by @sourcery-ai[bot] in #176 (comment)

Metadata

Metadata

Assignees

Labels

dependenciesPull requests that update a dependency filedocumentationImprovements or additions to documentationduplicateThis issue or pull request already existsenhancementNew feature or requestgood first issueGood for newcomershelp wantedExtra attention is neededinvalidThis doesn't seem rightjavascriptPull requests that update javascript codequestionFurther information is requested

Projects

Status

Done

Status

Done

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions