version tagging

[tommens]

@mehdigolzadeh, could you add git version tags to the respective commits of BoDeGa that correspond to a specific version? It will be easier to keep track of which version is being used, or to keep track of bug reporting that may be for a specific version. Currently, I have not seen any way of knowing which version of BoDeGa is being used.

I would therefore suggest:
(1) to use git version tags whenever a new version is becoming available;
(2) to add the version number information in the bodega tool (when you run it, or ask for help with bodega -h or perhaps even bodega --version, it could report the version number)
(3) mention the version number in the readme file, and update this version number each time a new version is becoming available.

[tommens]

I noticed that we have our first tagged and released version marked as such on the GitHub repository (0.2.2), which is good. The current README file, however, mentions 0.2.3, and I do not find this tag yet, can you add it as well?

[mehdigolzadeh]

Not all versions require tag. I think its better to tag stable versions.

[tommens]

So how will you manage if someone downloads and installs the current (untagged) version, which is 0.2.3 I guess, and has an error that he wants to report to you? If the version number is not known (the readme will only shown whatever latest version that is available I guess) it will be difficult to keep track of things. Unless if you already also integrated version information as part of the CLI interface of bodega, using e.g. bodega --version or something like this. In that case, anyone using the tool will be able to know exactly which version it is and can use this during the reporting. If this is not yet available from within the CLI interface, I suggest you add it there. Tom Mens From: mehdigolzadeh <notifications@github.com> Reply to: mehdigolzadeh/BoDeGa <reply@reply.github.com> Date: Thursday, 3 September 2020 at 10:48 To: mehdigolzadeh/BoDeGa <BoDeGa@noreply.github.com> Cc: Tom MENS <Tom.MENS@umons.ac.be>, Author <author@noreply.github.com> Subject: Re: [mehdigolzadeh/BoDeGa] version tagging (#3) Not all versions require tag. I think its better to tag stable versions. — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub<#3 (comment)>, or unsubscribe<https://github.com/notifications/unsubscribe-auth/AB7EQL2CWVRS6QYPT5C3O2TSD5J3XANCNFSM4QQRWK5A>.

[AlexandreDecan]

There are two possibilities:

1. Keep the master branch stable, always, and do the development on a new branch (e.g. "devel"). As such, the master will always be the latest stable version available. Only increment the version number when you merge devel into master.

2. Do the development on the "master" branch, and tag each stable release (= each time a new, non pre-release, version number is defined in setup.py). Only use pre-release numbers for non-stable releases (e.g 0.2.1-a1, 0.2.1-a2, etc.). For convenience, add a "latest" tag on the latest stable release, and add this tag in the installation instructions (so that the latest stable version will always be installed if someone execute these instructions, instead of the latest commit by default).