Release workflow for the Tracking CTV

[basille]

There are two types of releases, the rolling release and checked releases.

Rolling release

• Rolling release essentially accounts for quick-and-easy fixes in between heavier checked releases : Only CRAN and Bioconductor packages are added (as they are already checked), or removed (when archived).
• Rolling releases live in the main branch, and are automatically published from the Tracking.md file.
• The version is the ISO date of the automatic publication.
• The trigger event of a new rolling release is typically a new package submission.

To-do list for rolling releases, upon each new package submission:

• Evaluate the submitted package against the scope criteria.
• Add the package to Tracking_tbl.csv
• For new CRAN/Bioconductor packages, add a description in the relevant section of Tracking.md
• For new CRAN/Bioconductor packages, add a line to the NEWS.md file in New packages section for the next checked release (see template below).
• For packages declined due to scope criteria, add a line to the NEWS.md file in Declined submissions section for the next checked release (see template below).
• For non-CRAN/non-Bioconductor packages that fall within the scope, reply in the submission issue that the package is considered for the next checked version.
• Close the GitHub issue for the submission.

In addition:

• Check archived packages.

Checked releases

• Checked releases are thoroughly tested and complete updates, including new non-CRAN/non-Bioconductor packages, removal of packages,
• Checked releases live in the dev branch, and are only published when merged back to main.
• The version is the ISO date of the automatic publication, but the Tracking CTV (automatically) indicates the date of the last checked release.
• The trigger event of a new checked release is the manual initiation of the process by one of the maintainers, ideally twice a year.

To-do list for checked releases, when full tests are to be run:

• Open a new issue to track the process (see this example).
• Publish a rolling release (see above).
• Branch out from main into dev.
• Check all open issues for package submissions, and make sure submitted packages are sorted out and included in Tracking_tbl.csv
• Run the full tests
• Complete the NEWS.md file fully (see template below)
• Complete and close all open issues.
• Fully update Tracking.md with new and removed packages.
• Merge dev back into main and delete the dev branch.

NEWS.md template

For rolling releases, drop the summary paragraph on top, and only fill in the relevant sections (packages added from CRAN/BioConductor, packages declined, packages removed because they were archived).

Tracking CTV 2025-02-01 // or Tracking CTV rolling release

X packages were submitted this round. The Tracking CTV now lists Y tracking packages,
including Z core packages: [pkg](CRAN URL), …

Packages added to the tracking CTV

J newly submitted packages:

• [pkg](package URL): Description ([documentation](doc URL))

K packages previously submitted and now passing CRAN checks:

• [pkg](package URL): Description ([documentation](doc URL))

Packages submitted but not added to the tracking CTV

L packages that did not fit the definition of a tracking package for the CTV:

• [pkg](CTV issue): Short explanation why

M packages that did not pass CRAN checks:

• [pkg](CTV issue): Short explanation why

Check the links to the submission threads to find details for each package.

Packages removed from the tracking CTV

N packages removed because they were archived or did not pass CRAN checks
anymore:

• [pkg](CTV issue): Short explanation why

Check the links to the submission threads to find details for each package.

[rociojoo]

Agreed!

[basille]

Versioning not allowed for CTVs, ISO date must be used for the version number. Initial post updated accordingly.

[basille]

Moved to WORKFLOW.md for smoother tracking.