diff --git a/.github/ISSUE_TEMPLATE/cran-release.yaml b/.github/ISSUE_TEMPLATE/cran-release.yml similarity index 88% rename from .github/ISSUE_TEMPLATE/cran-release.yaml rename to .github/ISSUE_TEMPLATE/cran-release.yml index bab34fcff..b91449034 100644 --- a/.github/ISSUE_TEMPLATE/cran-release.yaml +++ b/.github/ISSUE_TEMPLATE/cran-release.yml @@ -1,12 +1,11 @@ --- name: 🎉 CRAN Release description: Template for release to CRAN -title: "[Release]: " +title: "[CRAN Release]: " labels: ["release"] assignees: - KlaudiaBB - cicdguy - - shajoezhu body: - type: markdown attributes: @@ -19,12 +18,10 @@ body: description: Any PRs or issues that this release is blocked by. placeholder: Add a list of blocking PRs or issues here. value: | - ### PRs - + #### PRs - [ ] PR 1 - ### Issues - + #### Issues - [ ] Issue 1 validations: required: true @@ -35,7 +32,9 @@ body: 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 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). @@ -49,8 +48,7 @@ body: description: The steps to be taken in order to create a release. placeholder: Steps to create a release. value: | - ### Prepare the release - + #### 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. @@ -58,37 +56,38 @@ body: - [ ] 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 + ```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 + #### 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 - + #### 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 + ```r + # Create rc tag for submission for internal validation git tag vX.Y.Z-rc - git push origin 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 - + #### 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 - + ##### 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). @@ -100,7 +99,7 @@ body: 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. + **Note:** Once the release tag is created, the package is automatically published to internal repositories. - type: textarea id: post-release attributes: @@ -112,7 +111,6 @@ body: - [ ] 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 diff --git a/.github/ISSUE_TEMPLATE/release.yaml b/.github/ISSUE_TEMPLATE/release.yml similarity index 85% rename from .github/ISSUE_TEMPLATE/release.yaml rename to .github/ISSUE_TEMPLATE/release.yml index 73bb11dc8..665688e41 100644 --- a/.github/ISSUE_TEMPLATE/release.yaml +++ b/.github/ISSUE_TEMPLATE/release.yml @@ -18,12 +18,10 @@ body: description: Any PRs or issues that this release is blocked by. placeholder: Add a list of blocking PRs or issues here. value: | - ### PRs - + #### PRs - [ ] PR 1 - ### Issues - + #### Issues - [ ] Issue 1 validations: required: true @@ -48,46 +46,48 @@ body: description: The steps to be taken in order to create a release. placeholder: Steps to create a release. value: | - ### Prepare the release - + #### 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. + - [ ] 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` + ```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 + #### 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. + #### 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 + ```r + # Create rc tag for submission for internal validation git tag vX.Y.Z-rc - git push origin 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 - + #### 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: - + ##### 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). @@ -99,7 +99,7 @@ body: 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. + **Note:** Once the release tag is created, the package is automatically published to internal repositories. - type: textarea id: post-release attributes: 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/.pre-commit-config.yaml b/.pre-commit-config.yaml index 31a44c773..73f726190 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -2,17 +2,18 @@ # 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 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 14c307c75..b6e200ebb 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.9007 +Date: 2024-02-09 Authors@R: c( person("Gabriel", "Becker", , "gabembecker@gmail.com", role = "aut", comment = "Original creator of the package"), @@ -62,6 +62,7 @@ Encoding: UTF-8 Language: en-US LazyData: true Roxygen: list(markdown = TRUE) +RoxygenNote: 7.3.1 Collate: '00tabletrees.R' 'Viewer.R' @@ -94,4 +95,3 @@ Collate: 'tt_from_df.R' 'validate_table_struct.R' 'zzz_constants.R' -RoxygenNote: 7.3.1 diff --git a/NEWS.md b/NEWS.md index b1c99c65b..5aee3f299 100644 --- a/NEWS.md +++ b/NEWS.md @@ -1,4 +1,4 @@ -## rtables 0.6.6.9005 +## rtables 0.6.6.9007 ### New Features * Added `top_level_section_div` for `basic_table` to set section dividers for top level rows. * `sort_at_path` now gives informative error messages when the given path does not exist.