npmpy docstring validation against changed files in pr#173
Open
shivashanmugam wants to merge 1 commit into
Open
npmpy docstring validation against changed files in pr#173shivashanmugam wants to merge 1 commit into
shivashanmugam wants to merge 1 commit into
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #173 +/- ##
=======================================
Coverage 65.28% 65.28%
=======================================
Files 34 34
Lines 2394 2394
=======================================
Hits 1563 1563
Misses 831 831
Flags with carried forward coverage won't be shown. Click here to find out more. 🚀 New features to boost your workflow:
|
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the CI workflow to make NumPy docstring validation blocking for pull requests, while limiting the validation scope to only the Python files changed in the PR (under src/microbots/*.py), aligning with the existing numpydoc-validation pre-commit hook filter.
Changes:
- Adds a new GitHub Actions job that computes changed Python files in a PR and runs
pre-commit run numpydoc-validationonly on those files (failing the job on violations). - Keeps the existing all-files docstring job as informational/non-blocking.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+114
to
+123
| run: | | ||
| base="${{ github.event.pull_request.base.sha }}" | ||
| head="${{ github.event.pull_request.head.sha }}" | ||
|
|
||
| files=$(git diff --name-only --diff-filter=ACMR "$base" "$head" \ | ||
| | grep -E '^src/microbots/.*\.py$' || true) | ||
|
|
||
| # Collapse to a single space-separated line for use in later steps. | ||
| files=$(echo "$files" | tr '\n' ' ' | xargs || true) | ||
| echo "files=$files" >> "$GITHUB_OUTPUT" |
Comment on lines
+140
to
+142
| set +e | ||
| output=$(pre-commit run numpydoc-validation --files ${{ steps.changed.outputs.files }} 2>&1) | ||
| status=$? |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
numpy docstrings validation against changed files in a pr
.
As of now microbots have validation against all files which will report coverage without blocking the PR.
.
But with this change microbots will validate numpy docstrings only against the changes files will block if the numpy validation fails