Create a new GitHub Actions workflow in publish-cloudflare-pages.yml; add deployment notes to README.Rmd

Author: alexnitta

.github/workflows/publish-cloudflare-pages.yml

@@ -0,0 +1,49 @@
+on:
+  workflow_dispatch:
+  push:
+    branches: cf-pages
+
+name: Publish Quarto to Cloudflare Plages
+
+jobs:
+  build-deploy:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      deployments: write
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v4
+
+      - name: Set up Quarto
+        uses: quarto-dev/quarto-actions/setup@v2
+        with:
+          version: pre-release
+
+      # install libcurl, needed for curl R package
+      # libfribidi-dev libharfbuzz-dev for textshaping
+      # libxslt1-dev for xslt
+      - name: Install R package deps
+        run: |
+          sudo apt-get update
+          sudo apt-get install libcurl4-openssl-dev libfribidi-dev libharfbuzz-dev libxslt1-dev
+
+      - name: Install R
+        uses: r-lib/actions/setup-r@v2
+        with:
+          r-version: "4.4.0"
+
+      - name: Install R Dependencies
+        uses: r-lib/actions/setup-renv@v2
+        with:
+          cache-version: 1
+
+      - name: Render book
+        run: Rscript -e 'babelquarto::render_website()'
+
+      - name: Deploy
+        uses: cloudflare/wrangler-action@v3
+        with:
+          apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
+          accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
+          command: pages deploy _site --project-name=joelnitta-photos

README.Rmd

@@ -13,13 +13,30 @@ knitr::opts_chunk$set(
 
 # joelnitta-home
 
-[![Netlify Status](https://api.netlify.com/api/v1/badges/4dec3009-d025-4fdf-b25e-76e98b2f34e1/deploy-status)](https://app.netlify.com/sites/laughing-cray-e2c0db/deploys)
-
 Source code for [personal website of Joel Nitta](https://www.joelnitta.com).
 
-Created with [Quarto](https://quarto.org/) in [R](https://www.r-project.org/). 
+Created with [Quarto](https://quarto.org/) in [R](https://www.r-project.org/).
+
+
+## Production deployment
+
+Production deployment is set up using GitHub Actions with [./.github/workflows/publish-cloudflare-pages.yml](./.github/workflows/publish-cloudflare-pages.yml).
+
+The workflow file is very simple and basically runs two commands:
+
+1. `Rscript -e 'babelquarto::render_website()'`, which compiles the Quarto blog to a static website within the `_site` folder. This folder contains an `index.html` which is the root of the website, as well as various JavaScript and CSS files and images; you can read more on [`quarto render`](https://quarto.org/docs/projects/quarto-projects.html#rendering-projects). Note that `_site` is ignored in `.gitignore` because it is generated from the source code; the source code is what we track in version control, not the built files.
+
+2. `wrangler pages deploy _site --project-name=joelnitta-home`, which deploys the `_site` folder to Cloudflare Pages. You can read more details on [`wrangler pages deploy`](https://developers.cloudflare.com/workers/wrangler/commands/#deploy-1).
+
+### Secrets
+
+This workflow requires two secrets to be set up in GitHub:
+
+- `CLOUDFLARE_API_TOKEN`: see Cloudflare docs on [how to create an API token](https://developers.cloudflare.com/pages/how-to/use-direct-upload-with-continuous-integration/#generate-an-api-token)
+- `CLOUDFLARE_ACCOUNT_ID`: see Cloudflare docs on [how to get the account ID](https://developers.cloudflare.com/pages/how-to/use-direct-upload-with-continuous-integration/#get-project-account-id)
+
+Both secrets must be stored in the settings for the GitHub repository - see GitHub docs on [Creating secrets for a repository](https://docs.github.com/en/actions/security-for-github-actions/security-guides/using-secrets-in-github-actions#creating-secrets-for-a-repository).
 
-Site built by [GitHub actions](.github/workflows/build_site.yml) to the [`gh_pages` branch](https://github.com/joelnitta/joelnitta-home/tree/gh-pages), deployed by [Netlify](https://www.netlify.com/).
 
 ## Local deployment
 
@@ -48,4 +65,4 @@ Code: [MIT](LICENSE)
 
 Text and images, unless otherwise indicated: Creative Commons Attribution [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/legalcode)
 
-Publications (PDF files): Indicated in each publication.
+Publications (PDF files): Indicated in each publication.