Skip to content

Commit

Permalink
Adding github actions to test build and deploy to github pages (#205)
Browse files Browse the repository at this point in the history
* Upgrading docusaurus to latest version. Back porting a broken link to previous versions.

* Adding v7.1.0 documentation snapshot.

* Start deploying to github pages with an action.

* Project was set up for npm rather than yarn.

* Need "run" command in build line.
  • Loading branch information
smallsaucepan authored Oct 2, 2024
1 parent c352c37 commit 601b5d6
Show file tree
Hide file tree
Showing 2 changed files with 57 additions and 5 deletions.
14 changes: 9 additions & 5 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
@@ -1,19 +1,23 @@
name: Build

on:
push:
branches: [main]
pull_request:
workflow_dispatch:
branches:
- master

jobs:
build:
name: Build
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
- uses: actions/setup-node@v4
with:
node-version: 20
- run: npm install
- run: npm run build

- name: Install dependencies
run: npm install --frozen-lockfile
- name: Test build website
run: npm run build
48 changes: 48 additions & 0 deletions .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
name: Deploy to GitHub Pages

on:
push:
branches:
- master

jobs:
build:
name: Build Docusaurus
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
- uses: actions/setup-node@v4
with:
node-version: 20

- name: Install dependencies
run: npm install --frozen-lockfile
- name: Build website
run: npm run build

- name: Upload Build Artifact
uses: actions/upload-pages-artifact@v3
with:
path: build

deploy:
name: Deploy to GitHub Pages
needs: build

# Grant GITHUB_TOKEN the permissions required to make a Pages deployment
permissions:
pages: write # to deploy to Pages
id-token: write # to verify the deployment originates from an appropriate source

# Deploy to the github-pages environment
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}

runs-on: ubuntu-latest
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4

0 comments on commit 601b5d6

Please sign in to comment.