Skip to content

Remove internal CommittableTx changelog entry (#8270) #1263

Remove internal CommittableTx changelog entry (#8270)

Remove internal CommittableTx changelog entry (#8270) #1263

Workflow file for this run

name: "Doc"
on:
push:
branches:
- main
workflow_dispatch:
permissions: read-all
jobs:
build:
name: Build
runs-on: ubuntu-latest
container:
image: mcr.microsoft.com/azurelinux/base/core:3.0
steps:
- name: "Checkout dependencies"
shell: bash
run: |
gpg --import /etc/pki/rpm-gpg/MICROSOFT-RPM-GPG-KEY
tdnf -y update
tdnf -y install ca-certificates git
- run: git config --global --add safe.directory "$GITHUB_WORKSPACE"
- uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
with:
fetch-depth: 0
- name: Install dependencies
uses: ./.github/actions/install-ci-dependencies
with:
python-requirements: doc/requirements.txt,doc/historical_ccf_requirements.txt
- name: Setup Pages
id: pages
uses: actions/configure-pages@45bfe0192ca1faeb007ade9deae92b16b8254a0d # v6.0.0
- name: Build Documentation
run: |
set -x
python3 -m venv --without-pip env
source env/bin/activate
uv pip install -e ./python
uv pip install -r doc/requirements.txt
uv pip install -r doc/historical_ccf_requirements.txt
sphinx-multiversion -D smv_remote_whitelist=origin doc build/html
shell: bash
- name: Set up top-level directory
run: |
set -x
cd build/html
touch .nojekyll
cp ../../doc/index.html .
shell: bash
- name: Upload pages
uses: actions/upload-pages-artifact@fc324d3547104276b827a68afc52ff2a11cc49c9 # v5.0.0
with:
path: build/html
deploy:
name: Deploy
needs: build
runs-on: ubuntu-latest
permissions:
# Needed to authorize deployment to GitHub Pages
pages: write
# Needed to authenticate via OIDC
# See https://github.com/actions/deploy-pages?tab=readme-ov-file#usage
id-token: write
environment:
name: github-pages
url: ${{steps.deployment.outputs.page_url}}
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@cd2ce8fcbc39b97be8ca5fce6e763baed58fa128 # v5.0.0