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 96ee26e
Show file tree
Hide file tree
Showing 5 changed files with 86 additions and 9 deletions.
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
20 changes: 13 additions & 7 deletions antlir/antlir2/docs/docs/internals/vm-tests.md
Original file line number Diff line number Diff line change
Expand Up @@ -117,9 +117,12 @@ debugging sub targets. This is due to limitation in how envs are populated
during tests, which are not fully available for `buck run`. One workaround is to
run `buck test <test> -- --env RUST_LOG=debug` first, and look for the ssh
command spawning the test in the failure output. It should contain a full list
of envs that you can copy into your interactive shell. For Meta users, there are
[additional integration](fb/vm-tests.md#more-internal-debugging-tips) to provide
you the envs.
of envs that you can copy into your interactive shell.

<FbInternalOnly>
For Meta users, there are [additional integration](fb/vm-tests.md#more-internal-debugging-tips)
to provide you the envs.
</FbInternalOnly>

### Logging

Expand All @@ -132,10 +135,13 @@ level. If you really want its log, you can set `RUST_LOG=virtiofsd=debug`.

Non-console interactive debugging sub targets will also capture console output
into a temporary file and print out the path to the console output. The file is
accessible the host system and thus you can tail it in a different terminal. We
also have more
[internal integration](fb/vm-tests.md#more-internal-debugging-tips) for console
logs when tests are run.
accessible the host system and thus you can tail it in a different terminal.

<FbInternalOnly>
We also have more [internal
integration](fb/vm-tests.md#more-internal-debugging-tips) for console logs when
tests are run.
</FbInternalOnly>

### Debugging Tips

Expand Down
2 changes: 2 additions & 0 deletions antlir/antlir2/docs/docs/recipes/multi-os-images.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -126,10 +126,12 @@ easier-to-understand error.

:::

<InternalOnly>
### CI for packages

See the [internal page](fb/multi-os-images-ci-recommendations.md) for CI
structure recommendations.
</InternalOnly>

## Debugging

Expand Down
2 changes: 1 addition & 1 deletion antlir/antlir2/docs/gen_api/src/main.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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",
},
Expand Down
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 96ee26e

Please sign in to comment.