Skip to content

Commit

Permalink
oss: publish to gh-pages
Browse files Browse the repository at this point in the history
  • Loading branch information
vmagro committed Oct 5, 2024
1 parent bdd56dc commit da75f98
Show file tree
Hide file tree
Showing 2 changed files with 70 additions and 1 deletion.
69 changes: 69 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
name: Deploy to GitHub Pages

on:
push:
branches:
- main
# Review gh actions docs if you want to further define triggers, paths, etc
# https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#on

defaults:
run:
shell: bash
working-directory: ./antlir/antlir2/docs

jobs:
build:
name: Build Docusaurus
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
with:
submodules: true
- uses: facebook/install-dotslash@latest

- uses: actions/setup-node@v4
with:
node-version: 18
cache: yarn
cache-dependency-path: 'antlir/antlir2/docs/yarn.lock'

- name: Install dependencies
run: yarn install --frozen-lockfile

- name: Disable watchman
run: |
echo '[buck2]' >> $GITHUB_WORKSPACE/.buckconfig
echo 'file_watcher=notify' >> $GITHUB_WORKSPACE/.buckconfig
- name: Add repo to PATH
run: |
echo "$GITHUB_WORKSPACE" >> $GITHUB_PATH
- name: Build website
run: yarn build

- name: Upload Build Artifact
uses: actions/upload-pages-artifact@v3
with:
path: build

deploy:
name: Deploy to GitHub Pages
needs: build

# Grant GITHUB_TOKEN the permissions required to make a Pages deployment
permissions:
pages: write # to deploy to Pages
id-token: write # to verify the deployment originates from an appropriate source

# Deploy to the github-pages environment
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
2 changes: 1 addition & 1 deletion antlir/antlir2/docs/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"private": true,
"scripts": {
"docusaurus": "docusaurus",
"gen-api": "buck2 run fbcode//antlir/antlir2/docs/gen_api -- --out docs/api",
"gen-api": "buck2 run antlir//antlir/antlir2/docs/gen_api -- --out docs/api",
"start": "yarn gen-api && docusaurus start",
"build": "yarn gen-api && docusaurus build",
"swizzle": "docusaurus swizzle",
Expand Down

0 comments on commit da75f98

Please sign in to comment.