-
Notifications
You must be signed in to change notification settings - Fork 1k
Add issue template for revdep check failures #7662
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.
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
Closed
mahjabinoyshi
wants to merge
3
commits into
Rdatatable:master
from
mahjabinoyshi:revdep-issue-template
+45
−0
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,45 @@ | ||||||||||||||||||
| --- | ||||||||||||||||||
| name: Revdep check failure | ||||||||||||||||||
| about: Contact a reverse dependency maintainer about a new check failure caused by data.table changes | ||||||||||||||||||
| title: "[revdep] YOUR_PACKAGE: new check failure with data.table master" | ||||||||||||||||||
| labels: [] | ||||||||||||||||||
| assignees: [] | ||||||||||||||||||
| --- | ||||||||||||||||||
| Hi @MAINTAINER, | ||||||||||||||||||
| After installing **data.table** from GitHub master | ||||||||||||||||||
| ```r | ||||||||||||||||||
| data.table::update_dev_pkg() | ||||||||||||||||||
| ``` | ||||||||||||||||||
| and then running `R CMD check` on **YOUR_PACKAGE**, I get the following new failure, which is **not present** when using data.table from CRAN. | ||||||||||||||||||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||||||||||
| ## Package and environment | ||||||||||||||||||
| - Package: YOUR_PACKAGE | ||||||||||||||||||
| - Package version: YOUR_PACKAGE_VERSION | ||||||||||||||||||
| - R version(s): R_RELEASE_AND_OR_R_DEVEL | ||||||||||||||||||
| - data.table versions: | ||||||||||||||||||
| - CRAN: DT_CRAN_VERSION | ||||||||||||||||||
| - GitHub master: DT_MASTER_SHA_OR_VERSION | ||||||||||||||||||
| - Platform: OS / architecture (for example, linux-x86_64) | ||||||||||||||||||
|
Comment on lines
+14
to
+21
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||||||||||
| ## Related data.table issue and commit | ||||||||||||||||||
| - Data.table issue: https://github.com/Rdatatable/data.table/issues/REVDEP_ISSUE_NUMBER | ||||||||||||||||||
| - First bad commit (from revdep checks): https://github.com/Rdatatable/data.table/commit/FIRST_BAD_COMMIT_SHA | ||||||||||||||||||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||||||||||
| ## Check output | ||||||||||||||||||
| Below is the relevant part of the failing check log: | ||||||||||||||||||
| ```text | ||||||||||||||||||
| OUTPUT_FROM_FAILING_CHECK | ||||||||||||||||||
| ``` | ||||||||||||||||||
| ## Suggested fix | ||||||||||||||||||
| Before uploading new versions to CRAN, **data.table** needs to ensure that updates do not break CRAN checks in dependent packages like **YOUR_PACKAGE**. So can you please submit an updated version of **YOUR_PACKAGE** to CRAN that fixes this check issue? | ||||||||||||||||||
| In particular, I would suggest to avoid | ||||||||||||||||||
| > DOING_WHAT_YOU_ARE_DOING_CURRENTLY | ||||||||||||||||||
| ... | ||||||||||||||||||
| > DOING_SOMETHING_MORE_ROBUST. | ||||||||||||||||||
| ## Additional context (optional) | ||||||||||||||||||
| - Minimal reproducible example, if available. | ||||||||||||||||||
| - Links to previous revdep check runs or CRAN check results for YOUR_PACKAGE. | ||||||||||||||||||
| - Any notes that might help debug. | ||||||||||||||||||
|
|
||||||||||||||||||
|
|
||||||||||||||||||
|
|
||||||||||||||||||
|
|
||||||||||||||||||
|
|
||||||||||||||||||
|
|
||||||||||||||||||
Oops, something went wrong.
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.
this is incorrect, should be a message to data.table devs, not the maintainer of another pkg.