Version's sections are restricted

[mindsers]

Version's sections are restricted

[mindsers]

Hi @SwabianCoder, it should be deployed and ready now.

[mindsers]

@SwabianCoder Thanks for taking the time to open this issue to find solution. We'll need time to think about this and understand how the community uses prerelease versions. If you have documentations to share about the topic, do not hesitate to paste them in this discussion feed.

[SwabianCoder]

@mindsers I just checked the sample changelog on Keep a Changelog website. All versions listed there could e.g. have an added section.

After seeing the sample changelog on their website I was a bit wondering why your having this has-correct-sections.js file in your repository.

As an idea: what about making correct sections configurable?

[SwabianCoder]

@mindsers E.g.:

validate_allowed_sections: true | false
Default: true

[mindsers]

I just checked the sample changelog on Keep a Changelog website. All versions listed there could e.g. have an added section.

After seeing the sample changelog on their website I was a bit wondering why your having this has-correct-sections.js file in your repository.

We do not have it because of Keep a Changelog but because of Semver:

[SwabianCoder]

@mindsers Then may the prerelease section restriction should be removed because SemVer docs don't really tell how to use prereleases.

[mindsers]

After looking at how the semver package works :

diff(v1, v2): Returns difference between two versions by the release type (major, premajor, minor, preminor, patch, prepatch, or prerelease), or null if the versions are the same.

It seems that the generic “prerelease” is returned only when two prerelease versions of the same version are compared. This remove the information about “what type of prerelease” are compared (prepatch, preminor, premajor).

The action's code currently acts as a prerelease is always a prepatch, which is wrong and leads to this false positive in the check. Until I found a better and more accurate solution, I propose to treat the prerelease as a premajor which is the less restrictive check.

[mindsers]

@all-contributors please add @SwabianCoder for bug

[allcontributors]

@mindsers

I've put up a pull request to add @SwabianCoder! 🎉

[SwabianCoder]

@mindsers Thanks a lot for fixing this behavior! When do you release a new version containing this bugfix? I'm currently blocked with further development of my open source projects due to this bug.