Skip to content
CI Workflow for Todo App

Update publish directory path to use relative path in CI workflow #42

Sign in to view logs

Update publish directory path to use relative path in CI workflow

Update publish directory path to use relative path in CI workflow #42

Workflow file for this run

.github/workflows/pipe.yml at 7a3c099
name: CI Workflow for Todo App
on:
push:
branches:
- main # Trigger the workflow on pushes to the "main" branch.
jobs:
# Task 1: Cache and Build
build:
runs-on: ubuntu-latest # Use the latest Ubuntu environment for the build.
steps:
- name: Checkout code
uses: actions/checkout@v2
# Check out the code from the repository.
- name: Set up Node.js
uses: actions/setup-node@v2
with:
node-version: '21'
# Set up Node.js version 21, as required by the project.
- name: Cache Node.js modules
uses: actions/cache@v3
with:
path: node_modules
key: ${{ runner.os }}-node-modules-${{ hashFiles('package-lock.json') }}
restore-keys: |
${{ runner.os }}-node-modules-
# Cache the Node.js modules (node_modules) to speed up dependency installation.
- name: Install dependencies
run: npm ci
# Install dependencies using a clean install to ensure consistency.
- name: Cache .next folder
uses: actions/cache@v3
with:
path: .next
key: ${{ runner.os }}-next-${{ hashFiles('package-lock.json') }}
restore-keys: |
${{ runner.os }}-next-
# Cache the `.next` folder to reuse the build output in subsequent steps.
- name: Build application
run: npm run build
# Build the application using the `npm run build` command.
- name: Verify export output
run: ls -la ./out
# Verify that the `out` folder was created successfully.
# Task 2: Linting
lint:
runs-on: ubuntu-latest # Use the latest Ubuntu environment for linting.
needs: build # This job depends on the completion of the "build" job.
steps:
- name: Checkout code
uses: actions/checkout@v2
# Check out the code from the repository.
- name: Set up Node.js
uses: actions/setup-node@v2
with:
node-version: '21'
# Set up Node.js version 21 for linting.
- name: Cache Node.js modules
uses: actions/cache@v3
with:
path: node_modules
key: ${{ runner.os }}-node-modules-${{ hashFiles('package-lock.json') }}
restore-keys: |
${{ runner.os }}-node-modules-
# Cache the Node.js modules (node_modules) for faster dependency installation.
- name: Install dependencies
run: npm ci
# Install dependencies for the linting process.
- name: Run linting
run: npm run lint
# Run the linting process to check for code style and errors.
# Task 3: Testing
test:
runs-on: ubuntu-latest # Use the latest Ubuntu environment for testing.
needs: build # This job depends on the completion of the "build" job.
steps:
- name: Checkout code
uses: actions/checkout@v2
# Check out the code from the repository.
- name: Set up Node.js
uses: actions/setup-node@v2
with:
node-version: '21'
# Set up Node.js version 21 for testing.
- name: Cache Node.js modules
uses: actions/cache@v3
with:
path: node_modules
key: ${{ runner.os }}-node-modules-${{ hashFiles('package-lock.json') }}
restore-keys: |
${{ runner.os }}-node-modules-
# Cache the Node.js modules (node_modules) for faster dependency installation.
- name: Install dependencies
run: npm ci
# Install dependencies required for the tests.
- name: Cache .next folder
uses: actions/cache@v3
with:
path: .next
key: ${{ runner.os }}-next-${{ hashFiles('package-lock.json') }}
restore-keys: |
${{ runner.os }}-next-
# Cache the `.next` folder to reuse the build output during testing.
- name: Run tests
run: npm test
# Run the tests to verify application functionality.
# Task 4: Deploy to GitHub Pages
deploy:
runs-on: ubuntu-latest # Use the latest Ubuntu environment for deployment.
needs: [lint, test] # This job depends on the completion of both "lint" and "test" jobs.
steps:
- name: Checkout code
uses: actions/checkout@v2
# Check out the code from the repository.
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./out
force_orphan: true
# Deploy the static files from the `out` directory to GitHub Pages.