Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Track new releases / updates? #124

Closed
WouterJD opened this issue Nov 3, 2020 · 5 comments
Closed

Track new releases / updates? #124

WouterJD opened this issue Nov 3, 2020 · 5 comments
Labels
enhancement New feature or request implemented

Comments

@WouterJD
Copy link
Owner

WouterJD commented Nov 3, 2020

Question: How can I keep track of new releases / updates?
I've installed version 3.3, and now I read 3.4 is out.
Is there a way to know this, and are there releasenotes somewhere?
As an IT-er I'd like to know what has changed and when to update.

Originally posted by @kwouters1 in #14 (comment)

@WouterJD
Copy link
Owner Author

WouterJD commented Nov 3, 2020

Nice suggestion for next version

@WouterJD WouterJD added enhancement New feature or request under investigation Being studied for implementation in next version labels Nov 3, 2020
@orrmany
Copy link

orrmany commented Nov 3, 2020

Well, the usual ways is as follows:

  1. use branches in your repo(sitory). Use the "master" branch in your repo for released versions only. Create (a) "development" (dev) branch(es) from the latest released-version (i.e., from the master/HEAD version). Do the development on the dev branch(es).
    2.. Whenever you do make a new release, then merge (all) the dev branch(es) o be released back to the master in a single step. Label the new master/HEAD with the release version number. Use of Semantic Versioning is highly recommended.
  2. include a (version controlled) Release Notes document into the repository. Whenever you make a new release (i.e., new version in master branch) update the Release Notes accordingly. With the above scheme and with proper git commit-comments the Release notes comments can be generated semi-automatically from git history listing.
  3. Prior to release merge back to master. After release you can/should branch out to development again.

This way the "stable/released code" is on the master branch, your users are supposed to use only that one. During your development you should checkout the dev branch and commit there frequently, even the half-baked code. Comment the commits extensively for the purpose of easing the content creation for the Release Notes.

@WouterJD
Copy link
Owner Author

WouterJD commented Nov 3, 2020

What I seek -and will implement- is that a user is informed by FortiusANT that a new version is available (without checking github himself).
In next version😉

@switchabl
Copy link
Contributor

Ah I see, I would only ask that you don't make it into a pop-up, I usually find those annoying. And when I set up the trainer, I probably don't want to download an update right now, I will likely do it after training.

The easiest way would probably be to add a VERSION file to the Github repo and download that on launch and compare it to the current version?

Some of @orrmany 's suggestions, while good practice in general, may be unnecessary for a relatively small project. Still, at least tagging the releases in git (and creating Github releases for them) would be quite nice.

@WouterJD
Copy link
Owner Author

WouterJD commented Nov 4, 2020

Implemented in version 3.5, to be published shortly.

@WouterJD WouterJD closed this as completed Nov 4, 2020
@WouterJD WouterJD added implemented and removed under investigation Being studied for implementation in next version labels Nov 5, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request implemented
Projects
None yet
Development

No branches or pull requests

3 participants