Skip to content

#148 - Add RBAC authz sidecar (#445) #57

#148 - Add RBAC authz sidecar (#445)

#148 - Add RBAC authz sidecar (#445) #57

Workflow file for this run

# SPDX-FileCopyrightText: Copyright (c) 2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# SPDX-License-Identifier: Apache-2.0
# Workflow for building and deploying Sphinx documentation to GitHub Pages
name: Docs Deployment
on:
# Runs on pushes targeting the main branch
push:
branches: [ main ]
paths:
- 'docs/**'
- 'workflows/**'
# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:
# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
concurrency:
group: "pages"
cancel-in-progress: false
jobs:
# Build job for Sphinx documentation
deploy:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5 # v4.3.1
with:
lfs: true
- name: Setup Python
uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6.2.0
with:
python-version: '3.10.18'
- name: Install dependencies
run: |
git fetch
pip install -U -r docs/locked_requirements.txt
pip install -U -r src/locked_requirements.txt
- name: Build Sphinx documentation
run: |
make -C docs build-multiversion ERR_DIR=build_error_logs OUT_DIR=public
- name: Check for build errors
run: |
if [ -d "docs/build_error_logs" ] && [ "$(find docs/build_error_logs -name '*.log' -size +0c)" ]; then
echo "Build errors found:"
find docs/build_error_logs -name '*.log' -size +0c -exec echo "Error in {}: " \; -exec cat {} \;
exit 1
else
echo "Build completed successfully with no errors"
fi
- name: Upload build artifacts
uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # v6.0.0
with:
name: documentation-build
path: |
docs/public/
docs/build_error_logs/
retention-days: 5
- name: Upload Pages artifact
uses: actions/upload-pages-artifact@7b1f4a764d45c48632c6b24a0339c27f5614fb0b # v4.0.0
with:
path: 'docs/public/'
- name: Deploy to GitHub Pages
uses: JamesIves/github-pages-deploy-action@d92aa235d04922e8f08b40ce78cc5442fcfbfa2f # v4.8.0
with:
branch: gh-pages/documentation
folder: docs/public
clean-exclude: |
pr-preview/
.nojekyll
force: false