Skip to content

[FSTORE-1921] Improve documentation building process #7

[FSTORE-1921] Improve documentation building process

[FSTORE-1921] Improve documentation building process #7

Workflow file for this run

name: mkdocs-test
on: pull_request
jobs:
mkdocs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
- name: Markdownlint
uses: DavidAnson/markdownlint-cli2-action@v21
with:
globs: '**/*.md'
- name: set dev version
working-directory: java
run: echo "DEV_VERSION=$(mvn org.apache.maven.plugins:maven-help-plugin:2.1.1:evaluate -Dexpression=project.version | grep -Ev 'Download|INFO|WARNING')" >> $GITHUB_ENV
- name: Cache local Maven repository
uses: actions/cache@v4
with:
path: ~/.m2/repository
key: ${{ runner.os }}-maven-${{ hashFiles('java/pom.xml') }}
restore-keys: |
${{ runner.os }}-maven-
- name: Set up JDK 8
uses: actions/setup-java@v5
with:
java-version: "8"
distribution: "adopt"
- name: Build javadoc documentation
working-directory: java
run: mvn clean install javadoc:javadoc javadoc:aggregate -DskipTests && cp -r target/site/apidocs ../docs/javadoc
- uses: actions/setup-python@v5
with:
python-version: "3.10"
- name: Install uv
uses: astral-sh/setup-uv@v7
with:
activate-environment: true
working-directory: python
- name: Install dependencies
run: uv sync --extra dev --group docs --project python
- name: Setup git for mike
run: |
git config --global user.name Mike
git config --global user.email [email protected]
- name: Copy CONTRIBUTING.md
run: cp CONTRIBUTING.md docs/
- name: Generate the docs with mike
run: mike deploy ${{ env.DEV_VERSION }} dev -u