diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2770b18..018593e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -169,11 +169,7 @@ This file details the new features, changes, and bug fixes that occurred since t Add a section for this release to `cran-comments.md`. This file holds details of our submission comments to CRAN and their responses to our submissions. -Change the `Version:` field in `DESCRIPTION` to the official version you want on CRAN (should not have a trailing `.9000`). - -This project uses GitHub Pages to host a documentation site: - -https://uptake.github.io/uptasticsearch/ +Change the `Version:` field in `DESCRIPTION` to the official version you want on CRAN (should not have a trailing `.9999`). **Submit to CRAN** diff --git a/NEWS.md b/NEWS.md index 5ebde44..6ee25c4 100644 --- a/NEWS.md +++ b/NEWS.md @@ -1,9 +1,65 @@ -# uptasticsearch development version +# uptasticsearch 1.0.0 + +## Breaking Changes + +### Removed support for Elasticsearch 1.0.3 + +- [#224](https://github.com/uptake/uptasticsearch/pull/224) The oldest support version is now 1.7.6. ## Features -### Changed R package to use retry logic for HTTP requests -- Changed all code in the R package to retry failed HTTP requests. This should make `uptasticsearch` more resilient to transient network issues. +### Added support for Elasticsearch 7 and 8 + +- [#204](https://github.com/uptake/uptasticsearch/pull/204), [#209](https://github.com/uptake/uptasticsearch/pull/209), [#213](https://github.com/uptake/uptasticsearch/pull/213), [#220](https://github.com/uptake/uptasticsearch/pull/220), [#245](https://github.com/uptake/uptasticsearch/pull/245) Added support for Elasticsearch 7.3.2 through 8.17.2. Later versions will hopefully still work, "support" here just means "validation via testing". + +### Added retry logic for all HTTP requests + +- [#172](https://github.com/uptake/uptasticsearch/pull/172) Changed all code in the R package to retry failed HTTP requests. This should make `{uptasticsearch}` more resilient to transient network issues. + +### Reduced set of required dependencies + +- [#249](https://github.com/uptake/uptasticsearch/pull/249) Dropped `{httr}` from `Imports` dependencies, replaced it with `{curl}`. Note that `{curl}` was already a hard runtime dependency of `{httr}`, so this is a net reduction in the set of dependencies required to install `{uptasticsearch}`. +- [#243](https://github.com/uptake/uptasticsearch/pull/243) Dropped `{assertthat}` from `Imports` dependencies. +- [#240](https://github.com/uptake/uptasticsearch/pull/240) Dropped `{uuid}` from `Imports` dependencies. +- [#236](https://github.com/uptake/uptasticsearch/pull/236) Switched vignettes from `{rmarkdown}` to `{markdown}`. +- [#235](https://github.com/uptake/uptasticsearch/pull/235) Removed `{covr}` from `Suggests` dependencies. +- [#211](https://github.com/uptake/uptasticsearch/pull/211) Removed `{devtools}` from development workflows, in favor of the underlying libraries its entrypoints called. `{devtools}` was not listed as a dependency in `DESCRIPTION`, so this only affects building from sources pulled from version control. + +### Added compatibility with `{testthat}` 3.x + +- [#237](https://github.com/uptake/uptasticsearch/pull/237) Removed uses of `testthat::with_mock()`, to avoid compatibility issues with R 4.5.0 and beyond. +- [#232](https://github.com/uptake/uptasticsearch/pull/232) Removed uses of `testthat::context()`, switched to `testthat::SummaryReporter`, some other cleanup. + +### Refreshed docs website + +- [#244](https://github.com/uptake/uptasticsearch/pull/244), [#246](https://github.com/uptake/uptasticsearch/pull/246) Rebuilt the docs site with the latest version of `{pkgdown}`, `{roxygen2}`, and everything they pull in. + + +### Added a `conda-forge` package + +- [#210](https://github.com/uptake/uptasticsearch/pull/210) It's now possible to install the package with `conda`. See https://github.com/conda-forge/r-uptasticsearch-feedstock for packaging details. + +```shell +conda install -c conda-forge r-uptasticsearch +``` + +## Bugfixes + +### Fixed some small `R CMD check` issues. + +- [#252](https://github.com/uptake/uptasticsearch/pull/252) Fixed NOTEs about URLs that redirect to other locations. +- [#219](https://github.com/uptake/uptasticsearch/pull/219) Fixed this: + +```text +Version: 0.4.0 +Check: LazyData +Result: NOTE + 'LazyData' is specified without a 'data' directory +``` + +### Fixed validation of `es_indices` in `get_fields()` + +- [#243](https://github.com/uptake/uptasticsearch/pull/243) The type of argument `es_indices` to `get_fields()` was previously not checked, which could lead to confusing errors. `{uptasticsearch}` now correctly checks it and raises an informative error if it is not a non-empty string. # uptasticsearch 0.4.0 diff --git a/cran-comments.md b/cran-comments.md index d6798ec..f1c0de1 100644 --- a/cran-comments.md +++ b/cran-comments.md @@ -131,3 +131,18 @@ In this submission, we changed maintainer from `james.lamb@uptake.com` to `jayla ### CRAN Response * No issues. v0.4.0 released to CRAN! + +## v1.0.0 - Submission 1 - (February 24, 2025) + +Submitted with the following comments. + +> This is the first release of 'uptasticsearch' since 2019. +> It mainly seeks to preserve the package on CRAN by removing use of deprecated-and-soon-to-be-removed functionality in 'testthat' (https://github.com/uptake/uptasticsearch/issues/223). + +### `R CMD check` results + +* No issues + +### CRAN Response + +* No issues. v1.0.0 released to CRAN! diff --git a/r-pkg/DESCRIPTION b/r-pkg/DESCRIPTION index e945ae6..079642d 100644 --- a/r-pkg/DESCRIPTION +++ b/r-pkg/DESCRIPTION @@ -1,7 +1,7 @@ Package: uptasticsearch Type: Package Title: Get Data Frame Representations of 'Elasticsearch' Results -Version: 0.4.0.9999 +Version: 1.0.0 Authors@R: c( person("James", "Lamb", email = "jaylamb20@gmail.com", role = c("aut", "cre")), person("Nick", "Paras", role = c("aut")), diff --git a/setup_local.sh b/setup_local.sh index 44d0f68..7547e2e 100755 --- a/setup_local.sh +++ b/setup_local.sh @@ -17,10 +17,6 @@ echo "Starting up Elasticsearch..." case "${ES_VERSION}" in -1.0.3) - docker run --rm -d -p "${ES_PORT}:9200" barnybug/elasticsearch:1.0.3 - MAPPING_FILE=$(pwd)/test-data/legacy_shakespeare_mapping.json - ;; 1.7.6) docker run --rm -d -p "${ES_PORT}:9200" elasticsearch:1.7.6 MAPPING_FILE=$(pwd)/test-data/legacy_shakespeare_mapping.json