Create GitHub Pages.md

[cezaraugusto]

Add instructions about how to deploy to GitHub Pages via GitHub Action.

This is the same script I'm using to deploy my project (file ref), thought it would be cool to share so others can just copy/paste the setup.

[netlify[bot]]

✅ Deploy Preview for sensational-cranachan-4404c2 ready!

Name	Link
🔨 Latest commit	e8f9fb72ba9cedb37ec3da8616d420a47cd2098a
🔍 Latest deploy log	https://app.netlify.com/sites/sensational-cranachan-4404c2/deploys/6633bdc2512d1d00080cb31b
😎 Deploy Preview	https://deploy-preview-53--sensational-cranachan-4404c2.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site configuration.

[rothsandro]

Thanks for PR 🙏 I just formatted the file with Prettier so everything is properly aligned.

I'm not familiar with GitHub Actions, so let me ask two dumb questions:

• Is there a reason for using old versions of actions (v2 + v3, v4 would be the latest)?
• The Prepare CNAME step is only necessary for custom domains. Not sure if we should include this at all or maybe add comment that it can be removed without a custom domain.

[semanticdata]

Hello,

Please consider the action I use to deploy my notes. It only uses GitHub's own actions (checkout, setup-node, upload-pages-artifact, deploy-pages) along with their latest versions.

name: Deploy to GitHub Pages (npm)

on:
  workflow_dispatch:
  push:
    branches:
      - main

permissions:
  contents: read
  pages: write
  id-token: write

concurrency:
  group: 'pages'
  cancel-in-progress: false

# Needed to deploy to GitHub pages subdomain. (E.g. `your-username.github.io/eleventy-notes/`)
env:
  ELEVENTY_NOTES_PATH_PREFIX: 'eleventy-notes' 

jobs:
  setup:
    name: Setup and Build
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
        name: Checkout
      - uses: actions/setup-node@v4
        name: Setup Node
        with:
          node-version: 18
      - name: Install dependencies
        run: npm install --prefix .app
      - name: Build
        run: npm run build --prefix .app
      - name: Upload artifact
        uses: actions/upload-pages-artifact@v3
        with:
          path: .app/dist

  deploy:
    name: Deploy
    needs: setup
    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

Hope this helps.

[rothsandro]

Thanks @semanticdata, I updated the docs.

[rothsandro]

Thanks again, @cezaraugusto and @semanticdata 🙏