jToxKit versioning - Githubissues

ideaconsult / Toxtree.js

http://ideaconsult.github.io/Toxtree.js/

2 stars 3 forks source link

jToxKit versioning #192

Closed vedina closed 7 years ago

vedina commented 8 years ago

Could we introduce versioning for jToxKit ? @thejonan , @gonzomir - proposals welcome.

gonzomir commented 8 years ago

What do you mean by versioning? If you mean support two or more versions in parallel, we can create branches for each version and merge only fixes to the old versions and new features to the one in development. If you mean realising versions of jToxKit, we should look ad Github Releases: https://help.github.com/articles/creating-releases/ https://github.com/blog/1547-release-your-software

vedina commented 8 years ago

No, I mean being able to say this is jToxKit version 3.14 .

With Java we are using Apache Maven, where the version is specified in the build system (semantic versioning, i.e. 3.0.2). Each release is a different x.y.z (usually incremental in some reasonable manner). Creating releases in GitHub is quite easy and not entirely related. What I mean is supporting versions in the build system and being able to identify the release once the jToxKit.s is included in a page.

For example we can create a GitHub release from any jToxKit tag, but once a release is downloaded it will not be straightforward to figure out which tag it was, purely from the js code.

gonzomir commented 8 years ago

Got it, then maybe a version property on the jT object (and possibly on every kit). We will have to remember to bump the version number when releasing or find a way to automate it.

thejonan commented 8 years ago

Hm... yes - a property in jT object is definitely a good choice. Whether we need versions of submodule is related also to (1) the testing system, we're about to integrate at some point, and (2) how independent the separate kits are. I don't think they are, or will ever be - let's keep in mind that ui_XXX things are not part of the kit, but it's use cases.

What I'd suggest is the following:

I can change the building script so that, if given a version string, it appends it to the packages' js files and also makes a git tagging.
This can later be integrate into automated testing platform.

thejonan commented 8 years ago

I've added corresponding property and altered the building script to extract the value from there and append it to output files (.js and .css). No automatic changes on git are performed, however. This can happen when integrate along with some unit testing kit.

vedina commented 7 years ago

Not completely solved, but moved to https://github.com/ideaconsult/jToxKit/issues/32