From 9369d32b8fb89ac3dc0d63c12ce9a1811a3e7dac Mon Sep 17 00:00:00 2001 From: Pawel Rucki <12943682+pawelru@users.noreply.github.com> Date: Tue, 30 Jan 2024 00:12:52 +0100 Subject: [PATCH 1/6] update deps of roxygenize hook (#821) --- .pre-commit-config.yaml | 13 +++++++------ DESCRIPTION | 2 +- 2 files changed, 8 insertions(+), 7 deletions(-) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 31a44c773..69746405a 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -7,12 +7,13 @@ repos: - id: roxygenize # roxygen requires loading pkg -> add dependencies from DESCRIPTION additional_dependencies: - - methods - - magrittr - - insightsengineering/formatters - - stats - - htmltools - - grid + - formatters + - magrittr + - methods + - checkmate + - htmltools + - stats + - stringi # codemeta must be above use-tidy-description when both are used # - id: codemeta-description-updated - id: use-tidy-description diff --git a/DESCRIPTION b/DESCRIPTION index 9267b8bb3..177aa5f59 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -62,7 +62,7 @@ Encoding: UTF-8 Language: en-US LazyData: true Roxygen: list(markdown = TRUE) -RoxygenNote: 7.2.3 +RoxygenNote: 7.3.1 Collate: '00tabletrees.R' 'Viewer.R' From b54415f5315e48aa82bce64bbcb810401a9cdd3f Mon Sep 17 00:00:00 2001 From: pawelru Date: Mon, 29 Jan 2024 23:14:01 +0000 Subject: [PATCH 2/6] [skip actions] Bump version to 0.6.6.9006 --- .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 69746405a..73f726190 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -2,7 +2,7 @@ # R specific hooks: https://github.com/lorenzwalthert/precommit repos: - repo: https://github.com/lorenzwalthert/precommit - rev: v0.3.2.9027 + rev: v0.4.0 hooks: - id: roxygenize # roxygen requires loading pkg -> add dependencies from DESCRIPTION diff --git a/DESCRIPTION b/DESCRIPTION index 177aa5f59..c82d589a1 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,7 +1,7 @@ Package: rtables Title: Reporting Tables -Version: 0.6.6.9005 -Date: 2024-01-19 +Version: 0.6.6.9006 +Date: 2024-01-29 Authors@R: c( person("Gabriel", "Becker", , "gabembecker@gmail.com", role = "aut", comment = "Original creator of the package"), diff --git a/NEWS.md b/NEWS.md index 0628c5199..1fecb663f 100644 --- a/NEWS.md +++ b/NEWS.md @@ -1,4 +1,4 @@ -## rtables 0.6.6.9005 +## rtables 0.6.6.9006 ### New Features * Added `top_level_section_div` for `basic_table` to set section dividers for top level rows. From 6afc315d4bcfab199b4be7236f6b23dec64f875b Mon Sep 17 00:00:00 2001 From: cicdguy <26552821+cicdguy@users.noreply.github.com> Date: Fri, 9 Feb 2024 02:52:53 -0600 Subject: [PATCH 3/6] Set default landing page for pkgdown docs to `latest-tag` (#823) * Set default landing page for pkgdown docs to `latest-tag` Currently the redirects go to `main` Signed-off-by: cicdguy <26552821+cicdguy@users.noreply.github.com> * chore: update docs based using the new roxygen version --------- Signed-off-by: cicdguy <26552821+cicdguy@users.noreply.github.com> Co-authored-by: vedhav --- .github/workflows/docs.yaml | 1 + man/int_methods.Rd | 14 +++++++------- man/rheader.Rd | 2 +- man/rtable.Rd | 4 ++-- 4 files changed, 11 insertions(+), 10 deletions(-) diff --git a/.github/workflows/docs.yaml b/.github/workflows/docs.yaml index fc923fd4e..7aac0d3d0 100644 --- a/.github/workflows/docs.yaml +++ b/.github/workflows/docs.yaml @@ -23,3 +23,4 @@ jobs: REPO_GITHUB_TOKEN: ${{ secrets.REPO_GITHUB_TOKEN }} with: sd-direction: upstream + default-landing-page: latest-tag diff --git a/man/int_methods.Rd b/man/int_methods.Rd index e5d1fd063..15928d246 100644 --- a/man/int_methods.Rd +++ b/man/int_methods.Rd @@ -357,7 +357,7 @@ split_rows(lyt = NULL, spl, pos, cmpnd_fun = AnalyzeMultiVars) -\S4method{split_rows}{`NULL`}(lyt = NULL, spl, pos, cmpnd_fun = AnalyzeMultiVars) +\S4method{split_rows}{NULL}(lyt = NULL, spl, pos, cmpnd_fun = AnalyzeMultiVars) \S4method{split_rows}{PreDataRowLayout}(lyt = NULL, spl, pos, cmpnd_fun = AnalyzeMultiVars) @@ -369,7 +369,7 @@ split_rows(lyt = NULL, spl, pos, cmpnd_fun = AnalyzeMultiVars) cmpnd_last_rowsplit(lyt, spl, constructor) -\S4method{cmpnd_last_rowsplit}{`NULL`}(lyt, spl, constructor) +\S4method{cmpnd_last_rowsplit}{NULL}(lyt, spl, constructor) \S4method{cmpnd_last_rowsplit}{PreDataRowLayout}(lyt, spl, constructor) @@ -381,7 +381,7 @@ cmpnd_last_rowsplit(lyt, spl, constructor) split_cols(lyt = NULL, spl, pos) -\S4method{split_cols}{`NULL`}(lyt = NULL, spl, pos) +\S4method{split_cols}{NULL}(lyt = NULL, spl, pos) \S4method{split_cols}{PreDataColLayout}(lyt = NULL, spl, pos) @@ -533,7 +533,7 @@ next_cpos(obj, nested = TRUE) last_rowsplit(obj) -\S4method{last_rowsplit}{`NULL`}(obj) +\S4method{last_rowsplit}{NULL}(obj) \S4method{last_rowsplit}{SplitVector}(obj) @@ -773,7 +773,7 @@ content_na_str(obj) <- value \S4method{collect_leaves}{VLeaf}(tt, incl.cont = TRUE, add.labrows = FALSE) -\S4method{collect_leaves}{`NULL`}(tt, incl.cont = TRUE, add.labrows = FALSE) +\S4method{collect_leaves}{NULL}(tt, incl.cont = TRUE, add.labrows = FALSE) \S4method{collect_leaves}{ANY}(tt, incl.cont = TRUE, add.labrows = FALSE) @@ -1049,7 +1049,7 @@ spl_varnames(object) <- value \S4method{fnotes_at_path}{VTableTree,character}(obj, rowpath = NULL, colpath = NULL, reset_idx = TRUE) <- value -\S4method{fnotes_at_path}{VTableTree,`NULL`}(obj, rowpath = NULL, colpath = NULL, reset_idx = TRUE) <- value +\S4method{fnotes_at_path}{VTableTree,NULL}(obj, rowpath = NULL, colpath = NULL, reset_idx = TRUE) <- value \S4method{rbind2}{VTableNodeInfo,missing}(x, y) @@ -1057,7 +1057,7 @@ spl_varnames(object) <- value \S4method{tt_at_path}{VTableTree,ANY,VTableTree}(tt, path, ...) <- value -\S4method{tt_at_path}{VTableTree,ANY,`NULL`}(tt, path, ...) <- value +\S4method{tt_at_path}{VTableTree,ANY,NULL}(tt, path, ...) <- value \S4method{tt_at_path}{VTableTree,ANY,TableRow}(tt, path, ...) <- value diff --git a/man/rheader.Rd b/man/rheader.Rd index fc7cb0d4b..c0372d1bc 100644 --- a/man/rheader.Rd +++ b/man/rheader.Rd @@ -42,8 +42,8 @@ h2 } \seealso{ Other compatibility: -\code{\link{rrowl}()}, \code{\link{rrow}()}, +\code{\link{rrowl}()}, \code{\link{rtable}()} } \concept{compatibility} diff --git a/man/rtable.Rd b/man/rtable.Rd index 5a8e402ab..531de8c72 100644 --- a/man/rtable.Rd +++ b/man/rtable.Rd @@ -124,7 +124,7 @@ tbl2 \seealso{ Other compatibility: \code{\link{rheader}()}, -\code{\link{rrowl}()}, -\code{\link{rrow}()} +\code{\link{rrow}()}, +\code{\link{rrowl}()} } \concept{compatibility} From ee27efc1b282daadd4b19be8f9a3797a8c369cb3 Mon Sep 17 00:00:00 2001 From: vedhav Date: Fri, 9 Feb 2024 08:54:06 +0000 Subject: [PATCH 4/6] [skip actions] Bump version to 0.6.6.9007 --- DESCRIPTION | 4 ++-- NEWS.md | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/DESCRIPTION b/DESCRIPTION index c82d589a1..b6e200ebb 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,7 +1,7 @@ Package: rtables Title: Reporting Tables -Version: 0.6.6.9006 -Date: 2024-01-29 +Version: 0.6.6.9007 +Date: 2024-02-09 Authors@R: c( person("Gabriel", "Becker", , "gabembecker@gmail.com", role = "aut", comment = "Original creator of the package"), diff --git a/NEWS.md b/NEWS.md index 1fecb663f..da98984d4 100644 --- a/NEWS.md +++ b/NEWS.md @@ -1,4 +1,4 @@ -## rtables 0.6.6.9006 +## rtables 0.6.6.9007 ### New Features * Added `top_level_section_div` for `basic_table` to set section dividers for top level rows. From ef4c1e9a5c966cb4352f911e8f7663cf4056bcc6 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:58:14 +0100 Subject: [PATCH 5/6] [skip ci] Propagate files from insightsengineering/.github (#824) Co-authored-by: walkowif --- .github/ISSUE_TEMPLATE/cran-release.yml | 121 ++++++++++++++++++++++++ .github/ISSUE_TEMPLATE/release.yml | 120 +++++++++++++++++++++++ 2 files changed, 241 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/cran-release.yml create mode 100644 .github/ISSUE_TEMPLATE/release.yml diff --git a/.github/ISSUE_TEMPLATE/cran-release.yml b/.github/ISSUE_TEMPLATE/cran-release.yml new file mode 100644 index 000000000..ae49a1990 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/cran-release.yml @@ -0,0 +1,121 @@ +--- +name: 🎉 CRAN Release +description: Template for release to CRAN +title: "[CRAN 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 you adhere to CRAN submission policy: + * https://cran.r-project.org/web/packages/submission_checklist.html + * https://cran.r-project.org/web/packages/policies.html. + - [ ] 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 (Optional). + - [ ] Revisit R-package's lifecycle badges (Optional). + - [ ] Make sure that all upstream dependencies of this package that need to be submitted to CRAN were accepted before going into release activities. + - [ ] Make sure integration tests are green 2-3 days before the release. Look carefully through logs (check for warnings and notes). + - [ ] 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. + - [ ] 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 and its reverse dependencies (Optional). + - [ ] Increase versioned dependency on {package name} to >=X.Y.Z (Optional). + - [ ] 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). + + #### CRAN submission + - [ ] 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 + ``` + - [ ] Build the package locally using the command:`R CMD build .` which will generate a .tar.gz file necessary for the CRAN submission. + - [ ] Submit the package to https://win-builder.r-project.org/upload.aspx for testing, for more details please see "Building and checking R source packages for Windows": https://win-builder.r-project.org/. + - [ ] Once tested, send the package that was built in the previous steps to CRAN via this form: https://cran.r-project.org/submit.html. + - [ ] Address CRAN feedback, tag the package vX.Y.Z-rc(n+1) and repeat the submission to CRAN whenever necessary. + - [ ] Get the package accepted and published on CRAN. + + #### 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 + - [ ] CI checks are passing in GH before releasing the package. + - [ ] 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: | + - [ ] Ensure that CRAN checks are passing for the package. + - [ ] Make sure that the package is published to internal repositories. + - [ ] Make sure internal documentation is up to date. + - [ ] Review and update installation instructions for the package wherever needed (Optional). + - [ ] 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 new file mode 100644 index 000000000..f54d69e13 --- /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 ded6b868d23661d7af12c4d09748664e3beda5f2 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:42:02 +0100 Subject: [PATCH 6/6] [skip ci] Propagate files from insightsengineering/.github (#825) Co-authored-by: walkowif --- .github/ISSUE_TEMPLATE/cran-release.yaml | 124 ----------------------- .github/ISSUE_TEMPLATE/cran-release.yml | 1 + .github/ISSUE_TEMPLATE/release.yaml | 122 ---------------------- .github/ISSUE_TEMPLATE/release.yml | 2 + 4 files changed, 3 insertions(+), 246 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/cran-release.yaml delete mode 100644 .github/ISSUE_TEMPLATE/release.yaml diff --git a/.github/ISSUE_TEMPLATE/cran-release.yaml b/.github/ISSUE_TEMPLATE/cran-release.yaml deleted file mode 100644 index bab34fcff..000000000 --- a/.github/ISSUE_TEMPLATE/cran-release.yaml +++ /dev/null @@ -1,124 +0,0 @@ ---- -name: 🎉 CRAN Release -description: Template for release to CRAN -title: "[Release]: " -labels: ["release"] -assignees: - - KlaudiaBB - - cicdguy - - shajoezhu -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 you adhere to CRAN submission policy: https://cran.r-project.org/web/packages/submission_checklist.html; https://cran.r-project.org/web/packages/policies.html. - - [ ] 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 (Optional). - - [ ] Revisit R-package's lifecycle badges (Optional). - - [ ] Make sure that all upstream dependencies of this package that need to be submitted to CRAN were accepted before going into release activities. - - [ ] Make sure integration tests are green 2-3 days before the release. Look carefully through logs (check for warnings and notes). - - [ ] 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. - - [ ] 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 and its reverse dependencies (Optional). - - [ ] Increase versioned dependency on {package name} to >=X.Y.Z (Optional). - - [ ] 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). - - ### CRAN submission - - - [ ] 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` - - [ ] Build the package locally using the command:`R CMD build .` which will generate a .tar.gz file necessary for the CRAN submission. - - [ ] Submit the package to https://win-builder.r-project.org/upload.aspx for testing, for more details please see "Building and checking R source packages for Windows": https://win-builder.r-project.org/. - - [ ] Once tested, send the package that was built in the previous steps to CRAN via this form: https://cran.r-project.org/submit.html. - - [ ] Address CRAN feedback, tag the package vX.Y.Z-rc(n+1) and repeat the submission to CRAN whenever necessary. - - [ ] Get the package accepted and published on CRAN. - - ### 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 - - - [ ] CI checks are passing in GH before releasing the package. - - [ ] 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: | - - [ ] Ensure that CRAN checks are passing for the package. - - [ ] Make sure that the package is published to internal repositories. - - [ ] Make sure internal documentation is up to date. - - [ ] Review and update installation instructions for the package wherever needed (Optional). - - [ ] Update all integration tests to reference the new release. - - [ ] 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/cran-release.yml b/.github/ISSUE_TEMPLATE/cran-release.yml index ae49a1990..b91449034 100644 --- a/.github/ISSUE_TEMPLATE/cran-release.yml +++ b/.github/ISSUE_TEMPLATE/cran-release.yml @@ -65,6 +65,7 @@ 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. diff --git a/.github/ISSUE_TEMPLATE/release.yaml b/.github/ISSUE_TEMPLATE/release.yaml deleted file mode 100644 index 73bb11dc8..000000000 --- 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 f54d69e13..665688e41 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.