Update DESCRIPTION #175
Merged
Update DESCRIPTION #175
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Config/Needs/verdepcheck entries in new line - add `bioc::` for packages from Bioconductor Signed-off-by: Pawel Rucki <[email protected]>
|
Code Coverage SummaryDiff against mainResults for commit: 520d737 Minimum allowed coverage is ♻️ This comment has been updated with latest results |
averissimo
approved these changes
Oct 16, 2023
There was a problem hiding this comment.
Thanks for catching this.
The r.pkg.template/.github/workflows/version-bump.yaml action will always refactor the Config/Needs/verdepcheck to single line though (with NORMALIZE = TRUE option).
note: scheduled action was triggered manually and runs successfully: https://github.com/insightsengineering/teal.data/actions/runs/6533445688/job/17738647791
Good find! Can you please make a PR then? |
|
Sure can, but @pawelru this will have a side effect that packages within fields won't be sorted or whitespace being "normalized". That is a nice feature to have. We correct the diff --git a/.github/workflows/version-bump.yaml b/.github/workflows/version-bump.yaml
index 0d41874..a8941a1 100644
--- a/.github/workflows/version-bump.yaml
+++ b/.github/workflows/version-bump.yaml
@@ -63,7 +63,23 @@ jobs:
- name: Bump version in DESCRIPTION 📜
if: ${{ (github.event_name == 'push' && github.ref == 'refs/heads/main') || inputs.vbump-after-release == true }}
- run: desc::desc_bump_version("dev", normalize = TRUE)
+ run: |
+ desc::desc_bump_version("dev", normalize = TRUE)
+ # verdepcheck with 1 line per package
+ d <- desc::description$new("dev")
+ desc_field_name <- "Config/Needs/verdepcheck"
+ if (d$has_fields(field_name) && !identical(d$get_field(field_name), "")) {
+ desc_field_sep <- "\n "
+ desc_field_normalized <- paste0(
+ field_sep,
+ paste(
+ strsplit(d$get_field(field_name), ", ")[[1]],
+ collapse = field_sep
+ )
+ )
+ d$set(field_name, desc_field_normalized)
+ d$write(file = "dev")
+ }
shell: Rscript {0}
working-directory: ${{ inputs.package-subdirectory }}
|
|
Thanks for checking. That's quite a lot of custom code :/ Let's leave that then. |
|
That would be best, I'll raise that issue |
|
I managed to reduce the code to fewer lines. There was already an issue being tracked on r-lib/desc#122 diff --git a/.github/workflows/version-bump.yaml b/.github/workflows/version-bump.yaml
index 0d41874..f258d28 100644
--- a/.github/workflows/version-bump.yaml
+++ b/.github/workflows/version-bump.yaml
@@ -63,7 +63,14 @@ jobs:
- name: Bump version in DESCRIPTION 📜
if: ${{ (github.event_name == 'push' && github.ref == 'refs/heads/main') || inputs.vbump-after-release == true }}
- run: desc::desc_bump_version("dev", normalize = TRUE)
+ run: |
+ desc::desc_bump_version("dev", normalize = TRUE)
+ # verdepcheck splitting into new lines
+ d <- desc::description$new("dev")
+ desc_field_name <- "Config/Needs/verdepcheck"
+ if (desc$has_fields(desc_field_name)) {
+ desc$set_list(desc_field_name, desc$get_list(desc_field_name), sep = ",\n\t\t")
+ }
shell: Rscript {0}
working-directory: ${{ inputs.package-subdirectory }}Exampletf <- tempfile()
text <- "Package: test\nImports: tdplyr, tibble\nConfig/Needs/website: tidyverse/tidytemplate, r-lib/desc"
desc <- desc::description$new(text = text)
desc$normalize()
desc_field_name <- "Config/Needs/website"
if (desc$has_fields(desc_field_name)) {
desc$set_list(desc_field_name, desc$get_list(desc_field_name), sep = ",\n ")
}
desc$write(file = tf)
readLines(tf) |> paste0(collapse = "\n") |> cat()
#> Package: test
#> Imports:
#> tdplyr,
#> tibble
#> Config/Needs/website: tidyverse/tidytemplate,
#> r-lib/descCreated on 2023-10-25 with reprex v2.0.2 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
bioc::for packages from Bioconductor