Skip to content

Commit

Permalink
Add gh action to deploy
Browse files Browse the repository at this point in the history
  • Loading branch information
etaoxing committed Feb 11, 2025
1 parent dbc0cf1 commit f38e14e
Show file tree
Hide file tree
Showing 3 changed files with 49 additions and 0 deletions.
41 changes: 41 additions & 0 deletions .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
name: Deploy to GitHub Pages

on:
# Trigger the workflow every time you push to the `main` branch
# Using a different branch name? Replace `main` with your branch’s name
push:
branches: [ main ]
# Allows you to run this workflow manually from the Actions tab on GitHub.
workflow_dispatch:

# Allow this job to clone the repo and create a page deployment
permissions:
contents: read
pages: write
id-token: write

jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Checkout your repository using git
uses: actions/checkout@v4
with:
lfs: true # Fetches LFS data
- name: Install, build, and upload your site
uses: withastro/action@v3
with:
path: . # The root location of your Astro project inside the repository. (optional)
node-version: 23 # The specific version of Node that should be used to build your site. Defaults to 20. (optional)
# package-manager: yarn@latest # The Node package manager that should be used to install dependencies and build your site. Automatically detected based on your lockfile. (optional)

deploy:
needs: build
runs-on: ubuntu-latest
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
```bash
brew install node@23
brew install yarn
brew install git-lfs
git lfs install

# start local dev server at `localhost:4321`
Expand All @@ -20,6 +21,11 @@ yarn build

# check dist/ that was just built
yarn preview

# check that files are tracked by git-lfs
git lfs status
# or
git lfs ls-files
```

# Usage
Expand Down
2 changes: 2 additions & 0 deletions astro.config.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ import tailwind from '@astrojs/tailwind'

// https://astro.build/config
export default defineConfig({
site: 'https://cmubig.github.io',
base: 'cmubig.github.io',
integrations: [
starlight({
title: 'BIG',
Expand Down

0 comments on commit f38e14e

Please sign in to comment.