You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: doc/contrib/release.rst
+20-2Lines changed: 20 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -21,17 +21,25 @@ Making a Release
21
21
3. Commit the change, create a PR on GitHub on release branch. Port the bumped version to default branch, optionally with the postfix ``SNAPSHOT``.
22
22
4. Create a tag on release branch, either on GitHub or locally.
23
23
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.
25
25
26
26
There are helper scripts for automating the process in ``xgboost/dev/``.
27
27
28
28
+ The pip package is maintained by `Hyunsu Cho <https://github.com/hcho3>`__ and `Jiaming Yuan <https://github.com/trivialfis>`__.
29
29
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>`__.
31
31
32
32
+ The Maven package is maintained by `Nan Zhu <https://github.com/CodingCat>`_ and `Hyunsu Cho <https://github.com/hcho3>`_.
33
33
34
34
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
+
35
43
R CRAN Package
36
44
--------------
37
45
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.
42
50
43
51
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.
44
52
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.
0 commit comments