summaryrefslogtreecommitdiff
path: root/.github/workflows/pages.yml
diff options
context:
space:
mode:
authorFabian Mastenbroek <mail.fabianm@gmail.com>2022-09-13 17:28:57 +0200
committerGitHub <noreply@github.com>2022-09-13 17:28:57 +0200
commitff7dfda051e0103b0df453473eb0f08cdc37ae85 (patch)
tree2e80525809ecb5afe010faa99898ca479965b95a /.github/workflows/pages.yml
parentfde9ba4fb88bada9d9873ba21904e9e1a66b0c46 (diff)
parentfd208941622cd559a0c3a196a0754a1b33db402b (diff)
merge: Add documentation using Docusaurus (#97)
This pull request implements the new OpenDC documentation website using Docusaurus 2. ## Implementation Notes :hammer_and_pick: * Add initial Docusaurus website. * Migrate existing docs to Docusaurus. * Configure Prettier for Docusaurus. * Add tutorials to OpenDC website (#28) * Add deployment workflow via GitHub actions ## External Dependencies :four_leaf_clover: * Docusaurus 2 Closes #28
Diffstat (limited to '.github/workflows/pages.yml')
-rw-r--r--.github/workflows/pages.yml57
1 files changed, 57 insertions, 0 deletions
diff --git a/.github/workflows/pages.yml b/.github/workflows/pages.yml
new file mode 100644
index 00000000..aa10c2eb
--- /dev/null
+++ b/.github/workflows/pages.yml
@@ -0,0 +1,57 @@
+name: Deploy opendc.org
+
+on:
+ push:
+ branches: ["master"]
+ workflow_dispatch:
+
+concurrency:
+ group: "pages"
+ cancel-in-progress: true
+
+jobs:
+ build:
+ defaults:
+ run:
+ working-directory: site
+ runs-on: ubuntu-latest
+ steps:
+ - name: Checkout
+ uses: actions/checkout@v3
+ - name: Setup Node
+ uses: actions/setup-node@v3
+ with:
+ node-version: "16"
+ cache: 'npm'
+ cache-dependency-path: site/package-lock.json
+ - name: Setup Pages
+ id: pages
+ uses: actions/configure-pages@v1
+ - name: Install dependencies
+ run: npm ci
+ - name: Build with Docusaurus
+ run: npm run build
+ env:
+ DOCUSAURUS_URL: ${{ steps.pages.outputs.origin }}
+ DOCUSAURUS_BASE_PATH: ${{ steps.pages.outputs.base_path }}
+ - name: Upload artifact
+ uses: actions/upload-pages-artifact@v1
+ with:
+ path: ./site/build
+
+ deploy:
+ needs: build
+
+ permissions:
+ contents: read
+ pages: write
+ id-token: write
+
+ 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@v1