-
Notifications
You must be signed in to change notification settings - Fork 27
/
SOP_release.txt
194 lines (122 loc) · 6.41 KB
/
SOP_release.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
############################################################
# Standard operating procedures for `mboost' development #
############################################################
Structure of the repository (branches)
--------------------------------------
master branch: current version on CRAN
> add bug fixes only
devel branch: current development version
> add bug fixes and new functionality
other branches: next generation development version / experimental stuff
> add experimental material or start new generation package
Making a patch release
----------------------
Change to master branch:
git checkout master
A bug was fixed in "master"
Increase patch level in DESCRIPTION
Update Date: field in DESCRIPTION
Update inst/NEWS.Rd (see also "How to preview NEWS.Rd files")
Update Date and Version in /man/mboost_package.Rd
R CMD build --resave-data --compact-vignettes . && R CMD check --as-cran --run-donttest mboost_XXX.tar.gz
If differences to .Rout.save occure:
- Copy new .Rout files to .Rout.save [1,2]:
Rscript copy_Rout_to_Routsave.R "vignettes=FALSE"
- Update vignette .Rout.save files if necessary [1,2]:
Rscript copy_Rout_to_Routsave.R "vignettes=TRUE"
- Now check for differences, e.g. using "git diff" or "meld"
[1] For details see
http://r.789695.n4.nabble.com/Generate-Rout-save-files-for-vignettes-td4652752.html
[2] NOTE: Reference output should be produced without having the --timings option set.
Run check with R-devel
(see section "Checking the package with latest development version of R")
Run checks on WinBuilder (temporarily change maintainer's email address!):
upload package to http://win-builder.r-project.org/
Gives no warnings / errors.
Commit changes to "master"
Now build package without test folder to be submitted to CRAN
R CMD buildCRAN --resave-data --compact-vignettes . && R CMD check --as-cran --run-donttest mboost_XXX.tar.gz
To use the script copy it to R RHOME (< enter this in the console) /bin and make it executable.
Alternatively do the following:
mv .RbuildignoreCRAN .Rbuildignore
cd ..
R CMD build --resave-data --compact-vignettes mboost && R CMD check --as-cran --run-donttest mboost_XXX.tar.gz
git checkout -- .RbuildignoreCRAN .Rbuildignore
Check that reverse dependencies don't break.
Use web form at http://xmpalantir.wu.ac.at/cransubmit/.
Merge changes to R code or documentation to "devel"
Make sure not to modify version numbers etc. in "devel" and
to add recents NEWS to inst/NEWS.Rd in "devel"
Update webpage. See www_src.
Making a minor release
----------------------
Change to development branch:
git checkout devel
Several new tools have been added to "devel".
Increase minor level in DESCRIPTION (patch level 0)
Update Date: field in DESCRIPTION
Update inst/NEWS.Rd (see also "How to preview NEWS.Rd files")
Update Date and Version in /man/mboost_package.Rd
Add a new section "NEWS in X.Y-series" to /man/mboost_package.Rd
and explain the most important changes there.
R CMD build --resave-data --compact-vignettes . && R CMD check --as-cran --run-donttest mboost_XXX.tar.gz
If differences to .Rout.save occure:
- Copy new .Rout files to .Rout.save [3,4]:
Rscript copy_Rout_to_Routsave.R "vignettes=FALSE"
- Update vignette .Rout.save files if necessary [3,4]:
Rscript copy_Rout_to_Routsave.R "vignettes=TRUE"
- Now check for differences, e.g. using "git diff" or "meld"
[3] For details see
http://r.789695.n4.nabble.com/Generate-Rout-save-files-for-vignettes-td4652752.html
[4] NOTE: Reference output should be produced without having the --timings option set.
Run check with R-devel
(see section "Checking the package with latest development version of R")
Run checks on WinBuilder (temporarily change maintainer's email address!):
upload package to http://win-builder.r-project.org/
Gives no warnings / errors.
Commit changes to "devel"
Now build package without test folder to be submitted to CRAN
R CMD buildCRAN --resave-data --compact-vignettes . && R CMD check --as-cran --run-donttest mboost_XXX.tar.gz
To use the script copy it to R RHOME (< enter this in the console) /bin and make it executable.
Alternatively do the following:
mv .RbuildignoreCRAN .Rbuildignore
R CMD build --resave-data --compact-vignettes . && R CMD check --as-cran --run-donttest mboost_XXX.tar.gz
git checkout -- .RbuildignoreCRAN .Rbuildignore
Check that reverse dependencies don't break.
Use web form at http://xmpalantir.wu.ac.at/cransubmit/.
Merge changes to "master"
After a minor release, "devel" and "master" are identical
(with the exeption of the package names -- mboost vs. mboostDevel).
Update webpage. See www_src.
Starting a new experimental version
-----------------------------------
git checkout master
git checkout -b <NEW_BRANCH_NAME>
Checking the package with latest development verstion of R
----------------------------------------------------------
Get source from
ftp://ftp.stat.math.ethz.ch/Software/R/
UnTar and install according to guide in INSTALL (source directory).
Go to mboost directory and call
../relative/path/to/R-devel/bin/R
Run
source("https://bioconductor.org/biocLite.R")
biocLite("biomaRt", suppressUpdates = FALSE)
biocLite("KEGGgraph", suppressUpdates = FALSE)
install.packages(c("partykit", "TH.data", "fields", "BayesX", "gbm",
"mlbench", "RColorBrewer", "randomForest", "nnet",
"nnls", "quadprog", "stabs", "testthat", "kangar00"))
Quit R and run
../relative/path/to/R-devel/bin/R CMD check --as-cran --run-donttest mboost_XXX.tar.gz
How to preview NEWS.Rd files
----------------------------
For HTML preview:
R CMD Rdconv -t 'html' -o 'NEWS.html' NEWS.Rd && firefox NEWS.html
and for PDF preview:
R CMD Rd2pdf NEWS.Rd
Checking reverse dependencies
-----------------------------
Use either
source("checks.R")
or ecexute in the correct subfolder
devtools::revdep_check(pkg="mboost")