docs: create some documents needed for open source project (#6) #6
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
name: Build and Publish to GitHub Pages | |
on: | |
push: | |
branches: | |
- main | |
permissions: | |
contents: read | |
pages: write | |
id-token: write | |
concurrency: | |
group: 'pages' | |
cancel-in-progress: false | |
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' | |
registry-url: 'https://registry.npmjs.org/' | |
- name: Cache dependencies ⚡ | |
id: cache_dependencies_root | |
uses: actions/cache@v3 | |
with: | |
path: node_modules | |
key: node-modules-root-${{ hashFiles('package-lock.json') }} | |
- name: Install dependencies root 🔧 | |
if: steps.cache_dependencies_root.outputs.cache-hit != 'true' | |
run: npm ci | |
- name: Cache dependencies example ⚡ | |
id: cache_dependencies_example | |
uses: actions/cache@v3 | |
with: | |
path: example/node_modules | |
key: node-modules-example-${{ hashFiles('example/package-lock.json') }} | |
- name: Install dependencies example page 🔧 | |
if: steps.cache_dependencies_example.outputs.cache-hit != 'true' | |
working-directory: example | |
run: npm ci | |
- name: Setup Pages ⚙️ | |
uses: actions/configure-pages@v4 | |
with: | |
static_site_generator: next | |
- name: Build with Next.js 🏗️ | |
working-directory: example | |
run: npx next build | |
- name: Upload artifact 📡 | |
uses: actions/upload-pages-artifact@v3 | |
with: | |
path: example/out | |
deploy: | |
needs: build | |
runs-on: ubuntu-latest | |
environment: | |
name: github-pages | |
url: ${{ steps.deployment.outputs.page_url }} | |
steps: | |
- name: Publish to GitHub Pages 🚀 | |
id: deployment | |
uses: actions/deploy-pages@v4 |