[HWORKS-2991][APPEND][HWORKS-3040] Correct conda-era docs claims, and document installing a compiler #1476
Workflow file for this run
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: mkdocs-test | |
| on: pull_request | |
| jobs: | |
| test-docs-build: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout main repo | |
| uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 | |
| - name: Checkout the API repo | |
| uses: actions/checkout@v4 | |
| with: | |
| repository: logicalclocks/hopsworks-api | |
| ref: ${{ github.base_ref }} | |
| path: hopsworks-api | |
| - uses: actions/setup-python@v5 | |
| with: | |
| python-version: "3.13" | |
| - name: Install uv | |
| uses: astral-sh/setup-uv@v7 | |
| with: | |
| activate-environment: true | |
| - name: Install Python dependencies | |
| run: uv sync --extra cli | |
| - name: Install Hopsworks Python API | |
| run: uv pip install hopsworks-api/python | |
| - name: Install Ubuntu dependencies | |
| run: sudo apt update && sudo apt-get install -y libxml2-dev libxslt-dev | |
| - name: Markdownlint | |
| run: hopsworks-docs markdownlint | |
| - name: Snakeoil (Python code blocks in markdown) | |
| run: hopsworks-docs snakeoil | |
| - name: Generate Helm values reference | |
| env: | |
| NEXUS_USER: ${{ secrets.NEXUS_USER }} | |
| NEXUS_PASSWORD: ${{ secrets.NEXUS_PASSWORD }} | |
| BASE_REF: ${{ github.base_ref }} | |
| run: | | |
| if [ "$BASE_REF" = "main" ]; then | |
| # dev docs: latest chart from the (private) dev channel. Fork PRs do | |
| # not receive secrets, so skip (keep the page placeholder) when the | |
| # Nexus credentials are absent rather than failing the build. | |
| if [ -n "$NEXUS_USER" ]; then | |
| hopsworks-docs gen-helm-values \ | |
| --repo-url https://nexus.hops.works/repository/hopsworks-helm-dev | |
| else | |
| echo "Nexus credentials not available (e.g. a fork PR); keeping the values reference placeholder." | |
| fi | |
| else | |
| # release docs: latest patch of the chart version (major.minor) for this docs version. | |
| # The released repo is public, so fetch anonymously (clear any creds). | |
| NEXUS_USER= NEXUS_PASSWORD= hopsworks-docs gen-helm-values \ | |
| --repo-url https://nexus.hops.works/repository/hopsworks-helm \ | |
| --chart-version "${BASE_REF#branch-}" | |
| fi | |
| - name: Check mkdocs warnings | |
| run: hopsworks-docs check | |
| - 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: hopsworks-api/java | |
| run: mvn clean install javadoc:javadoc javadoc:aggregate -DskipTests -Dspark.version=3.5.5 -Dhudi.version=1.0.2 && cp -r target/site/apidocs ../../docs/javadoc | |
| - name: Check for broken links | |
| run: hopsworks-docs linkchecker | |
| - name: Setup git for mike | |
| run: | | |
| git config --global user.name Mike | |
| git config --global user.email mike@docs.hopsworks.ai | |
| - name: Generate the docs with mike | |
| run: mike deploy test-version |