fix(dotprompt-emacs): remove internal markup from end-user features #779
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
| # Copyright 2025 Google LLC | |
| # | |
| # 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 | |
| name: Eng Documentation Checks | |
| on: | |
| pull_request: | |
| branches: [ main ] | |
| jobs: | |
| check-paths: | |
| runs-on: ubuntu-latest | |
| outputs: | |
| any_changed: ${{ steps.changed-files.outputs.any_changed }} | |
| steps: | |
| - uses: actions/checkout@v6 | |
| with: | |
| fetch-depth: 0 | |
| - name: Get changed files | |
| id: changed-files | |
| uses: tj-actions/changed-files@v45 | |
| with: | |
| files: | | |
| docs/** | |
| .github/workflows/engdoc.yml | |
| engdoc-checks: | |
| needs: check-paths | |
| if: needs.check-paths.outputs.any_changed == 'true' | |
| runs-on: ubuntu-latest | |
| env: | |
| PATH: ${{ github.workspace }}/go/bin:${{ github.workspace }}/.cargo/bin:${{ github.workspace }}/.local/share/pnpm:${{ github.workspace }}/.local/bin:/usr/local/bin:/usr/bin:/bin | |
| # Enable sccache for Rust builds | |
| SCCACHE_GHA_ENABLED: "true" | |
| RUSTC_WRAPPER: "sccache" | |
| strategy: | |
| matrix: | |
| python-version: | |
| - "3.12" | |
| fail-fast: false | |
| steps: | |
| - uses: actions/checkout@v6 | |
| - name: Install system dependencies | |
| run: | | |
| sudo apt-get update | |
| sudo apt-get install -y build-essential libffi-dev cmake curl ripgrep | |
| - name: Install Rust | |
| uses: dtolnay/rust-toolchain@stable | |
| with: | |
| components: rustfmt, clippy | |
| env: | |
| RUSTUP_MAX_RETRIES: 3 | |
| - name: Setup sccache | |
| uses: mozilla-actions/sccache-action@v0.0.9 | |
| - name: Set up Go | |
| uses: actions/setup-go@v6 | |
| with: | |
| go-version: stable | |
| - name: Install uv and setup Python version | |
| uses: astral-sh/setup-uv@v5 | |
| with: | |
| enable-cache: true | |
| python-version: ${{ matrix.python-version }} | |
| - name: Install Python dependencies | |
| run: | | |
| cd python | |
| uv pip install -e .[dev,test,docs] | |
| - name: Install D2 diagramming tool | |
| run: | | |
| go install oss.terrastruct.com/d2@latest | |
| - name: Install mkdocs | |
| run: | | |
| uv tool install \ | |
| mkdocs \ | |
| --with mkdocs-autorefs \ | |
| --with mkdocs-d2-plugin \ | |
| --with mkdocs-literate-nav \ | |
| --with mkdocs-material \ | |
| --with mkdocs-mermaid2-plugin \ | |
| --with mkdocs-minify-plugin \ | |
| --with mkdocstrings[python] | |
| - name: Build documentation | |
| run: uv run mkdocs build | |
| engdoc-checks-all: | |
| if: always() | |
| needs: [engdoc-checks] | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Check overall status | |
| run: | | |
| if [[ "${NEEDS_ENGDOC_CHECKS_RESULT}" == "failure" ]]; then | |
| echo "Eng documentation checks failed" | |
| exit 1 | |
| fi | |
| echo "Eng documentation checks passed or were skipped" | |
| exit 0 | |
| env: | |
| NEEDS_ENGDOC_CHECKS_RESULT: ${{ needs.engdoc-checks.result }} |