From 58f87b65d9c6b0d72eaa3d32acbf278032010f89 Mon Sep 17 00:00:00 2001 From: Pawel Rucki <12943682+pawelru@users.noreply.github.com> Date: Tue, 30 Jan 2024 00:10:44 +0100 Subject: [PATCH 1/5] update deps of roxygenize hook (#296) --- .pre-commit-config.yaml | 18 ++++-------------- DESCRIPTION | 2 +- 2 files changed, 5 insertions(+), 15 deletions(-) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 9ff0944a..a99da0c5 100755 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -16,24 +16,14 @@ repos: name: Regenerate package documentation additional_dependencies: - checkmate - - digest - dplyr - - ggplot2 - - glue - - grDevices - lifecycle - - logger + - lubridate - magrittr - - methods - - bioc::MultiAssayExperiment - - R6 - rlang - - rtables - - shinyjs - - shinyWidgets - - stats - - bioc::SummarizedExperiment - - utils + - stringr + - tibble + - tidyr - yaml - id: spell-check name: Check spelling with `spelling` diff --git a/DESCRIPTION b/DESCRIPTION index eb3ec57b..ca0a01fa 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -47,4 +47,4 @@ Encoding: UTF-8 Language: en-US LazyData: true Roxygen: list(markdown = TRUE) -RoxygenNote: 7.2.3 +RoxygenNote: 7.3.1 From b63a2f18c1bf7d52bf1f02c40f3fe8e8bdee6121 Mon Sep 17 00:00:00 2001 From: pawelru Date: Mon, 29 Jan 2024 23:11:37 +0000 Subject: [PATCH 2/5] [skip actions] Bump version to 0.3.14.9007 --- .pre-commit-config.yaml | 2 +- DESCRIPTION | 4 ++-- NEWS.md | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index a99da0c5..7cc68495 100755 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -6,7 +6,7 @@ default_language_version: python: python3 repos: - repo: https://github.com/lorenzwalthert/precommit - rev: v0.3.2.9027 + rev: v0.4.0 hooks: - id: style-files name: Style code with `styler` diff --git a/DESCRIPTION b/DESCRIPTION index ca0a01fa..a476e535 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,8 +1,8 @@ Type: Package Package: random.cdisc.data Title: Create Random SDTM and ADAM Datasets -Version: 0.3.14.9006 -Date: 2023-12-13 +Version: 0.3.14.9007 +Date: 2024-01-29 Authors@R: c( person("Pawel", "Rucki", , "pawel.rucki@roche.com", role = c("aut", "cre")), person("Nick", "Paszty", , "npaszty@gene.com", role = "aut"), diff --git a/NEWS.md b/NEWS.md index 3aed6b81..895a1ed0 100644 --- a/NEWS.md +++ b/NEWS.md @@ -1,4 +1,4 @@ -# random.cdisc.data 0.3.14.9006 +# random.cdisc.data 0.3.14.9007 ### New features * Asynchronous cached data updates in `rebuild_cached_data` vignette - data is only updated if its (or its dependency's) source file has been updated. From a1ba669586b0165f4b94965edaedee2cb848bd9c Mon Sep 17 00:00:00 2001 From: Insights Engineering Bot <68416928+insights-engineering-bot@users.noreply.github.com> Date: Fri, 9 Feb 2024 15:55:53 +0100 Subject: [PATCH 3/5] Propagate files from insightsengineering/.github (#297) This PR has been automatically generated by the file propagation workflow from insightsengineering/.github. Please review the changes. Co-authored-by: walkowif --- .github/ISSUE_TEMPLATE/release.yml | 120 +++++++++++++++++++++++++++++ 1 file changed, 120 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/release.yml diff --git a/.github/ISSUE_TEMPLATE/release.yml b/.github/ISSUE_TEMPLATE/release.yml new file mode 100644 index 00000000..f54d69e1 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/release.yml @@ -0,0 +1,120 @@ +--- +name: 🚀 Release +description: Template for package release +title: "[Release]: " +labels: ["release"] +assignees: + - KlaudiaBB + - cicdguy +body: + - type: markdown + attributes: + value: | + ⚠️ Please do not link or mention any internal references in this issue. This includes internal URLs, intellectual property and references. + - type: textarea + id: blocked-by + attributes: + label: Blocked by + description: Any PRs or issues that this release is blocked by. + placeholder: Add a list of blocking PRs or issues here. + value: | + #### PRs + - [ ] PR 1 + + #### Issues + - [ ] Issue 1 + validations: + required: true + - type: textarea + id: pre-release + attributes: + label: Pre-release + description: Pre-requisites that must be fulfilled before initiating the release process. + placeholder: Add your list of pre-requisites here. + value: | + - [ ] Make sure that high priority bugs (label "priority" + "bug") have been resolved before going into the release. + - [ ] Review old/hanging PRs before going into the release. + - [ ] Revisit R-package's lifecycle badges (Optional). + - [ ] Release Manager: Discuss package dependencies, create a plan to sequentially close release activities and submit groups of packages for internal validation (Applicable only for regulatory release). + - [ ] Check Validation Pipeline dry-run results for the package. + - [ ] Make sure all relevant integration tests are green 2-3 days before the release. Look carefully through logs (check for warnings and notes). + - [ ] Inform about the soft code freeze, decide what gets merged in before starting release activities. + - type: textarea + id: release + attributes: + label: Release + description: The steps to be taken in order to create a release. + placeholder: Steps to create a release. + value: | + #### Prepare the release + - [ ] Create a new release candidate branch + `git checkout -b release-candidate-vX.Y.Z` + - [ ] Update NEWS.md file: make sure it reflects a holistic summary of what has changed in the package, check README. + - [ ] Remove the additional fields (`Remotes`) from the DESCRIPTION file where applicable. + - [ ] Make sure that the minimum dependency versions are updated in the DESCRIPTION file for the package. + - [ ] Increase versioned dependency on {package name} to >=X.Y.Z. + - [ ] Commit your changes and create the PR on GitHub (add "[skip vbump]" in the PR title). Add all updates, commit, and push changes: + ```r + # Make the necessary modifications to your files + # Stage the changes + git add + # Commit the changes + git commit -m "[skip vbump] " + git push origin release-candidate-vX.Y.Z + ``` + + #### Test the release + - [ ] Execute the manual tests on Shiny apps that are deployed on various hosting providers (Posit connect and shinyapps.io) - track the results in GitHub issue (Applicable only for frameworks that use Shiny). + - [ ] Monitor integration tests, if integration fails, create priority issues on the board. + - [ ] Execute UAT tests (Optional). + + #### Validation loop + + **Note:** This section is applicable only for regulatory packages. + + - [ ] Tag the update(s) as a release candidate vX.Y.Z-rc (e.g. v0.5.3-rc1) on the release candidate branch (release-candidate-vX.Y.Z). + ```r + # Create rc tag for submission for internal validation + git tag vX.Y.Z-rc + git push origin vX.Y.Z-rc + ``` + - [ ] Submit the package for internal validation. + - [ ] Address any feedback (internal validation/user testing), retag the package as a release candidate vX.Y.Z-rc(n+1). Repeat the submission for internal validation if necessary. + - [ ] Get the package validated. + + #### Tag the release + - [ ] If the additional fields were removed, add them back in a separate PR, and then merge the PR back to main (add "[skip vbump]" in the PR title). If nothing was removed just merge the PR you created in the "Prepare the release" section to `main`. Note the commit hash of the merged commit. **Note:** additional commits might be added to the `main` branch by a bot or an automation - we do **NOT** want to tag this commit. + + ##### Make sure of the following before continuing with the release: + - [ ] CI checks are passing in GH. + - [ ] Shiny apps are deployable and there are no errors/warnings (Applicable only for frameworks that use Shiny). + + - [ ] Create a git tag with the final version set to vX.Y.Z on the main branch. In order to do this: + 1. Checkout the commit hash. + `git checkout ` + 2. Tag the hash with the release version (vX.Y.Z). + `git tag vX.Y.Z` + 3. Push the tag to make the final release. + `git push origin vX.Y.Z` + - [ ] Update downstream package dependencies to (>=X.Y.Z) in {package name}. + **Note:** Once the release tag is created, the package is automatically published to internal repositories. + - type: textarea + id: post-release + attributes: + label: Post-release + description: The list of activities to be completed after the release. + placeholder: The steps that must be taken after the release. + value: | + - [ ] Make sure that the package is published to internal repositories (Validated and/or Non-Validated repository). + - [ ] Review and update installation instructions for the package if needed. + - [ ] Make sure internal documentation/documentation catalogs are up to date. + - [ ] Notify the IDR team to start post-release/clean-up activities. + - [ ] Announce the release on ________. + - type: textarea + id: decision-tree + attributes: + label: Decision tree + description: Any decision tree(s) that would aid release management + placeholder: Any decision tree(s) that would aid release management. + value: | + Click [here](https://github.com/insightsengineering/.github/blob/main/.github/ISSUE_TEMPLATE/RELEASE_DECISION_TREE.md) to see the release decision tree. From a3fd09ac2b54890759346a80f99464967d1e1c46 Mon Sep 17 00:00:00 2001 From: insights-engineering-bot Date: Fri, 9 Feb 2024 14:57:04 +0000 Subject: [PATCH 4/5] [skip actions] Bump version to 0.3.14.9008 --- DESCRIPTION | 4 ++-- NEWS.md | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/DESCRIPTION b/DESCRIPTION index a476e535..abe6a162 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,8 +1,8 @@ Type: Package Package: random.cdisc.data Title: Create Random SDTM and ADAM Datasets -Version: 0.3.14.9007 -Date: 2024-01-29 +Version: 0.3.14.9008 +Date: 2024-02-09 Authors@R: c( person("Pawel", "Rucki", , "pawel.rucki@roche.com", role = c("aut", "cre")), person("Nick", "Paszty", , "npaszty@gene.com", role = "aut"), diff --git a/NEWS.md b/NEWS.md index 895a1ed0..30d53912 100644 --- a/NEWS.md +++ b/NEWS.md @@ -1,4 +1,4 @@ -# random.cdisc.data 0.3.14.9007 +# random.cdisc.data 0.3.14.9008 ### New features * Asynchronous cached data updates in `rebuild_cached_data` vignette - data is only updated if its (or its dependency's) source file has been updated. From 5eebe4b14173a0c9175d3923a725cc94c5e479e9 Mon Sep 17 00:00:00 2001 From: Insights Engineering Bot <68416928+insights-engineering-bot@users.noreply.github.com> Date: Fri, 9 Feb 2024 17:38:34 +0100 Subject: [PATCH 5/5] [skip actions] Propagate files from insightsengineering/.github (#298) This PR has been automatically generated by the file propagation workflow from insightsengineering/.github. Co-authored-by: walkowif --- .github/ISSUE_TEMPLATE/release.yaml | 122 ---------------------------- .github/ISSUE_TEMPLATE/release.yml | 2 + 2 files changed, 2 insertions(+), 122 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/release.yaml diff --git a/.github/ISSUE_TEMPLATE/release.yaml b/.github/ISSUE_TEMPLATE/release.yaml deleted file mode 100644 index 73bb11dc..00000000 --- a/.github/ISSUE_TEMPLATE/release.yaml +++ /dev/null @@ -1,122 +0,0 @@ ---- -name: 🚀 Release -description: Template for package release -title: "[Release]: " -labels: ["release"] -assignees: - - KlaudiaBB - - cicdguy -body: - - type: markdown - attributes: - value: | - ⚠️ Please do not link or mention any internal references in this issue. This includes internal URLs, intellectual property and references. - - type: textarea - id: blocked-by - attributes: - label: Blocked by - description: Any PRs or issues that this release is blocked by. - placeholder: Add a list of blocking PRs or issues here. - value: | - ### PRs - - - [ ] PR 1 - - ### Issues - - - [ ] Issue 1 - validations: - required: true - - type: textarea - id: pre-release - attributes: - label: Pre-release - description: Pre-requisites that must be fulfilled before initiating the release process. - placeholder: Add your list of pre-requisites here. - value: | - - [ ] Make sure that high priority bugs (label "priority" + "bug") have been resolved before going into the release. - - [ ] Review old/hanging PRs before going into the release. - - [ ] Revisit R-package's lifecycle badges (Optional). - - [ ] Release Manager: Discuss package dependencies, create a plan to sequentially close release activities and submit groups of packages for internal validation (Applicable only for regulatory release). - - [ ] Check Validation Pipeline dry-run results for the package. - - [ ] Make sure all relevant integration tests are green 2-3 days before the release. Look carefully through logs (check for warnings and notes). - - [ ] Inform about the soft code freeze, decide what gets merged in before starting release activities. - - type: textarea - id: release - attributes: - label: Release - description: The steps to be taken in order to create a release. - placeholder: Steps to create a release. - value: | - ### Prepare the release - - - [ ] Create a new release candidate branch - `git checkout -b release-candidate-vX.Y.Z` - - [ ] Update NEWS.md file: make sure it reflects a holistic summary of what has changed in the package, check README. - - [ ] Remove the additional fields (`Remotes`) from the DESCRIPTION file where applicable. - - [ ] Make sure that the minimum dependency versions are updated in the DESCRIPTION file for the package. - - [ ] Increase versioned dependency on {package name} to >=X.Y.Z. - - [ ] Commit your changes and create the PR on GitHub (add "[skip vbump]" in the PR title). Add all updates, commit, and push changes: - `# Make the necessary modifications to your files - # Stage the changes - git add - # Commit the changes - git commit -m "[skip vbump] " - git push origin release-candidate-vX.Y.Z` - - ### Test the release - - - [ ] Execute the manual tests on Shiny apps that are deployed on various hosting providers (Posit connect and shinyapps.io) - track the results in GitHub issue (Applicable only for frameworks that use Shiny). - - [ ] Monitor integration tests, if integration fails, create priority issues on the board. - - [ ] Execute UAT tests (Optional). - - ### Validation loop - - Note: This section is applicable only for regulatory packages. - - - [ ] Tag the update(s) as a release candidate vX.Y.Z-rc (e.g. v0.5.3-rc1) on the release candidate branch (release-candidate-vX.Y.Z). - `# Create rc tag for submission for internal validation - git tag vX.Y.Z-rc - git push origin vX.Y.Z-rc` - - [ ] Submit the package for internal validation. - - [ ] Address any feedback (internal validation/user testing), retag the package as a release candidate vX.Y.Z-rc(n+1). Repeat the submission for internal validation if necessary. - - [ ] Get the package validated. - - ### Tag the release - - - [ ] If the additional fields were removed, add them back in a separate PR, and then merge the PR back to main (add "[skip vbump]" in the PR title). If nothing was removed just merge the PR you created in the "Prepare the release" section to `main`. Note the commit hash of the merged commit. **Note:** additional commits might be added to the `main` branch by a bot or an automation - we do **NOT** want to tag this commit. - - #### Make sure of the following before continuing with the release: - - - [ ] CI checks are passing in GH. - - [ ] Shiny apps are deployable and there are no errors/warnings (Applicable only for frameworks that use Shiny). - - - [ ] Create a git tag with the final version set to vX.Y.Z on the main branch. In order to do this: - 1. Checkout the commit hash. - `git checkout ` - 2. Tag the hash with the release version (vX.Y.Z). - `git tag vX.Y.Z` - 3. Push the tag to make the final release. - `git push origin vX.Y.Z` - - [ ] Update downstream package dependencies to (>=X.Y.Z) in {package name}. - Note: Once the release tag is created, the package is automatically published to internal repositories. - - type: textarea - id: post-release - attributes: - label: Post-release - description: The list of activities to be completed after the release. - placeholder: The steps that must be taken after the release. - value: | - - [ ] Make sure that the package is published to internal repositories (Validated and/or Non-Validated repository). - - [ ] Review and update installation instructions for the package if needed. - - [ ] Make sure internal documentation/documentation catalogs are up to date. - - [ ] Notify the IDR team to start post-release/clean-up activities. - - [ ] Announce the release on ________. - - type: textarea - id: decision-tree - attributes: - label: Decision tree - description: Any decision tree(s) that would aid release management - placeholder: Any decision tree(s) that would aid release management. - value: | - Click [here](https://github.com/insightsengineering/.github/blob/main/.github/ISSUE_TEMPLATE/RELEASE_DECISION_TREE.md) to see the release decision tree. diff --git a/.github/ISSUE_TEMPLATE/release.yml b/.github/ISSUE_TEMPLATE/release.yml index f54d69e1..665688e4 100644 --- a/.github/ISSUE_TEMPLATE/release.yml +++ b/.github/ISSUE_TEMPLATE/release.yml @@ -63,11 +63,13 @@ body: git push origin release-candidate-vX.Y.Z ``` + #### Test the release - [ ] Execute the manual tests on Shiny apps that are deployed on various hosting providers (Posit connect and shinyapps.io) - track the results in GitHub issue (Applicable only for frameworks that use Shiny). - [ ] Monitor integration tests, if integration fails, create priority issues on the board. - [ ] Execute UAT tests (Optional). + #### Validation loop **Note:** This section is applicable only for regulatory packages.