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 73bb11dc..665688e4 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/.pre-commit-config.yaml b/.pre-commit-config.yaml index 9ff0944a..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` @@ -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 a4d3e319..a43e4b5b 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.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 3aed6b81..30d53912 100644 --- a/NEWS.md +++ b/NEWS.md @@ -1,4 +1,4 @@ -# random.cdisc.data 0.3.14.9006 +# 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.