Skip to content

SOF-7933: update currently available software modules #423

SOF-7933: update currently available software modules

SOF-7933: update currently available software modules #423

Workflow file for this run

name: Build tests and GitHub release
on:
push:
branches:
- main
pull_request:
branches:
- main
jobs:
run-py-tests:
runs-on: ${{ matrix.os }}
strategy:
matrix:
os: ["ubuntu-24.04"]
python-version:
- "3.10"
# No need to run with many Py versions - as long as one is passing, we should be OK
# - "3.11"
# - "3.12"
# - "3.13"
steps:
- name: Checkout repository and submodules
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
with:
fetch-depth: 0
lfs: true
submodules: true
- name: Setup python 3
uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6.2.0
with:
python-version: ${{ matrix.python-version }}
- name: Install dependencies
run: |
pip install -r requirements.txt
- name: Build documentation (legacy)
run: |
python -m mkdocs build -f mkdocs.yml
- name: Build split sites
run: |
python -m mkdocs build -f mkdocs-guide.yml -d site/guide
python -m mkdocs build -f mkdocs-interface.yml -d site/interface
python -m mkdocs build -f mkdocs-concepts.yml -d site/reference
python -m mkdocs build -f mkdocs-resources.yml -d site/resources
python -m mkdocs build -f mkdocs-developers.yml -d site/developers
python -m mkdocs build -f mkdocs-cli.yml -d site/command-line
python -m mkdocs build -f mkdocs-standards.yml -d site/standards
# Fix and copy subsite homepages to root of each subsite
fix_homepage() {
local src="$1"
local dst="$2"
if [ -f "$src" ]; then
sed \
-e 's|"base": ".."|"base": "."|' \
-e 's|"\.\./assets/|"./assets/|g' \
-e 's|"\.\./search/|"./search/|g' \
-e 's|"\.\./extra/|"./extra/|g' \
-e 's|"\.\./images/|"./images/|g' \
-e 's|href="\.\./|href="./|g' \
-e 's|src="\.\./|src="./|g' \
"$src" > "$dst"
fi
}
fix_homepage site/guide/index-guide/index.html site/guide/index.html
fix_homepage site/interface/index-interface/index.html site/interface/index.html
fix_homepage site/reference/index-concepts/index.html site/reference/index.html
fix_homepage site/resources/index-resources/index.html site/resources/index.html
fix_homepage site/developers/index-developers/index.html site/developers/index.html
fix_homepage site/command-line/index-cli/index.html site/command-line/index.html
fix_homepage site/standards/index-standards/index.html site/standards/index.html
- name: Check for broken internal links
run: python scripts/links/check-links.py site
publish-py-package:
needs:
- run-py-tests
runs-on: ubuntu-24.04
if: (github.ref_name == 'main')
steps:
- name: Checkout this repository
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
with:
lfs: true
- name: Checkout actions repository
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
with:
repository: Exabyte-io/actions
token: ${{ secrets.BOT_GITHUB_TOKEN }}
path: actions
- name: Publish python release
uses: ./actions/py/publish
with:
python-version: "3.10"
github-token: ${{ secrets.BOT_GITHUB_TOKEN }}
publish-tag: "true"
publish-to-pypi: "false"