Skip to content

Commit

Permalink
Merge pull request #1241 from openlayers/docs
Browse files Browse the repository at this point in the history
Build docs as html and deploy to website
  • Loading branch information
ahocevar authored Feb 3, 2025
2 parents 302ad65 + f5a8c60 commit 5dce7a8
Show file tree
Hide file tree
Showing 10 changed files with 256 additions and 3,426 deletions.
49 changes: 29 additions & 20 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
@@ -1,30 +1,39 @@
name: Deploy to GitHub Pages
# Simple workflow for deploying static content to GitHub Pages
name: Deploy static content to Pages

on:
# Runs on pushes targeting the default branch
push:
branches:
- main
branches: ["main"]

# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:

# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: write

concurrency:
group: "pages"
cancel-in-progress: true

jobs:
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest

steps:
- name: Checkout repository
- name: Checkout
uses: actions/checkout@v4

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

- name: Build
run: |
npm install
npm run build
- name: Deploy
uses: peaceiris/actions-gh-pages@v4
- name: Setup Pages
uses: actions/configure-pages@v5
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./dist
path: '.docs/'
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4
1 change: 1 addition & 0 deletions .npmignore
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,4 @@ dist/examples/
webpack.*.cjs
rollup.config.js
tsconfig*.json
typedoc.json
Loading

0 comments on commit 5dce7a8

Please sign in to comment.