Skip to content
Draft
Show file tree
Hide file tree
Changes from 18 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 0 additions & 16 deletions .github/workflows/build.yml

This file was deleted.

21 changes: 0 additions & 21 deletions .github/workflows/deploy.yml

This file was deleted.

98 changes: 98 additions & 0 deletions .github/workflows/publish-docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,98 @@
name: Publish Docs

on:
push:
branches: [master]
pull_request:
branches: [master]
workflow_dispatch:
inputs:
pr_number:
description: 'PR number to deploy preview for'
required: true
type: number
run_id:
description: 'Run ID of the build workflow (from the PR checks)'
required: true
type: string

permissions:
contents: write
pull-requests: write

jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4

- name: Setup Node.js
uses: actions/setup-node@v4
with:
node-version: 20

- name: Install dependencies
run: npm ci

- name: Build
run: npm run build

- name: Upload build artifact
uses: actions/upload-artifact@v4
with:
name: site
path: build/

deploy-pr-preview:
if: ${{ github.event_name == 'workflow_dispatch' }}
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4

- name: Download build artifact
uses: actions/download-artifact@v4
with:
name: site
path: site
run-id: ${{ inputs.run_id }}
github-token: ${{ secrets.GITHUB_TOKEN }}

- name: Deploy PR Preview
uses: JamesIves/github-pages-deploy-action@v4
with:
branch: gh-pages-pr-previews
folder: site
target-folder: pr-${{ inputs.pr_number }}

- name: Comment Preview URL
uses: marocchino/sticky-pull-request-comment@v2
with:
recreate: true
number: ${{ inputs.pr_number }}
message: |
🚀 **Preview Ready!**
Your docs preview for this PR is available here:

**https://${{ github.repository_owner }}.github.io/${{ github.event.repository.name }}/pr-${{ inputs.pr_number }}/**

deploy-production:
if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/master' }}
runs-on: ubuntu-latest
needs: build
steps:
- name: Checkout
uses: actions/checkout@v4

- name: Download build artifact
uses: actions/download-artifact@v4
with:
name: site
path: site

- name: Deploy to GitHub Pages
uses: JamesIves/github-pages-deploy-action@v4
with:
branch: gh-pages
folder: site
2 changes: 1 addition & 1 deletion docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ module.exports = {
tagline:
"Ecosystem science, policy, and management informed by the best available data and models",
url: "https://pecanproject.github.io",
baseUrl: "/",
baseUrl: process.env.BASE_URL || "/",
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

how does this change help with our current changes ?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's required for a PR preview for the Docusaurus config. Actually, I was trying to deploy to gh pages using this workflow for a PR in my fork (just to test) , but in every case, the deployed URL was returning 404.
Then I found this fix in Docusaurus config here which fixes it.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also For this PR, I was looking for a similar way to comment the PR preview automatically, very similar to what Netlify does. Unfortunately, that is only supported by GitHub Pages and GitHub Actions. So, we need to follow a two-step process for the preview, as @dlebauer mentioned in the 2nd option here. It seems like this is the only way to create a preview website for a PR.

onBrokenLinks: "ignore",
onBrokenMarkdownLinks: "warn",
favicon: "img/favicon.ico",
Expand Down