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.

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

[R-package] DESCRIPTION changes to address CRAN feedback #3298

Merged
merged 13 commits into from
Aug 13, 2020

Conversation

jameslamb
Copy link
Collaborator

This addresses feedback from our first ever submission to CRAN!

#629 (comment)

  • The note about "possible misspellings" can be fixed by putting LightGBM in quotes. I remember we had to do this when we first submitted uptasticsearch
  • the error from "not installed on i386" is from setting Biarch: false in DESCRIPTION. I thought that flag could be a way to publish a package that doesn't support 32-bit, but I don't think that works. Let's remove that field and we'll get a better error on CRAN 32-bit checks.

This also proposes adding a cran-comments.md to track feedback from CRAN. Since the CRAN upload process involves back-and-forth with humans (not just automated checks), a lot of projects keep this type of file to hold a record of the things CRAN has asked them to do in the past. We do this in uptasticsearch.

@jameslamb jameslamb added the fix label Aug 11, 2020
@jameslamb jameslamb requested a review from guolinke August 11, 2020 03:17
@jameslamb jameslamb requested a review from Laurae2 as a code owner August 11, 2020 03:17
@jameslamb
Copy link
Collaborator Author

@guolinke Could we submit to CRAN again? I want to be sure that this PR fixes the "misspelling" issue and gets us a different failure on Windows.

I just built a package that could be submitted, from this branch:

lightgbm_3.0.0-1.tar.gz

@jameslamb
Copy link
Collaborator Author

trying to fix this issue

* checking top-level files ... � NOTE
Non-standard file/directory found at top level:
  ‘cran-comments.md’

The regex for .Rbuildignore is really confusing.

@jameslamb jameslamb requested a review from StrikerRUS as a code owner August 11, 2020 04:32
Copy link
Collaborator

@StrikerRUS StrikerRUS left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for trying so hard!

LGTM, but please check my inline comment: #3298 (comment).

R-package/cran-comments.md Outdated Show resolved Hide resolved
@jameslamb
Copy link
Collaborator Author

thanks @guolinke ! Ok I just added notes to cran-comments.md explaining my guesses for what went wrong. It seems quoting 'LightGBM' did eliminate the NOTE about misspellings, but the package is still not being installed on i386 architecture.

I just pushed another set of changes. At your earliest convenience, could you try another submission with this tarball?

lightgbm_3.0.0-1.tar.gz

@jameslamb
Copy link
Collaborator Author

Thanks @guolinke . Ok this is good, I think this PR can be merged once CI finishes building. The 1 NOTE on both platforms can be safely ignored...it's just something that CRAN shows when you submit a package that isn't on CRAN yet.

The ERROR on Windows would be fixed by #3187 . Now we have absolute, definitive evidence that #3187 is required...before this, I was pretty sure but not certain.

Whenever you or @shiyu1994 pick that up, let me know if there's anything I can do to help. I can definitely create a CI job for 32-bit R based on #3187 (comment), and could help with any other setup.

R-package/cran-comments.md Outdated Show resolved Hide resolved
@jameslamb jameslamb deleted the r/cran-notes branch October 11, 2020 04:37
@github-actions
Copy link

This pull request has been automatically locked since there has not been any recent activity since it was closed. To start a new related discussion, open a new issue at https://github.com/microsoft/LightGBM/issues including a reference to this.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Aug 24, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants