Support prerelease + final release flow #237

miniscruff · 2022-02-16T17:55:34Z

miniscruff
Feb 16, 2022
Maintainer

Discussed over here dbt-labs/dbt-core#4722 the idea is to allow the possibility of doing N releases that get merged at once later on down the line while keeping the releases in place until then.
Eg: beta1, beta2, rc1, rc2 -> 1.0 combines all the previous

Currently this is sort of possible using --keep on batch commands, then moving the prerelease yamls to a separate directory, then when the final is ready, deleting all the prerelease versions, moving the yamls back to unreleased, and running batch normally. This is super clunky and can be solved much better.

First, --move option to batch that will, instead of deleting or keeping, move the files to a new directory under changies parent. If the directory does not exist already it will be created.

Second, --include option which allows adding other directories to the batch command, in addition to unreleased.

Third, --remove-prereleases will delete any versions that include prerelease metadata according to semver. This option should be skipped if you want to include both prerelease changes and the final changes together.

Fourth, add an option to next for creating versions with metadata and prerelease info. --pre b1 --meta <git hash>, these two options should be included in batch as well.

Combined this would look like:

changie batch v1.5.0-b1 --move=prerelease
changie merge # optionally if you want to update the parent changelog for prereleases
changie batch minor --pre b2 --move=prerelease
changie batch v1.5.0-rc1 --move=prerelease
# include our prereleases.
# remove the batched versions as they are now merged together.
# do not include remove-prereleases if you want them to be included 
# as part of your changelog, in addition to the changes being part of the final version.
changie batch minor --include=prerelease --remove-prereleases
changie merge # update our parent to our final version

@emmyoop here is the issue, I will get started on this soon. ( It might turn into multiple issues not sure )