Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Lint non-website notebooks #223

Merged
merged 1 commit into from
Jan 16, 2024
Merged

Lint non-website notebooks #223

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
77 changes: 71 additions & 6 deletions .github/workflows/notebooks.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,12 @@ on:
# Relevant PRs
pull_request:
paths:
- "site/en/**"
- "templates/**"
- "**.ipynb"
# Allow manual runs
workflow_dispatch:

jobs:
# Format all notebooks.
nbfmt:
name: Notebook format
runs-on: ubuntu-latest
Expand All @@ -29,7 +29,7 @@ jobs:
readarray -t changed_notebooks < <(git diff --name-only main | grep '\.ipynb$' || true)
else
# Manual run, check everything
readarray -t changed_notebooks < <(find site/en/ templates/ -name '*.ipynb')
readarray -t changed_notebooks < <(find -name '*.ipynb')
fi
if [[ ${#changed_notebooks[@]} == 0 ]]; then
echo "No notebooks modified in this pull request."
Expand All @@ -45,21 +45,35 @@ jobs:
steps:
- uses: actions/checkout@v3
- uses: actions/setup-python@v4
- uses: dorny/paths-filter@v2
id: filter
with:
filters: |
website:
- 'site/en/**/**.ipynb'
github_docs:
- 'examples/**/**.ipynb'
- 'demos/**/**.ipynb'
templates:
- 'templates/**/**.ipynb'
- 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

# Full lint for website notebooks (incl. website button)
- name: Lint website notebooks
if: steps.filter.outputs.website == 'true'
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$' |grep -v '^templates/' || true)
readarray -t changed_notebooks < <(git diff --name-only main site/en/ |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."
echo "No website notebooks modified in this pull request."
exit 0
else
echo "Lint check with nblint:"
Expand All @@ -70,3 +84,54 @@ jobs:
--exclude_lint=tensorflow::button_download \
"${changed_notebooks[@]}"
fi

# Reduced lint for notebooks hosted in GitHub
- name: Lint documentation notebooks
if: steps.filter.outputs.github_docs == 'true'
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 demos/ examples/ |grep '\.ipynb$' || true)
else
# Manual run, check everything
readarray -t changed_notebooks < <(find demos/ examples/ -name '*.ipynb')
fi
if [[ ${#changed_notebooks[@]} == 0 ]]; then
echo "No GitHub doc 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 \
--exclude_lint=tensorflow::button_download \
--exclude_lint=tensorflow::button_website \
"${changed_notebooks[@]}"
fi

# Basic lint for template notebooks
- name: Lint template notebooks
if: steps.filter.outputs.templates == 'true'
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 templates/ |grep '\.ipynb$' || true)
else
# Manual run, check everything
readarray -t changed_notebooks < <(find templates/ -name '*.ipynb')
fi
if [[ ${#changed_notebooks[@]} == 0 ]]; then
echo "No template 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 \
--exclude_lint=tensorflow::button_download \
--exclude_lint=tensorflow::button_website \
--exclude_lint=tensorflow::button_colab \
--exclude_lint=tensorflow::button_github \
"${changed_notebooks[@]}"
fi

Loading