[R-package] Add docs on building and using precompiled binaries for the R package

[jameslamb]

This PR comes out of this discussion: #3188 (comment).

We're really close to getting the R package to CRAN, but I'm not sure how long it will take to fix #3187 . To make life easier for users until the package gets to CRAN, starting with https://github.com/microsoft/LightGBM/releases/tag/v3.0.0rc1 I think we should start providing precompiled binaries for releases.

When #3283 is done, these binaries can be produced automatically and attached to the releases page. For now, I think it will be useful to document how to use them (for users) and how to build them (for maintainers and adventurous users).

[StrikerRUS]

Thanks! Very clear guide!

Just dots for the consistency and one comment about the name of Windows artifact.

[StrikerRUS]

During reading this comment #3187 (comment) I came to the thought that it might be useful to upload the source distribution to Releases page (automatically after resolving #3283 ) which will be then submitted to CRAN. WDYT @jameslamb ?

[jameslamb]

During reading this comment #3187 (comment) I came to the thought that it might be useful to upload the source distribution to Releases page (automatically after resolving #3283 ) which will be then submitted to CRAN. WDYT @jameslamb ?

yes definitely! I think that is a great idea and something we should be doing. I'll add it and a note in these docs.

And then we can add it automatically in future releases (#3283 )

[jameslamb]

I just added a source distribution (built with sh build-cran-package.sh) to the 3.0.0rc1 release page!

I also added it to the list of artifacts that should be produced by #3283

It can be installed like this from R.

remotes::install_url(
    "https://github.com/microsoft/LightGBM/releases/download/v3.0.0rc1/lightgbm-3.0.0-1-cran.tar.gz"
)

[jameslamb]

I just added notes on installing the CRAN package from the releases page, thanks for the nudge @StrikerRUS !

[StrikerRUS]

@jameslamb

I also added it to the list of artifacts that should be produced by #3283

Thanks a lot!

I think after we put LightGBM on CRAN, we will have to produce only that artifact with source files and upload it to CRAN. All other artifacts with binaries should be uploaded reversely: from CRAN to Releases page (if needed) to have identical versions in both places and avoid errors like one just reported about glibc (#3188 (comment)). Please correct me if I'm wrong in my thoughts about further release pipeline.

[jameslamb]

@jameslamb

I also added it to the list of artifacts that should be produced by #3283

Thanks a lot!

I think after we put LightGBM on CRAN, we will have to produce only that artifact with source files and upload it to CRAN. All other artifacts with binaries should be uploaded reversely: from CRAN to Releases page (if needed) to have identical versions in both places and avoid errors like one just reported about glibc (#3188 (comment)). Please correct me if I'm wrong in my thoughts about further release pipeline.

Yes I agree with this. By the way, CRAN does not provide binaries for Linux (only Mac and Windows), so I think ours should be considered experimental.

[StrikerRUS]

By the way, CRAN does not provide binaries for Linux (only Mac and Windows), so I think ours should be considered experimental.

Hmm, then we should build them with our Docker we use for artifacts at Azure Pipelines to ensure maximum compatibility. Or even better with CentOS image.
https://github.com/pypa/manylinux/blob/master/docker/Dockerfile-x86_64

[StrikerRUS]

Now all artifact names look consistent here and at release page.

[jameslamb]

thanks for keeping me consistent @StrikerRUS , sorry for all the errors.

[github-actions]

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.