This repository was archived by the owner on Jul 12, 2024. It is now read-only.
-
-
Notifications
You must be signed in to change notification settings - Fork 12
Add a new check for copyediting #105
Closed
Closed
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,34 @@ | ||
| from baldrick.plugins.github_pull_requests import pull_request_handler | ||
|
|
||
|
|
||
| # TODO: we need to note somewhere that if the copyeditor changes, this needs to | ||
| # be updated! | ||
| COPYEDITOR_GH_HANDLE = 'lglattly' | ||
|
|
||
|
|
||
| @pull_request_handler | ||
| def check_copyedit_docs(pr_handler, repo_handler): | ||
| statuses = {} | ||
|
|
||
| if 'docs' in pr_handler.labels: | ||
| if 'copyedited' in pr_handler.labels: | ||
| statuses['copyedit'] = { | ||
| 'description': "This PR has been copyedited.", | ||
| 'state': 'success' | ||
| } | ||
|
|
||
| else: | ||
| statuses['copyedit'] = { | ||
| 'description': "This PR modifies the documentation and is " | ||
| "waiting for copyediting. No action is needed " | ||
| "from the contributor.", | ||
| 'state': 'failure' | ||
| } | ||
|
|
||
| else: | ||
| return None | ||
|
|
||
| if COPYEDITOR_GH_HANDLE not in pr_handler.json['assignees']: | ||
| pr_handler.add_assignees(COPYEDITOR_GH_HANDLE) | ||
|
|
||
| return statuses | ||
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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe this can be a configurable item in
pyproject.toml? If other packages decides to deploy this in their own repo, you don't wantlglattlyto get spammed.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
haha! Right.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Although, it might be a way to get @lglattly some more work ;)