Usage of expectedLatestVersion

[miparnisari]

Hi, I don't understand the docs in https://github.com/dangoslen/changelog-enforcer?tab=readme-ov-file#expectedlatestversion. It's not clear to me what this field does, or what the default behavior is.

If I want to enforce that every PR must add a new entry under the unreleased section of the changelog, then should I specify expectedLatestVersion: 'unreleased'? Why would i ever add an entry under a fixed version? 🤔

[dangoslen]

Hi @miparnisari!

Thanks for the question. The use case of this option is mostly that someone doesn't accidentally get versions out of order. It is more of a sanity check more than strong validation.

This action doesn't enforce that you only update a specific version, sadly (though that might be a good feature to add!). The intention is more of a reminder to teams to pay attention to their changelog and to keep it up-to-date.

In your use case, leaving the option empty will allow the Unreleased section to be the first version listed. The use case of Unreleased itself allows for "building" a release over a set of changes rather than stating ahead of time which version it will be. Different flows have different patterns, but this allows for teams to choose which ones they want.

[miparnisari]

Ohhh I see. Thanks for the explanation!

Then this ticket should be changed to "enhancement", I'd love to have the feature I described.