teal framework Release

[donyunardi]

Summary

We have completed the following enhancements

• teal_transform_module #58
• Remove insertUI in the teal::init teal#669

Let's plan for a release of teal framework packages. We will handle teal modules packages release after this.

Release candidate:

• [CRAN Release]: 0.3.0 teal.logger#94
  • teal.logger v0.3.0 (log_shiny_input_changes)
• teal.reporter v0.4.0 (Archiver Module)
• teal.code v0.6.0 (introduce names to qenv)
• teal.widgets v0.5.1 (several bug fixes)
• teal.data v0.7.0 (deprecate datanames)
• teal.slice v0.6.0 (insertUI)
• teal.transform v0.5.1 (minor code update)
• teal v0.16.0 (teal_transform_module, insertUI)

Blockers

teal.data

• [Feature Request]: Don't use @datanames anymore teal.data#333
• [Feature Request]: Implement names argument in get_code to subset code for specific objects. teal.code#210
• [Feature Request]: "subset" method for qenv object teal.code#211
• Update Vignette due to datanames updates teal.data#338

teal/teal.slice

• [Potential release blocker] R CMD CHECK NOTE: sub-directories of 1Mb or more: teal#1391
• The documentation of check_modules_datanames() is incorrect teal#1321
• [Bug]: functions in data raise warnings teal#1352
• Forbid teal_transform_module to have datanames = "all" teal#1347
• [Feature Request]: Consider set_datanames to support negative selection. teal#1380
• Modify print of modules/module to contain more information teal#1378
• Warn when data contains an object named "all" teal#1379
• [Bug]: Teal app crashes when the input teal_data has objects that fail check_simple_name() teal#1366
• Request for renames in teal_data_module teal#1323
• [Feature Request]: Does it make sense to create dataset for a module in a transform module teal#1271
• Move landing popup feature back to the modules argument teal#1310
• Resolve all "TODO:" in the codebase teal#1312
• [Question]: Should teal codebase use magrittr teal#1268
• Guidelines around lifecycle::badge in teal packages #86
• [Feature Request]: Move from crayon to cli teal#1417

Deprecation activity

• Review Deprecated Functions teal#1386
• Review Deprecated Functions teal.code#215
• Review Deprecated Functions teal.data#344
• Review Deprecated Functions teal.slice#623

Deprecation activity

Make sure all CI pipelines are green before release (i.e. Scheduled pipeline, etc).

[m7pr]

I think we should do some manual testing on teal.gallery or/and tlg-catalog just in case.
Also review if all pipelines/workflows are green once we release (or before we release).

[m7pr]

@donyunardi should we revisit packages for soft deprecated functions and hard deprecate them? Also, for the hard deprecated functions, should we delete them? For example, should we delete all those teal.data functions that got hard deprecated 9 months ago ? https://github.com/insightsengineering/teal.data/blob/main/R/deprecated.R

[donyunardi]

Yeah, good idea. Let's review the deprecated functions in all packages.

For example, should we delete all those teal.data functions that got hard deprecated 9 months ago

I would say yes, 9 months ago is a reasonable time for us to remove this.

[m7pr]

@donyunardi @kumamiao what do you think about planning a community meeting with the summary of what got changed during the release? We could record and put that on YouTube and also include the link to the video in the release notes?

[donyunardi]

Sure, I'm open for it. 👍🏼

[donyunardi]

I think we should do some manual testing on teal.gallery or/and tlg-catalog just in case.

I believe our shinytest2 implementation on teal frameworks and modules covers most of the key areas, but I'm open to doing minimal tests on teal.gallery. For tlg-catalog, I need a better understanding of what requires manual testing.

@m7pr, since you were involved in the shinytest2 implementation, could you help outline any gaps where manual testing is needed for both teal.gallery and tlg-catalog before the release?

Also review if all pipelines/workflows are green once we release (or before we release)

Yes, let's make sure this happens.

[kumamiao]

@donyunardi @kumamiao what do you think about planning a community meeting with the summary of what got changed during the release? We could record and put that on YouTube and also include the link to the video in the release notes?

Sure sounds good, was thinking the same as it's been a while since the last one. I'll be out Nov - Jan, so I was thinking sometime in Jan may be a good timing (assuming this will be aligning with the release timeline - right after the release?), but let's also see how the release work goes.