From cb9b28b3282c22d0d173894a8fb4d623cf0d1b31 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jo=C3=A3o=20Santiago?= Date: Tue, 12 Dec 2023 11:06:46 +0100 Subject: [PATCH 1/7] Update for CRAN release --- DESCRIPTION | 18 ++---- LICENSE | 2 +- NEWS.md | 4 ++ README.md | 3 +- cran-comments.md | 148 +---------------------------------------------- 5 files changed, 14 insertions(+), 161 deletions(-) diff --git a/DESCRIPTION b/DESCRIPTION index b50a28c..29a0610 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,12 +1,10 @@ Package: sentryR Type: Package Title: Send Errors and Messages to Sentry -Version: 1.1.1.9000 +Version: 1.1.2 Authors@R: c( - person("Joao", "Santiago", email = "santiago@billie.io", role = c("aut", "cre")), - person("Daniel", "Kirsch", role = "aut", email = "daniel@billie.io"), - # copyright holders - person("Billie", role = c("cph", "fnd"))) + person("Joao", "Santiago", email = "me@jcpsantiago.xyz", role = c("aut", "cre")), + person("Daniel", "Kirsch", role = "aut", email = "daniel@billie.io")) Description: Unofficial client for 'Sentry' , a self-hosted or cloud-based error-monitoring service. It will inform about errors in real-time, and includes integration with the 'Plumber' package. @@ -14,9 +12,9 @@ License: MIT + file LICENSE Encoding: UTF-8 LazyData: true ByteCompile: true -URL: https://github.com/ozean12/sentryR -BugReports: https://github.com/ozean12/sentryR/issues -RoxygenNote: 7.0.2 +URL: https://github.com/jcpsantiago/sentryR +BugReports: https://github.com/jcpsantiago/sentryR/issues +RoxygenNote: 7.2.3 Imports: httr, jsonlite, @@ -25,10 +23,6 @@ Imports: tibble, uuid Suggests: - bunny, - covr, httptest, mockery, testthat (>= 2.1.0) -Remotes: - github::dmi3kno/bunny diff --git a/LICENSE b/LICENSE index 92963c4..bdf8804 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ MIT License -Copyright (c) 2021 Billie GmbH +Copyright (c) 2023 João Santiago Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/NEWS.md b/NEWS.md index 131d4cd..88bb4ee 100644 --- a/NEWS.md +++ b/NEWS.md @@ -1,3 +1,7 @@ +# sentryR 1.1.2 + +* Restarting releases to CRAN. + # sentryR 1.0.0 * New functions `capture_*` to decouple the base functionality of Sentry diff --git a/README.md b/README.md index 40f93d8..ec97490 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,4 @@ -[![R-CMD-check](https://github.com/ozean12/sentryR/workflows/R-CMD-check/badge.svg)](https://github.com/ozean12/sentryR/actions) -[![Coverage status](https://codecov.io/gh/ozean12/sentryR/branch/master/graph/badge.svg)](https://codecov.io/github/ozean12/sentryR?branch=master) +[![R-CMD-check](https://github.com/ozean12/sentryR/workflows/R-CMD-check/badge.svg)](https://github.com/jcpsantiago/sentryR/actions) [![CRAN status](https://www.r-pkg.org/badges/version/sentryR)](https://CRAN.R-project.org/package=sentryR) [![Lifecycle: stable](https://img.shields.io/badge/lifecycle-stable-brightgreen.svg)](https://www.tidyverse.org/lifecycle/#stable) [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT) diff --git a/cran-comments.md b/cran-comments.md index d3e3b2a..a698648 100644 --- a/cran-comments.md +++ b/cran-comments.md @@ -1,149 +1,5 @@ -# Round 1 -## Test environments -- R-hub windows-x86_64-devel (r-devel) -- R-hub ubuntu-gcc-release (r-release) -- R-hub fedora-clang-devel (r-devel) - ## R CMD check results -> On windows-x86_64-devel (r-devel), ubuntu-gcc-release (r-release) - checking CRAN incoming feasibility ... NOTE - Maintainer: 'Joao Santiago ' - New submission - - - License components with restrictions and base license permitting such: - MIT + file LICENSE - - Copyright (c) 2020 Billie GmbH - - Permission is hereby granted, free of charge, to any person obtaining a copy - of this software and associated documentation files (the "Software"), to deal - in the Software without restriction, including without limitation the rights - to use, copy, modify, merge, publish, distribute, sublicense, and/or sell - copies of the Software, and to permit persons to whom the Software is - furnished to do so, subject to the following conditions: - - The above copyright notice and this permission notice shall be included in all - copies or substantial portions of the Software. - - THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR - IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, - FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE - AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER - LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, - OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE - SOFTWARE. - File 'LICENSE': - MIT License - -> On fedora-clang-devel (r-devel) - checking CRAN incoming feasibility ...NB: need Internet access to use CRAN incoming checks - NOTE - Maintainer: ‘Joao Santiago ’ - - License components with restrictions and base license permitting such: - MIT + file LICENSE - File 'LICENSE': - MIT License - - Copyright (c) 2019 Billie GmbH - - Permission is hereby granted, free of charge, to any person obtaining a copy - of this software and associated documentation files (the "Software"), to deal - in the Software without restriction, including without limitation the rights - to use, copy, modify, merge, publish, distribute, sublicense, and/or sell - copies of the Software, and to permit persons to whom the Software is - furnished to do so, subject to the following conditions: - - The above copyright notice and this permission notice shall be included in all - copies or substantial portions of the Software. - - THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR - IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, - FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE - AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER - LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, - OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE - SOFTWARE. - -0 errors ✓ | 0 warnings ✓ | 2 notes x - -* This is a new release. - -# Round 2 -## Reviewer comments - -2020-02-28 Jelena Saf - -``` -The Description field is intended to be a (one paragraph) description of what the package does and why it may be useful. Please elaborate. - -Please always write non-English usage, package names, software names and API names in single quotes in title and description. e.g: --> 'Sentry' - -Thanks, we see you are using installed.packages() in your code. -F.i.: core.R -As mentioned in the notes of installed.packages() help page, this can be very slow: - "This can be slow when thousands of packages are installed, so do not use this to find out if a named package is installed (use system.file or find.package) nor to find out if a package is usable (call require and check the return value) nor to find details of a small number of packages (use packageDescription). It needs to read several files per installed package, which will be slow on Windows and on some network-mounted file systems." [installed.packages() help page] - If possible please adapt your code accordingly. - -You have an example for an unexported function which cannot run in this way. -Please either add sentryR::: to the function call in the example, omit the example or export the function. -See: calls_to_stacktrace.R - -Please fix and resubmit, and document what was changed in the submission comments. -``` - -## Submission comments - -2020-02-29 - -Thank you Jelena for the comments and taking the time to review sentryR. - -I expanded the description and used '' where necessary. - -Regarding the use of installed.packages(): the sentry.io cloud service attaches -the runtime environment with each error report, which ideally includes a list -of packages and their versions. This is useful to debug problems. -The lack of this functionality is not necessary for sentryR to run, but it -reduces its usefuleness, and reduces the features available in comparison to -clients written in other languages such as python or javascript. - -As a final argument for the inclusion of this function, I would argue the -use-case for this package are Plumber APIs or long running jobs in interactive mode, -both of which don't usually have such a high number of packages. -I understand that is the case at CRAN though. - -If the reviewer doesn't agree with the inclusion of the installed.packages() -function, I would appreciate a suggestion for an alternative. -This is my first CRAN submission. - -## Re-submission - -Re-submitting because the Description field started with 'sentryR', -which is not allowed. - -# Round 3 -## Reviwer comments - -2020-03-06 Swetlana Herbrandt - -``` -Thanks, please write package names, software names and API names in single quotes (e.g. 'Sentry') in Title and Description. - -You are using installed.packages(): -"This needs to read several files per installed package, which will be slow on Windows and on some network-mounted file systems. -It will be slow when thousands of packages are installed, so do not use it to find out if a named package is installed (use find.package or system.file) nor to find out if a package is usable (call requireNamespace or require and check the return value) nor to find details of a small number of packages (use packageDescription)." -[installed.packages() help page] -``` - -## Submission comments - -2020-03-15 - -Thank you for the review, your comments are much appreciated it. -I have removed the usage of `installed.packages()` completely. -Instead, I instruct the user how to add that information at runtime if needed. +0 errors | 0 warnings | 1 note -I also changed every instance of a package name, API or other piece of software -to include single quotes. +* This is an update to a package previously released, but then removed due to an unreachable maintainer email. The copyright has moved to a new owner (the main developer), and the email updated accordingly. From cb7cacd26d0cbfd7eaea020515c1ac2dc541641d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jo=C3=A3o=20Santiago?= Date: Tue, 12 Dec 2023 11:07:36 +0100 Subject: [PATCH 2/7] add cran submission --- .Rbuildignore | 1 + CRAN-SUBMISSION | 3 +++ 2 files changed, 4 insertions(+) create mode 100644 CRAN-SUBMISSION diff --git a/.Rbuildignore b/.Rbuildignore index ecfa29a..e98fb37 100644 --- a/.Rbuildignore +++ b/.Rbuildignore @@ -9,3 +9,4 @@ docs pkgdown ^CRAN-RELEASE$ ^\.github$ +^CRAN-SUBMISSION$ diff --git a/CRAN-SUBMISSION b/CRAN-SUBMISSION new file mode 100644 index 0000000..56a2f07 --- /dev/null +++ b/CRAN-SUBMISSION @@ -0,0 +1,3 @@ +Version: 1.1.2 +Date: 2023-12-12 10:07:02 UTC +SHA: cb9b28b3282c22d0d173894a8fb4d623cf0d1b31 From 696504816526dc3e837931eede3b137b285cfa84 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jo=C3=A3o=20Santiago?= Date: Tue, 12 Dec 2023 11:27:24 +0100 Subject: [PATCH 3/7] Update README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index ec97490..b39694e 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ [![R-CMD-check](https://github.com/ozean12/sentryR/workflows/R-CMD-check/badge.svg)](https://github.com/jcpsantiago/sentryR/actions) [![CRAN status](https://www.r-pkg.org/badges/version/sentryR)](https://CRAN.R-project.org/package=sentryR) -[![Lifecycle: stable](https://img.shields.io/badge/lifecycle-stable-brightgreen.svg)](https://www.tidyverse.org/lifecycle/#stable) -[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT) +[![Lifecycle: stable](https://img.shields.io/badge/lifecycle-stable-brightgreen.svg)](https://lifecycle.r-lib.org/articles/stages.html#stable) +[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/license/mit/) # sentryR From b459e4881d09f0fb81f4f7f834ad0fcc14993742 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jo=C3=A3o=20Santiago?= Date: Tue, 12 Dec 2023 11:31:08 +0100 Subject: [PATCH 4/7] update License --- LICENSE | 23 ++--------------------- LICENSE.md | 21 +++++++++++++++++++++ 2 files changed, 23 insertions(+), 21 deletions(-) create mode 100644 LICENSE.md diff --git a/LICENSE b/LICENSE index bdf8804..6e0460d 100644 --- a/LICENSE +++ b/LICENSE @@ -1,21 +1,2 @@ -MIT License - -Copyright (c) 2023 João Santiago - -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -SOFTWARE. +YEAR: 2023 +COPYRIGHT HOLDER: João Santiago diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..4ff217a --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,21 @@ +# MIT License + +Copyright (c) 2023 João Santiago + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. From c2c1f4331769020fcde657e9576dce8440a7c86b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jo=C3=A3o=20Santiago?= Date: Wed, 13 Dec 2023 10:50:56 +0100 Subject: [PATCH 5/7] fix docs --- R/calls.R | 2 +- cran-comments.md | 24 ++++++++++++++++++++++++ man/calls_to_stacktrace.Rd | 2 +- 3 files changed, 26 insertions(+), 2 deletions(-) diff --git a/R/calls.R b/R/calls.R index a7f3f19..ea89285 100644 --- a/R/calls.R +++ b/R/calls.R @@ -7,7 +7,7 @@ #' \dontrun{ #' f <- function() stop("cabin pressure lost") #' f() -#' sentryR:::calls_to_stacktrace(sys.calls()) +#' calls_to_stacktrace(sys.calls()) #' } calls_to_stacktrace <- function(calls) { srcrefs <- lapply(calls, function(call) attr(call, "srcref", exact = TRUE)) diff --git a/cran-comments.md b/cran-comments.md index a698648..3ad0cfa 100644 --- a/cran-comments.md +++ b/cran-comments.md @@ -1,5 +1,29 @@ +# Round 1 ## R CMD check results 0 errors | 0 warnings | 1 note * This is an update to a package previously released, but then removed due to an unreachable maintainer email. The copyright has moved to a new owner (the main developer), and the email updated accordingly. + +# Round 2 +## Reviewer response +Thanks, + +You have examples for unexported functions. Please either omit these +examples or export these functions. +Used ::: in documentation: +      man/calls_to_stacktrace.Rd: +         sentryR:::calls_to_stacktrace(sys.calls()) + +Please fix and resubmit. + +Best, +Benjamin Altmann + +## Author response + +Thank you for your time reviewing this application Benjamin, I appreciate the comments. +I have updated the documentation and examples to match your comments. + +Best, +Joao Santiago diff --git a/man/calls_to_stacktrace.Rd b/man/calls_to_stacktrace.Rd index 009cd4c..2842cbf 100644 --- a/man/calls_to_stacktrace.Rd +++ b/man/calls_to_stacktrace.Rd @@ -19,6 +19,6 @@ Convert function call to a stack trace \dontrun{ f <- function() stop("cabin pressure lost") f() -sentryR:::calls_to_stacktrace(sys.calls()) +calls_to_stacktrace(sys.calls()) } } From d456296c23daf6b53435de46e68f6f1404f77b18 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jo=C3=A3o=20Santiago?= Date: Thu, 14 Dec 2023 10:05:05 +0100 Subject: [PATCH 6/7] Update CRAN-SUBMISSION --- CRAN-SUBMISSION | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CRAN-SUBMISSION b/CRAN-SUBMISSION index 56a2f07..f7bd79e 100644 --- a/CRAN-SUBMISSION +++ b/CRAN-SUBMISSION @@ -1,3 +1,3 @@ Version: 1.1.2 -Date: 2023-12-12 10:07:02 UTC -SHA: cb9b28b3282c22d0d173894a8fb4d623cf0d1b31 +Date: 2023-12-13 10:01:58 UTC +SHA: c2c1f4331769020fcde657e9576dce8440a7c86b From 6a2dab4562e0f77087981f3fdc8bf2ccaf6d0b36 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jo=C3=A3o=20Santiago?= Date: Sun, 17 Dec 2023 23:41:44 +0100 Subject: [PATCH 7/7] remove examples --- R/calls.R | 6 ------ man/calls_to_stacktrace.Rd | 7 ------- 2 files changed, 13 deletions(-) diff --git a/R/calls.R b/R/calls.R index ea89285..03e5bd9 100644 --- a/R/calls.R +++ b/R/calls.R @@ -3,12 +3,6 @@ #' @param calls function calls, e.g. from sys.calls() #' #' @return a data.frame -#' @examples -#' \dontrun{ -#' f <- function() stop("cabin pressure lost") -#' f() -#' calls_to_stacktrace(sys.calls()) -#' } calls_to_stacktrace <- function(calls) { srcrefs <- lapply(calls, function(call) attr(call, "srcref", exact = TRUE)) srcfiles <- lapply(srcrefs, function(ref) { diff --git a/man/calls_to_stacktrace.Rd b/man/calls_to_stacktrace.Rd index 2842cbf..b684312 100644 --- a/man/calls_to_stacktrace.Rd +++ b/man/calls_to_stacktrace.Rd @@ -15,10 +15,3 @@ a data.frame \description{ Convert function call to a stack trace } -\examples{ -\dontrun{ -f <- function() stop("cabin pressure lost") -f() -calls_to_stacktrace(sys.calls()) -} -}