Skip to content

Commit b0c5ff3

Browse files
committed
Merge branch 'master' into dt-matrix-names
2 parents d2deeeb + e25ea80 commit b0c5ff3

File tree

304 files changed

+74467
-17215
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

304 files changed

+74467
-17215
lines changed

.Rbuildignore

Lines changed: 25 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,35 @@
1+
.dir-locals.el
2+
.check.translations.R
13
^\.Rprofile$
24
^data\.table_.*\.tar\.gz$
5+
^config\.log$
36
^vignettes/plots/figures$
7+
^\.Renviron$
8+
^[^/]+\.R$
9+
^[^/]+\.csv$
10+
^[^/]+\.csvy$
11+
^[^/]+\.RDS$
12+
^[^/]+\.diff$
13+
^[^/]+\.patch$
414

515
^\.ci$
616
^\.dev$
17+
^\.devcontainer$
718
^\.graphics$
819
^\.github$
20+
^\.vscode$
21+
^\.zed$
922

10-
^\.travis\.yml$
11-
^\.appveyor\.yml$
1223
^\.gitlab-ci\.yml$
1324

1425
^Makefile$
1526
^NEWS\.0\.md$
16-
^README\.md$
27+
^NEWS\.1\.md$
1728
^_pkgdown\.yml$
1829
^src/Makevars$
30+
^CODEOWNERS$
31+
^GOVERNANCE\.md$
32+
^Seal_of_Approval\.md$
1933

2034
^\.RData$
2135
^\.Rhistory$
@@ -25,8 +39,16 @@
2539
^.*\.Rproj$
2640
^\.Rproj\.user$
2741
^\.idea$
42+
^\.libs$
2843

2944
^.*\.dll$
3045

3146
^bus$
3247
^pkgdown$
48+
^docs$
49+
^lib$
50+
^library$
51+
^devwd$
52+
53+
# only the inst/po compressed files are needed, not raw .pot/.po
54+
^po$

.Rprofile

Lines changed: 0 additions & 2 deletions
This file was deleted.

.appveyor.yml

Lines changed: 0 additions & 74 deletions
This file was deleted.

.ci/.lintr.R

