Check files affected by task contribution Pull Requests #2644
Conversation
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
Co-authored-by: Rafael Oliveira <[email protected]>
This ensures that task contribution proposal/submission content is identical in the pull request description and the affected README.md file, so that reviewers can have confidence that they need only check one of them without comparing against the other.
RafDevX
commented
Oct 13, 2024
Comment on lines
+86
to
+87
| check-canvas: | ||
| name: Check proposal is compatible with previous student task registrations |
There was a problem hiding this comment.
Unsure whether we should require our new check to pass before running the existing Python script.
Suggested change
| check-canvas: | |
| name: Check proposal is compatible with previous student task registrations | |
| check-canvas: | |
| name: Check proposal is compatible with previous student task registrations | |
| needs: check-pr-description |
For now, we have opted not to specify a dependency so that the jobs can run in parallel and be faster for "good PRs", which should be the majority in volume, even if "bad PRs" may suffer slightly since the last job is not aborted even if another one fails first. In any case, the scale is arguably negligible; all the checks are relatively quick.
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.
Fixes #2583
This pull request checks whether any contributions match the norm of what is expected of a task proposal/submission:
README.mdand in a reasonable location; and