Auto format notebooks #478
Workflow file for this run
This file contains 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: Notebooks | |
| on: | |
| # Relevant PRs | |
| pull_request: | |
| paths: | |
| - "**.ipynb" | |
| # Allow manual runs | |
| workflow_dispatch: | |
| jobs: | |
| # Format all notebooks. | |
| nbfmt: | |
| name: Notebook format | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - uses: actions/setup-python@v4 | |
| - name: Install tensorflow-docs | |
| run: python3 -m pip install -U git+https://github.com/tensorflow/docs | |
| - name: Fetch main branch | |
| if: ${{ github.event_name == 'pull_request' }} # Only need to fetch main on PRs | |
| run: git fetch -u origin main:main | |
| - name: Get changed notebooks | |
| id: changed-notebooks | |
| run: | | |
| if [ "${{ github.event_name }}" == "pull_request" ]; then | |
| # Only check notebooks modified in this pull request | |
| git diff --name-only origin/main | grep '\.ipynb$' > changed_notebooks.txt | |
| else | |
| # Manual run, check everything | |
| find . -name '*.ipynb' > changed_notebooks.txt | |
| fi | |
| echo "changed_notebooks=$(cat changed_notebooks.txt)" >> $GITHUB_OUTPUT | |
| - name: Format notebooks | |
| run: | | |
| if [ -s "${{ steps.changed-notebooks.outputs.changed_notebooks }}" ]; then | |
| echo "Formatting notebooks with nbfmt:" | |
| python3 -m tensorflow_docs.tools.nbfmt ${{ steps.changed-notebooks.outputs.changed_notebooks }} | |
| else | |
| echo "No notebooks to format." | |
| fi | |
| - name: Commit and push changes (if any) | |
| if: ${{ success() }} | |
| run: | | |
| git config --local user.email "[email protected]" | |
| git config --local user.name "GitHub Action" | |
| git diff --quiet && git diff --staged --quiet || (git commit -a -m "Format notebooks" && git push) | |
| nblint: | |
| name: Notebook lint | |
| runs-on: ubuntu-latest | |
| needs: nbfmt # Ensure nblint runs after nbfmt | |
| steps: | |
| - uses: actions/checkout@v3 | |
| with: | |
| # Checkout PR branch for PR events, main branch for manual runs | |
| ref: ${{ github.event_name == 'pull_request' && github.event.pull_request.head.ref || 'main' }} | |
| - uses: actions/setup-python@v4 | |
| - name: Install tensorflow-docs | |
| run: python3 -m pip install -U git+https://github.com/tensorflow/docs | |
| - name: Fetch main branch | |
| if: ${{ github.event_name == 'pull_request' }} # Only need to fetch main on PRs | |
| run: git fetch -u origin main:main | |
| - name: Get changed notebooks | |
| id: changed-notebooks | |
| run: | | |
| if [ "${{ github.event_name }}" == "pull_request" ]; then | |
| # Only check notebooks modified in this pull request | |
| git diff --name-only origin/main | grep '\.ipynb$' > changed_notebooks.txt | |
| else | |
| # Manual run, check everything | |
| find . -name '*.ipynb' > changed_notebooks.txt | |
| fi | |
| echo "changed_notebooks=$(cat changed_notebooks.txt)" >> $GITHUB_OUTPUT | |
| # Lint for all notebooks | |
| - name: Lint notebooks | |
| run: | | |
| if [ -s "${{ steps.changed-notebooks.outputs.changed_notebooks }}" ]; then | |
| echo "WARNING: If the button_colab check fails for you, make sure you have <table class=\"tfo-notebook-buttons\"...>" | |
| echo "Lint check with nblint:" | |
| python3 -m tensorflow_docs.tools.nblint \ | |
| --styles=google,tensorflow \ | |
| --arg=repo:google-gemini/cookbook \ | |
| --arg=branch:main \ | |
| --exclude_lint=tensorflow::button_download \ | |
| --exclude_lint=tensorflow::button_website \ | |
| --arg=base_url:https://ai.google.dev/ \ | |
| --exclude_lint=tensorflow::button_github \ | |
| ${{ steps.changed-notebooks.outputs.changed_notebooks }} | |
| else | |
| echo "No notebooks to lint." | |
| fi |