Lines changed: 109 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,109 @@
1+
dt_linters = new.env()
2+
for (f in list.files('.ci/linters/r', full.names=TRUE)) sys.source(f, dt_linters)
3+
rm(f)
4+
5+
# NB: Could do this inside the linter definition, this separation makes those files more standardized
6+
dt_linters <- eapply(dt_linters, function(linter_factory) linter_factory())
7+
8+
linters = c(dt_linters, all_linters(
9+
packages = "lintr", # TODO(lintr->3.2.0): Remove this.
10+
# eq_assignment_linter(),
11+
brace_linter(allow_single_line = TRUE),
12+
implicit_integer_linter(allow_colon = TRUE),
13+
# TODO(michaelchirico): Activate these incrementally. These are the
14+
# parameterizations that match our style guide.
15+
# implicit_assignment_linter(allow_lazy = TRUE, allow_scoped = TRUE),
16+
# system_time_linter = undesirable_function_linter(c(
17+
# system.time = "Only run timings in benchmark.Rraw"
18+
# )),
19+
# undesirable_function_linter(modify_defaults(
20+
# default_undesirable_functions,
21+
# ifelse = "Use fifelse instead.",
22+
# Sys.setenv = NULL,
23+
# library = NULL,
24+
# options = NULL,
25+
# par = NULL,
26+
# setwd = NULL
27+
# )),
28+
undesirable_operator_linter(),
29+
# TODO(lintr#2765): Use upstream implementation.
30+
# assignment_linter(operator = "="),
31+
assignment_linter = NULL,
32+
absolute_path_linter = NULL, # too many false positives
33+
# TODO(lintr#2442): Use this once x[ , j, by] is supported.
34+
commas_linter = NULL,
35+
commented_code_linter = NULL,
36+
# TODO(linter->3.2.0): Activate this.
37+
consecutive_assertion_linter = NULL,
38+
cyclocomp_linter = NULL,
39+
function_argument_linter = NULL,
40+
indentation_linter = NULL,
41+
infix_spaces_linter = NULL,
42+
line_length_linter = NULL,
43+
missing_package_linter = NULL,
44+
namespace_linter = NULL,
45+
nonportable_path_linter = NULL,
46+
object_name_linter = NULL,
47+
object_usage_linter = NULL,
48+
quotes_linter = NULL,
49+
semicolon_linter = NULL,
50+
spaces_inside_linter = NULL,
51+
spaces_left_parentheses_linter = NULL,
52+
# TODO(michaelchirico): Only exclude from vignettes, not sure what's wrong.
53+
strings_as_factors_linter = NULL,
54+
# TODO(lintr->3.2.0): Fix on a valid TODO style, enforce it, and re-activate.
55+
todo_comment_linter = NULL,
56+
# TODO(michaelchirico): Enforce these and re-activate them one-by-one.
57+
brace_linter = NULL,
58+
fixed_regex_linter = NULL,
59+
if_not_else_linter = NULL,
60+
implicit_assignment_linter = NULL,
61+
implicit_integer_linter = NULL,
62+
keyword_quote_linter = NULL,
63+
object_overwrite_linter = NULL,
64+
paren_body_linter = NULL,
65+
redundant_equals_linter = NULL,
66+
undesirable_function_linter = NULL,
67+
unnecessary_concatenation_linter = NULL,
68+
unnecessary_nesting_linter = NULL,
69+
unreachable_code_linter = NULL,
70+
unused_import_linter = NULL
71+
))
72+
rm(dt_linters)
73+
74+
exclusions = list(
75+
`../tests` = list(
76+
quotes_linter = Inf,
77+
# TODO(michaelchirico): Enforce these and re-activate them one-by-one.
78+
implicit_integer_linter = Inf,
79+
infix_spaces_linter = Inf,
80+
undesirable_function_linter = Inf
81+
),
82+
`../vignettes*` = list(
83+
# assignment_linter = Inf,
84+
implicit_integer_linter = Inf,
85+
quotes_linter = Inf,
86+
sample_int_linter = Inf
87+
# strings_as_factors_linter = Inf
88+
# system_time_linter = Inf
89+
),
90+
`../inst/tests` = list(
91+
library_call_linter = Inf,
92+
numeric_leading_zero_linter = Inf,
93+
undesirable_operator_linter = Inf, # For ':::', possibly we could be more careful to only exclude ':::'.
94+
# TODO(michaelchirico): Enforce these and re-activate them one-by-one.
95+
comparison_negation_linter = Inf,
96+
condition_call_linter = Inf,
97+
duplicate_argument_linter = Inf,
98+
equals_na_linter = Inf,
99+
missing_argument_linter = Inf,
100+
paste_linter = Inf,
101+
rep_len_linter = Inf,
102+
sample_int_linter = Inf,
103+
seq_linter = Inf,
104+
unnecessary_lambda_linter = Inf
105+
),
106+
`../inst/tests/froll.Rraw` = list(
107+
dt_test_literal_linter = Inf # TODO(michaelchirico): Fix these once #5898, #5692, #5682, #5576, #5575, #5441 are merged.
108+
)
109+
)

.ci/Dockerfile.in

Lines changed: 0 additions & 9 deletions
This file was deleted.

.ci/README.md

Lines changed: 40 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -1,71 +1,69 @@
11
# data.table continuous integration and deployment
22

