Skip to content

Commit 8af2249

Browse files
jp-darkmojaveazure
andauthored
Update HISTORY/NEWS and R version for 2.1.0 release (#4289)
* Update HISTORY/NEWS and R version for 2.1.0 release * Add fake release for current minor release if needed Allows deprecations to occur during release process * Get around lifecycle trying to be clever, because it's not * Change wording in comment --------- Co-authored-by: Paul Hoffman <paul.hoffman@tiledb.com>
1 parent d595cad commit 8af2249

File tree

4 files changed

+72
-15
lines changed

4 files changed

+72
-15
lines changed

apis/python/HISTORY.md

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,19 +10,27 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).
1010

1111
### Changed
1212

13-
- \[[#4284](https://github.com/single-cell-data/TileDB-SOMA/pull/4284)\] Update [TileDB core to 2.29.1](https://github.com/TileDB-Inc/TileDB/releases/tag/2.29.1).
14-
1513
### Deprecated
1614

17-
- \[[#4275](https://github.com/single-cell-data/TileDB-SOMA/pull/4275)\] Deprecate allowing a dimension in `shape` for a new `SOMASpaseNDArray` to be defaulted to `1` with `None` in the `create` method. In the future, the shape must be a sequence of positive integers.
18-
- \[[#4275](https://github.com/single-cell-data/TileDB-SOMA/pull/4275)\] Deprecate leaving `domain=None` when creating a `SOMADataFrame`, `SOMAPointCloudDataFrame`, or `SOMAGeometryDataFrame`. In the future, the domain must be fully specified on creation.
19-
2015
### Removed
2116

2217
### Fixed
2318

2419
### Security
2520

21+
## [Release 2.1.0]
22+
23+
This release adds warnings for new deprecations in the allowed values for `shape` and `domain` in `create` methods and updates the TileDB core version to 2.29.1.
24+
25+
### Changed
26+
27+
- \[[#4284](https://github.com/single-cell-data/TileDB-SOMA/pull/4284)\] Update [TileDB core to 2.29.1](https://github.com/TileDB-Inc/TileDB/releases/tag/2.29.1).
28+
29+
### Deprecated
30+
31+
- \[[#4275](https://github.com/single-cell-data/TileDB-SOMA/pull/4275)\] Deprecate allowing a dimension in `shape` for a new `SOMASpaseNDArray` to be defaulted to `1` with `None` in the `create` method. In the future, the shape must be a sequence of positive integers.
32+
- \[[#4275](https://github.com/single-cell-data/TileDB-SOMA/pull/4275)\] Deprecate leaving `domain=None` when creating a `SOMADataFrame`, `SOMAPointCloudDataFrame`, or `SOMAGeometryDataFrame`. In the future, the domain must be fully specified on creation.
33+
2634
## [Release 2.0.0]
2735

2836
This release is the first TileDB-SOMA release that follows our new versioning policy (see the [developer docs](../../dev_docs/POLICIES.md)). Highlights of this release include the addition of a "delete" feature, removal of deprecated function, an update to TileDB 2.28.1 and breaking changes to `ExperimentAxisQuery.to_anndata`.

apis/r/DESCRIPTION

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Description: Interface for working with 'TileDB'-based Stack of Matrices,
66
like those commonly used for single cell data analysis. It is documented at
77
<https://github.com/single-cell-data>; a formal specification available is at
88
<https://github.com/single-cell-data/SOMA/blob/main/abstract_specification.md>.
9-
Version: 2.0.99.5
9+
Version: 2.1.99
1010
Authors@R: c(
1111
person(given = "Paul", family = "Hoffman",
1212
role = c("cre", "aut"), email = "tiledb-r@tiledb.com",

apis/r/NEWS.md

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,22 @@
22

33
## Added
44

5+
## Changed
6+
7+
## Deprecated
8+
9+
## Removed
10+
11+
## Fixed
12+
13+
## Security
14+
15+
# tiledbsoma 2.1.0
16+
17+
This release adds support for ingestion of BPCells-backed `Seurat` objects in `write_soma()`, adds warnings for new deprecations, and updates the TileDB core version to 2.29.1.
18+
19+
## Added
20+
521
- Add support for ingestion of BPCells-backed `Seurat` objects in `write_soma()` ([#4273](https://github.com/single-cell-data/TileDB-SOMA/pull/4273))
622

723
## Changed
@@ -13,12 +29,6 @@
1329
- Mark `SOMANDArrayBase$set_data_type()` for deprecation. ([#4279](https://github.com/single-cell-data/TileDB-SOMA/pull/4279))
1430
- Mark setting `domain` to `NULL` in `SOMADataFrame$create()` for deprecation. ([#4274](https://github.com/single-cell-data/TileDB-SOMA/pull/4274))
1531

16-
## Removed
17-
18-
## Fixed
19-
20-
## Security
21-
2232
# tiledbsoma 2.0.0
2333

2434
This release is the first TileDB-SOMA release that follows our new versioning policy (see the [developer docs](../../dev_docs/POLICIES.md)). It introduces the new `DELETE` mode and deprecates removing elements from a `Collection` in `WRITE` mode. It also updates the core TileDB version to 2.28.1.

apis/r/R/utils-deprecations.R

Lines changed: 42 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,11 @@
66
#' @inherit .deprecation_stage details
77
#'
88
#' @inheritParams lifecycle::deprecate_warn
9-
#' @inheritDotParams lifecycle::deprecate_warn id always
10-
#' @param env,user_env Needed for \code{\link[lifecycle:deprecate_warn]{lifecycle::deprecate_*}()}, do not modify
9+
#' @param ... Must be empty, and error will be thrown if anything is passed
10+
#' through the \dots
11+
#' @param env,user_env Needed for \
12+
#' code{\link[lifecycle:deprecate_warn]{lifecycle::deprecate_*}()},
13+
#' do not modify
1114
#'
1215
#' @return No return value, used for the side effects of signaling a
1316
#' deprecation or defunct stage
@@ -39,13 +42,16 @@
3942
with = NULL,
4043
...,
4144
details = NULL,
45+
id = NULL,
46+
always = TRUE,
4247
env = rlang::caller_env(),
4348
user_env = rlang::caller_env(n = 2L)
4449
) {
4550
stopifnot(
4651
rlang::is_character(what, n = 1L),
4752
is.null(x = with) || rlang::is_character(with)
4853
)
54+
rlang::check_dots_empty0(...)
4955
switch(
5056
EXPR = .deprecation_stage(when = when) %||% "future",
5157
defunct = lifecycle::deprecate_stop(
@@ -60,7 +66,12 @@
6066
what = what,
6167
with = with,
6268
details = details,
63-
...,
69+
# lifecycle tries to be clever when determining when to warn; however,
70+
# it's actually pretty bad at it. It doesn't work well with R6 nor does
71+
# it accurately track testthat usage. We need to force it
72+
# to throw a deprecation warning
73+
id = id %||% as.character(Sys.time()),
74+
always = always,
6475
env = env,
6576
user_env = user_env
6677
)
@@ -130,6 +141,34 @@
130141
lib.loc = .pkgenv$libname,
131142
mustWork = TRUE
132143
)))
144+
# Add fake release for current minor release if needed
145+
mm <- unique(vapply(
146+
X = releases$Version,
147+
FUN = function(x) {
148+
x <- unlist(strsplit(x = x, split = "\\."))
149+
return(paste0(x[1:2], collapse = "."))
150+
},
151+
FUN.VALUE = character(length = 1L),
152+
USE.NAMES = FALSE
153+
))
154+
cmm <- unlist(strsplit(
155+
x = as.character(utils::packageVersion(.pkgenv$pkgname)),
156+
split = "\\."
157+
))
158+
if (all(paste0(cmm[1:2], collapse = ".") > mm)) {
159+
dates <- file.info(list.files(
160+
base::system.file(package = .pkgenv$pkgname),
161+
full.names = TRUE,
162+
recursive = TRUE
163+
))$mtime
164+
releases <- rbind(
165+
releases,
166+
data.frame(
167+
Version = sprintf(fmt = "%s.%s.0", cmm[1L], cmm[2L]),
168+
Date = format(as.POSIXlt(dates[which.max(dates)]), format = "%Y-%m-%d")
169+
)
170+
)
171+
}
133172
# Check to see if the deprecation is scheduled for a future release
134173
# If so, exit out
135174
if (all(when > releases$Version)) {

0 commit comments

Comments
 (0)