[antlir][oss] gh action to publish staticdocs to gh-pages (#262)

Summary: Pull Request resolved: #262

Test Plan:
Pushed to my fork
https://vmagro.github.io/antlir/
works

Reviewed By: justintrudell

Differential Revision: D63930801

Pulled By: vmagro

fbshipit-source-id: fa07e171ce86f5afb04ee0c6c3af05691c73eacd

.github/workflows/docs.yml

@@ -0,0 +1,67 @@
+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: antlir/antlir2/docs/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

antlir/antlir2/docs/docusaurus.config.js

@@ -19,10 +19,16 @@ import {themes} from 'prism-react-renderer';
  }),
  baseUrl: fbContent({
  internal: '/intern/staticdocs/antlir2/',
- external: '/antlir/antlir2/'
+ external: '/antlir/'
+ }),
+ onBrokenLinks: fbContent({
+ internal: 'throw',
+ external: 'warn',
+ }),
+ onBrokenMarkdownLinks: fbContent({
+ internal: 'throw',
+ external: 'warn',
  }),
- onBrokenLinks: 'throw',
- onBrokenMarkdownLinks: 'throw',
  trailingSlash: true,
  favicon: 'img/favicon.ico',
  organizationName: 'facebookincubator',

antlir/antlir2/docs/gen_api/src/main.rs

@@ -59,7 +59,7 @@ fn format_ty(
 
 fn main() -> Result<()> {
  let mut starlark_path_to_template = hashmap! {
- "fbcode//antlir/antlir2/bzl/feature:defs.bzl" => TemplateCfg {
+ "antlir//antlir/antlir2/bzl/feature:defs.bzl" => TemplateCfg {
  input: "templates/features.mdx",
  doc_location: "features.md",
  },

antlir/antlir2/docs/package.json

@@ -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",