diff --git a/.github/workflows/build-and-deploy.yml b/.github/workflows/build-and-deploy.yml index 997d6b7..6f312e3 100644 --- a/.github/workflows/build-and-deploy.yml +++ b/.github/workflows/build-and-deploy.yml @@ -1,28 +1,27 @@ name: Build & Deploy Docs permissions: - contents: read # 'read' is sufficient for checkout - pages: write # Required to deploy to Pages - id-token: write # Required to verify the deployment + contents: read + pages: write + id-token: write on: push: branches: [main] + pull_request: # Added: Build will now check every PR + branches: [main] workflow_dispatch: jobs: - build-deploy: + # JOB 1: Build and Verify (Runs on PRs and Pushes) + build: runs-on: ubuntu-latest - environment: - name: github-pages - url: ${{ steps.deployment.outputs.page_url }} - steps: - name: Checkout main repo - uses: actions/checkout@v6 + uses: actions/checkout@v4 - name: Set up Conda - uses: conda-incubator/setup-miniconda@v4 + uses: conda-incubator/setup-miniconda@v3 with: activate-environment: vrui environment-file: environment.yml @@ -33,7 +32,7 @@ jobs: shell: bash -el {0} run: bash scripts/clone_docs.sh - - name: Generate mkdocs.yml + - name: Generate zensical config shell: bash -el {0} run: python scripts/generate_zensical.py @@ -42,10 +41,19 @@ jobs: run: zensical build --config-file zensical.generated.toml --clean - name: Upload artifact - uses: actions/upload-pages-artifact@v5 + uses: actions/upload-pages-artifact@v3 with: path: 'site' + # JOB 2: Deploy (Only runs on main after Build succeeds) + deploy: + needs: build + if: github.event_name == 'push' && github.ref == 'refs/heads/main' + runs-on: ubuntu-latest + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + steps: - name: Deploy to GitHub Pages id: deployment - uses: actions/deploy-pages@v5 \ No newline at end of file + uses: actions/deploy-pages@v4 \ No newline at end of file diff --git a/.gitignore b/.gitignore index ad2d39f..62f2303 100644 --- a/.gitignore +++ b/.gitignore @@ -6,8 +6,8 @@ docs/arsandbox docs/vrui docs/kinect docs/3dvisualizer -docs/CODE_OF_CONDUCT.md -docs/CONTRIBUTING.md +docs/code_of_conduct.md +docs/contributing.md docs/assets/GitHub_Header_Discussions.png docs/assets/GitHub_Header_Issues.png diff --git a/docs/shared/pullpackage.md b/docs/shared/pullpackage.md index a8acfcb..a00ff64 100644 --- a/docs/shared/pullpackage.md +++ b/docs/shared/pullpackage.md @@ -17,7 +17,7 @@ In detail, the prerequisite installation steps are as follows: #### Install PullPackage -To install the PullPackage package manager, copy the command from the following box into a terminal window and press the Enter key: +To install the PullPackage package manager, copy the command from the following box into a terminal window and press ++enter++: ```sh curl https://vroom.library.ucdavis.edu/PullPackage | bash diff --git a/docs/shared/pullpackage_kinect.md b/docs/shared/pullpackage_kinect.md index 21322d1..febee10 100644 --- a/docs/shared/pullpackage_kinect.md +++ b/docs/shared/pullpackage_kinect.md @@ -6,8 +6,8 @@ The Kinect package contains drivers for several types of 3D cameras that are use PullPackage Kinect ``` - -```sh -PullPackage Vrui && PullPackage Kinect -``` --> \ No newline at end of file + + + \ No newline at end of file