DataONEorg / rdataone

R package for reading and writing data at DataONE data repositories
http://doi.org/10.5063/F1M61H5X
36 stars 19 forks source link

Next release version number considerations #265

Closed gothub closed 3 years ago

gothub commented 3 years ago

@mbjones @amoeba currently the next release is slated to use version 2.2.0, updated from the current CRAN version of 2.1.4. This issue raised the question of whether the version needs to be updated to 3.0.0, as explained below:

According to semantic versioning (https://semver.org/):

This next release will use a new parameter that is now available in datapack::DataObject(), for example, in D1Client:

    do <- new("DataObject", id=sysmeta, dataobj=bytes, dataURL=dataURL, checksumAlgorithm=checksumAlgorithm)

where checksumAlgorithm is the new parameter in datapack 1.4.0.

The function datapack::DataObject sets a default for checksumAlgorithm, so current dataone scripts that don't specify this parameter will work.

It appears then, that this is not an 'incompatible API change' so the version of 2.2.0 is appropriate. Is this correct?

On a side note, I was planning on requiring datapack 1.4.0 in DESCRIPTION.

mbjones commented 3 years ago

Yes, I think your analysis is spot on. 2.2.0 seems fine given that functionality was extended but not in a way that breaks existing uses.

amoeba commented 3 years ago

Sounds great, thanks @gothub.

gothub commented 3 years ago

Version number updated to '2.2.0' in commit c098e809f0ccc13e852aafcbe70beca0eb8583a5