Set up proper release version system about galgebra

[utensil]

It would be awesome to use https://probot.github.io/apps/release-drafter/ and follow the convention in it so the release notes can be drafted if we properly maintain the titles and labels of PRs

Probot

Release Drafter

Drafts your next release notes as pull requests are merged into master.

[waldyrious]

Another option would be to use python-semantic-release, which automatically determines a SemVer release type based on the messages of the commits included in it — and perhaps semantic-pull-requests or some other tool to enforce commit messages following a given standard (commitizen, commitlint...).

Disclaimer: I haven't used these tools myself.

[utensil]

Yeah, I'm aware of semantic release but I have some concerns about using these convention-enforcing tools. They impose the restrictions to the level of every commit (of contributors) to serve the need of release note drafter which is not friendly to new comers and it require setting up such commit message linters before commits which add more burdens to contributors and is time-consuming for PR reviewing process. Also the commit logs are immutable in nature compared to changeable PR titles and labels after the merge and before the release thus they don't serve the release note drafting purpose very well.

All these concerns and given the immatural status of galgebra (compared to large community-driven open source projects), I will lean towards a more lightweight option such as the conventions in Release Drafter.

[waldyrious]

Fair points. 👍

[utensil]

Tried https://probot.github.io/apps/release-drafter/ on a test repo here, it looks like this:

Probot

Release Drafter

Drafts your next release notes as pull requests are merged into master.

[utensil]

I finally decided to use https://releases.readthedocs.io/ to maintain a Changelog manually as part of the source of GAlgebra for now because GAlgebra has not reached a point that would require such automatic mechanism and hand-written Changelog contains more details and is better organized.

Releases — Releases documentation

[eric-wieser]

Is there anything else to do here?

[utensil]

No, it's already done as https://releases.readthedocs.io/ is now very much alive a part of the maintenance of GAlgebra.

Releases — Releases documentation