Release teal and modules in GitHub

[donyunardi]

Summary

This is continuation of insightsengineering/teal.code#100

A new feature called qenv is being introduced with the release of teal.code.
We also implement the changes to the teal modules and framework here and here.

We are ready to release the rest of teal packages.

Important

Since we're releasing the modules as well, then we also have to release any affected packages that's related with shinyvalidate tasks here

Packages to be released

• teal
• teal.widgets
• teal.slice
• teal.transform
• teal.data
• tmg
• tmc (check if tern is good to go)
• goshawk + teal.goshawk
• osprey + teal.osprey
• hermes + tmhermes
• helios + tmhelios

Order of releases

1. teal, teal.widgets, teal.slice, teal.transform, teal.data
2. tmg + tmhermes + hermes (?)
3. tmc
4. goshawk + teal.goshawk
5. osprey + teal.osprey
6. helios + tmhelios

Tasks

• Consult with the team to identify any obstacles or blockers preventing the releases
  • Check with Statistical Engineering (helios, hermes) and SME (tmc + tern)
• Review all packages documentation, including roxygen, examples, and vignettes, to confirm that it is up-to-date and that the code examples are functioning correctly
  • Review teal documentation before release teal#815
  • Review teal.widgets documentation before release teal.widgets#148
  • Review teal.transform documentation before release teal.transform#125
  • Review teal.slice documentation before release teal.slice#238
  • Review teal.data documentation before release teal.data#142
  • Review tmg documentation before release teal.modules.general#521
  • Need to create issues for tmhelios, tmhermes, tmc upon confirmation
• run integration test (scribe) before performing each release
  • insightsengineering/idr-tasks#531
  • Need to create issues for rest of releases
• Review tests coverage, add new tests if needed (Do we need this? Up for discussion)
• Conduct testing on all sample applications available on teal.gallery
  • This can be done using the public apps URL on teal.gallery since the apps are sourced from the main branch
• Release products
  • Release teal, teal.data, teal.widgets, teal.slice, teal.transform #24
  • More releases

[asbates]

Releasing teal.goshawk and teal.osprey requires release of goshawk and osprey I believe. Likewise with tmhelios I presume.

Regarding testing of teal.gallery apps, I don't think that will be sufficient? I would recommend going through and making sure any packages that are to be released are used in teal.gallery. tmhelios probably isn't for example.

[asbates]

I also recommend removing anything deprecated (e.g. chunks). I think it would be confusing for users if they install a new CRAN package and it has deprecation warnings.

[donyunardi]

Releasing teal.goshawk and teal.osprey requires release of goshawk and osprey I believe. Likewise with tmhelios I presume.

That's a valid point, and most likely true for helios. As for goshawk and osprey, I don't see if there's any impact if we don't release them. I could be wrong and could use another set of eyes. Regardless, I will add it to our plan.

---

Regarding testing of teal.gallery apps, I don't think that will be sufficient? I would recommend going through and making sure any packages that are to be released are used in teal.gallery. tmhelios probably isn't for example.

We're just conducting a quick check to ensure that everything is functioning properly, given that we have a URL that's accessible to the public. We're currently reconsidering how we can enhance teal.gallery, so it might be best to hold off on including tmhelios in the list of sample applications for the time being.

---

I also recommend removing anything deprecated (e.g. chunks). I think it would be confusing for users if they install a new CRAN package and it has deprecation warnings.

Upon inspection, I see that we're still using chunks in teal.transform:
https://github.com/insightsengineering/teal.transform/blob/c07e7505b9c9b0222a2e933382f90381afdfd1b1/R/data_merge_module.R#L267-L276

We probably need to update this first before completely removing chunks from teal.code.
Once everything is taken care of, we can release teal.code again and remove chunks completely.
I will add a generic topic on the CRAN release card to remove all soft-deprecated functions.

[asbates]

Releasing teal.goshawk and teal.osprey requires release of goshawk and osprey I believe. Likewise with tmhelios I presume.

That's a valid point, and most likely true for helios. As for goshawk and osprey, I don't see if there's any impact if we don't release them. I could be wrong and could use another set of eyes. Regardless, I will add it to our plan.

teal.goshawk depends on goshawk and teal.osprey depends on osprey. So I don't see why we would release the teal packages but not the packages they depend on. I'm not even sure if CRAN allows that.

[donyunardi]

Because of these two PRs that affects update in both teal.data and teal.slice, we need to release teal.data as well:
insightsengineering/teal.data#120
insightsengineering/teal.slice#169

I will include teal.data in Release 1.

[donyunardi]

Due to my finding here: https://github.com/insightsengineering/idr-tasks/issues/540#issuecomment-1553992381
We have to release tmhermes after release 1.
OP updated.

[donyunardi]

Release 1 is completed.
We will move with teal modules in #25 for the next increment.