❔ Versioning for apps
I have been working on the same suite of apps for the last few years and have never had any versioning on the apps. I'd like to implement it now. I think using Jira's release feature and github branches for each release. I will create a release in Jira now 1.0.0 and start from that. It will cover all of the apps, so if I update our desktop app with a bug fix the version will just go to 1.0.1, then when I add a feature to the web app it will be 1.1.0, I guess 🤔
Does that sound about right or am I getting it wrong?
6 Replies
assuming you're talking about something like semver it sounds right:
realistically version numbers are whatever you want them to be
for some of my stuff the only thing i really need is an incrementing number and commit hash
Makes sense yeah. So like a new page that does not affect anything else would just be a minor version. I can't think of much that we do that is incompatible tbh. Most stuff is pretty standalone.
I could publish a release now that would only include removing a input from a form 🤔 that's not a bug fix but seems more minor than adding a page
@shemiroth It is a good idea to follow "semantic versioning" as much as possible, but even more than that I think these are even more important:
- consistency: if you make an "X" kind of change in one release then the next release you make "X" kind of change should have a similar approach to how the version number changes
- change log: have a detailed documentation of what all changed in each release. you don't need line numbers of code because you can always compare the code itself, but you want to have a lot of detail from a high level perspective
I was thinking that the Jira releases will include the tasks that were assigned to them. So that would be the change log or does it have be more focused on the code?
I'm not actually familiar with "Jira" so I can't answer that, but if you want some examples of good change logs I can find some on github and link them
Was this issue resolved? If so, run
/close - otherwise I will mark this as stale and this post will be archived until there is new activity.