Fokko commented on code in PR #237: URL: https://github.com/apache/iceberg-cpp/pull/237#discussion_r2374923208
########## .github/workflows/docs.yml: ########## @@ -0,0 +1,78 @@ +name: Deploy Documentation + +on: + push: + branches: + - main + paths: + - 'mkdocs/**' + - 'src/**' + pull_request: + branches: + - main + paths: + - 'mkdocs/**' + - 'src/**' + +permissions: + contents: read + pages: write + id-token: write + +concurrency: + group: "pages" + cancel-in-progress: false + +jobs: + build: + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v4 + + - name: Setup Python + uses: actions/setup-python@v4 + with: + python-version: '3.11' + + - name: Install dependencies + run: | + python -m pip install --upgrade pip + pip install mkdocs-material Review Comment: Maybe move this to a `requirements.txt` and slap a version on it. Otherwise, the workflow might break in case of a new version of mkdocs-material that introduces a breaking change. ########## .github/workflows/docs.yml: ########## @@ -0,0 +1,78 @@ +name: Deploy Documentation + +on: + push: + branches: + - main + paths: + - 'mkdocs/**' + - 'src/**' + pull_request: + branches: + - main + paths: + - 'mkdocs/**' + - 'src/**' + +permissions: + contents: read + pages: write + id-token: write + +concurrency: + group: "pages" + cancel-in-progress: false + +jobs: + build: + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v4 + + - name: Setup Python + uses: actions/setup-python@v4 + with: + python-version: '3.11' + + - name: Install dependencies + run: | + python -m pip install --upgrade pip + pip install mkdocs-material + sudo apt-get update + sudo apt-get install -y doxygen + + - name: Setup Pages + uses: actions/configure-pages@v4 + + - name: Build API documentation with Doxygen + run: | + cd mkdocs + mkdir -p docs/api + doxygen Doxyfile + + - name: Build with MkDocs + run: | + cd mkdocs + mkdocs build --clean Review Comment: How about moving these commands into a `Makefile` so it can be both invoked by the workflow, but also locally in case you want to iterate quickly. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: issues-unsubscr...@iceberg.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org --------------------------------------------------------------------- To unsubscribe, e-mail: issues-unsubscr...@iceberg.apache.org For additional commands, e-mail: issues-h...@iceberg.apache.org