3-
On each Pull Request opened in GitHub we run Travis CI and Appveyor to provide prompt feedback about the status of PR. Our main CI pipeline runs on GitLab CI. GitLab repository automatically mirrors our GitHub repository and runs pipeline on `master` branch. It tests more environments and different configurations. It publish variety of artifacts. Windows jobs are being run on our private windows CI runner.
3+
On each Pull Request opened in GitHub we run GitHub Actions test jobs to provide prompt feedback about the status of PR. Our more thorough main CI pipeline runs nightly on GitLab CI. GitLab repository automatically mirrors our GitHub repository and runs pipeline on `master` branch every night. It tests more environments and different configurations. It publishes a variety of artifacts such as our [homepage](https://rdatatable.gitlab.io/data.table/) and [CRAN-like website for dev version](https://rdatatable.gitlab.io/data.table/web/packages/data.table/index.html), including windows binaries for the dev version.
44

55
## Environments
66

77
### [GitLab CI](./../.gitlab-ci.yml)
88

99
Test jobs:
10-
- `test-rel-lin` - `r-release` on Linux, most comprehensive test environment, `-O3 -flto -fno-common -Wunused-result`, extra check for no compilation warnings, includes testing [_with other packages_](./../inst/tests/other.Rraw) ([extended suggests](./../inst/tests/tests-DESCRIPTION))
11-
- `test-rel-cran-lin` - `--as-cran` on Linux, `-g0`, extra check for final status of `R CMD check` where we allow one NOTE (_size of tarball_).
12-
- `test-dev-cran-lin` - `r-devel` and `--as-cran` on Linux, `--enable-strict-barrier --disable-long-double`
13-
- `test-rel-vanilla-lin` - `r-release` on Linux, no suggested deps, no OpenMP, `-O0`, tracks memory usage during tests
14-
- `test-310-cran-lin` - R 3.1.0 on Linux
15-
- `test-344-cran-lin` - R 3.4.4 on Linux
16-
- `test-350-cran-lin` - R 3.5.0 on Linux, no `r-recommended`
17-
- `test-rel-win` - `r-release` on Windows
18-
- `test-dev-win` - `r-devel` on Windows
19-
- `test-rel-osx` - MacOSX build not yet deployed, see [#3326](https://github.com/Rdatatable/data.table/issues/3326) for status
10+
- `test-lin-rel` - `r-release` on Linux, most comprehensive test environment, force all suggests, `-O3 -flto=auto -fno-common -Wunused-result`, test for no compilation warnings.
11+
- `test-lin-rel-vanilla` - `r-release` on Linux, no suggested deps, no zlib, no OpenMP, flags `-g -O0 -fno-openmp`, skip manual and vignettes.
12+
- `test-lin-rel-cran` - `--as-cran` on Linux, strict test for final status of `R CMD check`.
13+
- `test-lin-dev-gcc-strict-cran` - `--as-cran` on Linux, `r-devel` built with `-enable-strict-barrier --disable-long-double`, test for compilation warnings, test for new NOTEs/WARNINGs from `R CMD check`.
14+
- `test-lin-dev-clang-cran` - same as `gcc-strict` job but R built with `clang` and no `--enable-strict-barrier --disable-long-double` flags.
15+
- `test-lin-ancient-cran` - Stated R dependency version (currently 3.3.0) on Linux.
16+
- `test-lin-dev-san` - `r-devel` on Linux built with `clang -fsanitize=address,undefined` (including LeakSanitizer), test for sanitizer output in tests and examples.
17+
- `test-win-rel` - `r-release` on Windows.
18+
- `test-win-dev` - `r-devel` on Windows.
19+
- `test-win-old` - `r-oldrel` on Windows.
20+
- `test-mac-rel` - `r-release` on macOS.
21+
- `test-mac-old` - `r-oldrel` on macOS.
22+
23+
The CI steps for the tests are [required](https://github.com/Rdatatable/data.table/blob/55eb0f160b169398d51f138131c14a66c86e5dc9/.ci/publish.R#L162-L168) to be named according to the pattern `test-(lin|win|mac)-<R version>[-<suffix>]*`, where `<R version>` is `rel`, `dev`, `old`, `ancient`, or three digits comprising an R version (e.g. `362` corresponding to R-3.6.2).
24+
25+
Tests jobs are allowed to fail, summary and logs of test jobs are later published at _CRAN-like checks_ page, see artifacts below.
2026

2127
Artifacts:
2228
- [homepage](https://rdatatable.gitlab.io/data.table) - made with [pkgdown](https://github.com/r-lib/pkgdown)
2329
- [html manual](https://rdatatable.gitlab.io/data.table/library/data.table/html/00Index.html)
2430
- [pdf manual](https://rdatatable.gitlab.io/data.table/web/packages/data.table/data.table.pdf)
2531
- [html vignettes](https://rdatatable.gitlab.io/data.table/library/data.table/doc/index.html)
26-
- R packages repository for `data.table` and all _Suggests_ dependencies, url: `https://Rdatatable.gitlab.io/data.table`
32+
- R packages repository for `data.table` and all _Suggests_ dependencies, url: `https://rdatatable.gitlab.io/data.table`
2733
- sources
28-
- Windows binaries for `r-release` and `r-devel`
34+
- Windows binaries for `r-release`, `r-devel` and `r-oldrel`
2935
- [CRAN-like homepage](https://rdatatable.gitlab.io/data.table/web/packages/data.table/index.html)
30-
- [CRAN-like checks results](https://rdatatable.gitlab.io/data.table/web/checks/check_results_data.table.html) - note that all artifacts, including this page, are being published only when all test jobs successfully pass, thus one will not see an _ERROR_ status there (unless `allow_failure` option has been used in a job).
31-
- [docker images](https://gitlab.com/Rdatatable/data.table/container_registry) - copy/paste-able `docker pull` commands can be found at the bottom of our [CRAN-like homepage](https://rdatatable.gitlab.io/data.table/web/packages/data.table/index.html)
36+
- [CRAN-like checks results](https://rdatatable.gitlab.io/data.table/web/checks/check_results_data.table.html)
3237

33-
### [Travis CI](./../.travis.yml)
38+
### [GitHub Actions](./../.github/workflows)
3439

35-
Test jobs:
36-
- `r-release` on Linux, includes code coverage check
37-
- _(might be disabled)_ `r-release` on OSX
38-
39-
Artifacts:
40-
- R packages repository having `data.table` sources only, url: `https://Rdatatable.github.io/data.table`
41-
- code coverage stats pushed to [codecov.io/gh/Rdatatable/data.table](https://codecov.io/gh/Rdatatable/data.table)
42-
43-
### [Appveyor](./../.appveyor.yml)
44-
45-
Test jobs:
46-
- Windows `r-release`
47-
- _(might be disabled)_ Windows `r-devel`
48-
49-
Artifacts:
50-
- Windows `r-release` binaries accessed only via web UI
40+
TODO document
5141

52-
## Tools
42+
## CI tools
5343

5444
### [`ci.R`](./ci.R)
5545

56-
Base R implemented helper script, [originally proposed to R](https://svn.r-project.org/R/branches/tools4pkgs/src/library/tools/R/packages.R), that ease the process of extracting dependency information from description files, also to mirror packages and their recursive dependencies from CRAN to local CRAN-like directory. It is widely used in our [GitLab CI pipeline](./../.gitlab-ci.yml).
46+
Base R implemented helper script, [originally proposed to base R](https://svn.r-project.org/R/branches/tools4pkgs/src/library/tools/R/packages.R), that ease the process of extracting dependency information from description files, and to mirror packages and their recursive dependencies from CRAN to local CRAN-like directory. It is used in [GitLab CI pipeline](./../.gitlab-ci.yml).
5747

5848
### [`publish.R`](./publish.R)
5949

60-
Base R implemented helper script to orchestrate generation of most artifacts. It is being used only in [_integration_ stage in GitLab CI pipeline](./../.gitlab-ci.yml).
50+
Base R implemented helper script to orchestrate generation of most artifacts and to arrange them nicely. It is being used only in [_integration_ stage in GitLab CI pipeline](./../.gitlab-ci.yml).
51+
52+
## GitLab Open Source Program
53+
54+
We are currently part of the [GitLab for Open Source Program](https://about.gitlab.com/solutions/open-source/). This gives us 50,000 compute minutes per month for our GitLab CI. Our license needs to be renewed yearly (around July) and is currently managed by @ben-schwen.
6155

62-
### [`Dockerfile.in`](./Dockerfile.in)
56+
## Updating CI pipeline
6357

64-
Template file to produce `Dockerfile` for, as of now, three docker images. Docker images are being built and published in [_deploy_ stage in GitLab CI pipeline](./../.gitlab-ci.yml).
65-
- `r-base-dev` using `r-release`: publish docker image of `data.table` on R-release
66-
- `r-builder` using `r-release`: publish on R-release and OS dependencies for building Rmarkdown vignettes
67-
- `r-devel`: publish docker image of `data.table` on R-devel
58+
Basic CI checks are also run on every push to the GitLab repository. This can **and should** be used for PRs changing the CI pipeline before merging them to master.
6859

69-
### [`deploy.sh`](./deploy.sh)
60+
```shell
61+
# fetch changes from remote (GitHub) and push them to GitLab
62+
git fetch [email protected]:Rdatatable/data.table.git new_branch:new_branch
63+
git push
64+
# after updating on GitHub, pull changes from remote and push to GitLab
65+
git pull [email protected]:Rdatatable/data.table.git new_branch
66+
git push
67+
```
7068

71-
Script used on Travis CI to publish CRAN-like repository of `data.table` sources. It publishes to `gh-pages` branch in GitHub repository. It depends on a token, which is provided based on `secure` environment variable in [.travis.yml](./../.travis.yml). It has been generated by @jangorecki.
69+
Make sure to include a link to the pipeline results in your PR.

0 commit comments

Comments
 (0)