Skip to content

Commit

Permalink
merge main
Browse files Browse the repository at this point in the history
  • Loading branch information
pawelru committed Feb 14, 2024
2 parents 9f2f0f1 + ac7fec3 commit 4952f25
Show file tree
Hide file tree
Showing 6 changed files with 53 additions and 38 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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 <files your modified>
# Commit the changes
git commit -m "[skip vbump] <Your commit message>"
git push origin release-candidate-vX.Y.Z`
```r
# Make the necessary modifications to your files
# Stage the changes
git add <files your modified>
# Commit the changes
git commit -m "[skip vbump] <Your commit message>"
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<iteration-number> (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<iteration number>
git push origin vX.Y.Z-rc<iteration number>`
git push origin vX.Y.Z-rc<iteration number>
```
- [ ] 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).
Expand All @@ -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:
Expand Down
25 changes: 14 additions & 11 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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`
Expand All @@ -15,26 +15,29 @@ repos:
- id: roxygenize
name: Regenerate package documentation
additional_dependencies:
- teal.data # missing
- insightsengineering/teal.slice # missing
- insightsengineering/goshawk
- shiny
- insightsengineering/teal
- insightsengineering/teal.transform
- checkmate
- digest
- colourpicker
- dplyr
- DT
- ggplot2
- glue
- grDevices
- lifecycle
- logger
- magrittr
- methods
- bioc::MultiAssayExperiment
- R6
- rlang
- rtables
- shinyjs
- shinyWidgets
- shinyvalidate
- stats
- bioc::SummarizedExperiment
- utils
- yaml
- teal.code
- teal.logger
- teal.reporter
- teal.widgets
- id: spell-check
name: Check spelling with `spelling`
exclude: >
Expand Down
7 changes: 5 additions & 2 deletions DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
Type: Package
Package: teal.goshawk
Title: Longitudinal Visualization `teal` Modules
Version: 0.1.15.9006
Date: 2023-12-13
Version: 0.1.15.9010
Date: 2024-02-14
Authors@R: c(
person("Nick", "Paszty", , "[email protected]", role = c("aut", "cre")),
person("Dawid", "Kaledkowski", , "[email protected]", role = "aut"),
Expand All @@ -25,6 +25,9 @@ Description: Modules that produce web interfaces through which
variables, Limit of Quantification flag variable (LOQFL) is expected
with levels 'Y', 'N' or NA.
License: Apache License 2.0 | file LICENSE
URL: https://insightsengineering.github.io/teal.goshawk/,
https://github.com/insightsengineering/teal.goshawk/
BugReports: https://github.com/insightsengineering/teal.goshawk/issues
Depends:
goshawk (>= 0.1.15),
R (>= 3.6),
Expand Down
2 changes: 1 addition & 1 deletion NEWS.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# teal.goshawk 0.1.15.9006
# teal.goshawk 0.1.15.9010

### Breaking Changes
* Adapted all modules to use `teal_data` objects.
Expand Down
9 changes: 9 additions & 0 deletions man/teal.goshawk-package.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/tm_g_gh_scatterplot.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 4952f25

Please sign in to comment.