Skip to content

Instantly share code, notes, and snippets.

@alexng353
Last active July 26, 2024 12:03
Show Gist options
  • Save alexng353/80f4457738b9f312f18ed6f5772ffeac to your computer and use it in GitHub Desktop.
Save alexng353/80f4457738b9f312f18ed6f5772ffeac to your computer and use it in GitHub Desktop.
Next JS build test GitHub action
# Sample workflow for building and deploying a Next.js site to GitHub Pages
#
# To get started with Next.js see: https://nextjs.org/docs/getting-started
#
name: Check NextJs build
on:
# Runs on pushes targeting the default branch
push:
branches: ["main"]
# Runs on any open or reopened pull request
pull_request:
types: [opened, reopened]
# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: write
jobs:
# Build job
build:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Detect package manager
id: detect-package-manager
run: |
if [ -f "${{ github.workspace }}/yarn.lock" ]; then
echo "manager=yarn" >> $GITHUB_OUTPUT
echo "command=install" >> $GITHUB_OUTPUT
echo "runner=yarn" >> $GITHUB_OUTPUT
exit 0
elif [ -f "${{ github.workspace }}/package.json" ]; then
echo "manager=npm" >> $GITHUB_OUTPUT
echo "command=ci" >> $GITHUB_OUTPUT
echo "runner=npx --no-install" >> $GITHUB_OUTPUT
exit 0
else
echo "Unable to determine package manager" >&2
exit 1
fi
- name: Setup Node
uses: actions/setup-node@v3
with:
node-version: "20"
cache: ${{ steps.detect-package-manager.outputs.manager }}
- name: Restore cache
uses: actions/cache@v3
with:
path: |
.next/cache
# Generate a new cache whenever packages or source files change.
key: ${{ runner.os }}-nextjs-${{ hashFiles('**/package-lock.json', '**/yarn.lock') }}-${{ hashFiles('**.[jt]s', '**.[jt]sx') }}
# If source files changed but packages didn't, rebuild from a prior cache.
restore-keys: |
${{ runner.os }}-nextjs-${{ hashFiles('**/package-lock.json', '**/yarn.lock') }}-
- name: Install dependencies
run: ${{ steps.detect-package-manager.outputs.manager }} ${{ steps.detect-package-manager.outputs.command }}
- name: Build with Next.js
run: npm run build
@FSuaverdez
Copy link

Hi May I know what is env: API_KEY: ${{ secrets.API_KEY }} used for?

@Abir-Tx
Copy link

Abir-Tx commented Apr 8, 2024

Nice one. Thank you

@alexng353
Copy link
Author

Hi May I know what is env: API_KEY: ${{ secrets.API_KEY }} used for?

Hi, it's actually not required and exists only as a fragment of an old project that I wrote, which is where this script originated from. I have now removed it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment