From 1b934de52b8decf88df40b87dafa401db415a177 Mon Sep 17 00:00:00 2001 From: vmagro Date: Fri, 4 Oct 2024 17:49:43 -0700 Subject: [PATCH] oss: publish to gh-pages --- .github/workflows/docs.yml | 69 ++++++++++++++++++++++++ antlir/antlir2/docs/docusaurus.config.js | 12 +++-- antlir/antlir2/docs/gen_api/src/main.rs | 2 +- antlir/antlir2/docs/package.json | 2 +- 4 files changed, 80 insertions(+), 5 deletions(-) create mode 100644 .github/workflows/docs.yml diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml new file mode 100644 index 00000000000..a5a97aef8a2 --- /dev/null +++ b/.github/workflows/docs.yml @@ -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: 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 diff --git a/antlir/antlir2/docs/docusaurus.config.js b/antlir/antlir2/docs/docusaurus.config.js index 99230c0df53..de27dc37a0b 100644 --- a/antlir/antlir2/docs/docusaurus.config.js +++ b/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', diff --git a/antlir/antlir2/docs/gen_api/src/main.rs b/antlir/antlir2/docs/gen_api/src/main.rs index b4911a58b57..6b22aaf0ca0 100644 --- a/antlir/antlir2/docs/gen_api/src/main.rs +++ b/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", }, diff --git a/antlir/antlir2/docs/package.json b/antlir/antlir2/docs/package.json index 0b90d728fe3..90b48f626df 100644 --- a/antlir/antlir2/docs/package.json +++ b/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",