Skip to content

Commit 5fbab40

Browse files
authored
[doc] Update release note for R-universe. (#11369)
1 parent af2a0b6 commit 5fbab40

File tree

3 files changed

+32
-10
lines changed

3 files changed

+32
-10
lines changed

doc/R-package/index.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,9 @@ You have found the XGBoost R Package!
1717
Get Started
1818
***********
1919

20-
Since XGBoost 3.0.0, the latest R package is available on
21-
`https://dmlc.r-universe.dev/builds <R-universe>`__ while the one on CRAN is kept at an
22-
older version. We will work on helping the CRAN version to catch up in the future. In the
20+
Since XGBoost 3.0.0, the latest R package is available on `R-universe
21+
<https://dmlc.r-universe.dev/xgboost>`__ while the one on CRAN is kept at an older
22+
version. We will work on helping the CRAN version to catch up in the future. In the
2323
meantime, please use R-universe packages.
2424

2525
* Check out the :doc:`Installation Guide </install>` for instructions on how to install

doc/changes/v3.0.0.rst

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -292,11 +292,15 @@ R Package
292292
*********
293293

294294
We have been reworking the R package for a few releases now. In 3.0, we will start
295-
publishing a new R package on public repositories, likely R-universe, before moving toward
296-
a CRAN update. The new package features a much more ergonomic interface, which is also
297-
more idiomatic to R speakers. In addition, a range of new features are introduced to the
298-
package. To name a few, the new package includes categorical feature support,
299-
``QuantileDMatrix``, and an initial implementation of the external memory training.
295+
publishing a new R package on R-universe, before moving toward a CRAN update. The new
296+
package features a much more ergonomic interface, which is also more idiomatic to R
297+
speakers. In addition, a range of new features are introduced to the package. To name a
298+
few, the new package includes categorical feature support, ``QuantileDMatrix``, and an
299+
initial implementation of the external memory training. To test the new package:
300+
301+
.. code-block:: R
302+
303+
install.packages('xgboost', repos = c('https://dmlc.r-universe.dev', 'https://cloud.r-project.org'))
300304
301305
Also, we finally have an online documentation site for the R package featuring both
302306
vignettes and API references (:pr:`11166`, :pr:`11257`). A good starting point for the new interface

doc/contrib/release.rst

Lines changed: 20 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,17 +21,25 @@ Making a Release
2121
3. Commit the change, create a PR on GitHub on release branch. Port the bumped version to default branch, optionally with the postfix ``SNAPSHOT``.
2222
4. Create a tag on release branch, either on GitHub or locally.
2323
5. Make a release on GitHub tag page, which might be done with previous step if the tag is created on GitHub.
24-
6. Submit pip, CRAN, and Maven packages.
24+
6. Submit pip, R-universe, CRAN, and Maven packages.
2525

2626
There are helper scripts for automating the process in ``xgboost/dev/``.
2727

2828
+ The pip package is maintained by `Hyunsu Cho <https://github.com/hcho3>`__ and `Jiaming Yuan <https://github.com/trivialfis>`__.
2929

30-
+ The CRAN package is maintained by `Tong He <https://github.com/hetong007>`_ and `Jiaming Yuan <https://github.com/trivialfis>`__.
30+
+ The CRAN package and the R-universe packages are maintained by `Jiaming Yuan <https://github.com/trivialfis>`__.
3131

3232
+ The Maven package is maintained by `Nan Zhu <https://github.com/CodingCat>`_ and `Hyunsu Cho <https://github.com/hcho3>`_.
3333

3434

35+
R Universe Packages
36+
-------------------
37+
38+
Since XGBoost 3.0.0, we host the R package on `R-Universe
39+
<https://dmlc.r-universe.dev/xgboost>`__. To make a new release, change the
40+
``packages.json`` in `dmlc.r-universe.dev <https://github.com/dmlc/dmlc.r-universe.dev>`__
41+
with a new release branch.
42+
3543
R CRAN Package
3644
--------------
3745
Before submitting a release, one should test the package on `R-hub <https://builder.r-hub.io/>`__ and `win-builder <https://win-builder.r-project.org/>`__ first. Please note that the R-hub Windows instance doesn't have the exact same environment as the one hosted on win-builder.
@@ -42,7 +50,17 @@ According to the `CRAN policy <https://cran.r-project.org/web/packages/policies.
4250

4351
We need to check the number of CPUs used in examples. Export ``_R_CHECK_EXAMPLE_TIMING_CPU_TO_ELAPSED_THRESHOLD_=2.5`` before running ``R CMD check --as-cran`` `[1] <#references>`__ and make sure the machine you are using has enough CPU cores to reveal any potential policy violation.
4452

53+
Read The Docs
54+
-------------
55+
56+
We might need to manually activate the new release branch for `read the docs
57+
<https://xgboost.readthedocs.io/>`__ and set it as the default branch in the console `[2]
58+
<#references>`__. Please check the document build and make sure the correct branch is
59+
activated and selected after making a new release.
60+
4561
References
4662
----------
4763

4864
[1] https://stat.ethz.ch/pipermail/r-package-devel/2022q4/008610.html
65+
66+
[2] https://github.com/readthedocs/readthedocs.org/issues/12073

0 commit comments

Comments
 (0)