Fix typos in example notebooks #20
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
| # Notebook-related checks | |
| name: Notebooks | |
| on: | |
| # Relevant PRs | |
| pull_request: | |
| paths: | |
| - "site/en/**" | |
| # Allow manual runs | |
| workflow_dispatch: | |
| jobs: | |
| 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 master branch | |
| run: git fetch -u origin main:main | |
| - name: Check notebook formatting | |
| run: | | |
| if [ "${{ github.event_name }}" == "pull_request" ]; then | |
| # Only check notebooks modified in this pull request | |
| readarray -t changed_notebooks < <(git diff --name-only main | grep '\.ipynb$' || true) | |
| else | |
| # Manual run, check everything | |
| readarray -t changed_notebooks < <(find site/en/ -name '*.ipynb') | |
| fi | |
| if [[ ${#changed_notebooks[@]} == 0 ]]; then | |
| echo "No notebooks modified in this pull request." | |
| exit 0 | |
| else | |
| echo "Check formatting with nbfmt:" | |
| python3 -m tensorflow_docs.tools.nbfmt --test "${changed_notebooks[@]}" | |
| fi | |
| nblint: | |
| name: Notebook lint | |
| 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 | |
| run: git fetch -u origin main:main | |
| - name: Lint notebooks | |
| run: | | |
| if [ "${{ github.event_name }}" == "pull_request" ]; then | |
| # Only check notebooks modified in this pull request | |
| readarray -t changed_notebooks < <(git diff --name-only main | grep '\.ipynb$' || true) | |
| else | |
| # Manual run, check everything | |
| readarray -t changed_notebooks < <(find site/en/ -name '*.ipynb') | |
| fi | |
| if [[ ${#changed_notebooks[@]} == 0 ]]; then | |
| echo "No notebooks modified in this pull request." | |
| exit 0 | |
| else | |
| echo "Lint check with nblint:" | |
| python3 -m tensorflow_docs.tools.nblint \ | |
| --styles=google,tensorflow \ | |
| --arg=repo:google/generative-ai-docs --arg=branch:main \ | |
| --arg=base_url:https://developers.generativeai.google/ \ | |
| --exclude_lint=tensorflow::button_download \ | |
| "${changed_notebooks[@]}" | |
| fi |