-
Notifications
You must be signed in to change notification settings - Fork 12
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
Added semantic versioning #235
base: main
Are you sure you want to change the base?
Conversation
✅ Deploy Preview for axelerant-engg-handbook ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
decision: "We will adopt semantic versioning for naming our releases" | ||
status: "accepted" | ||
categories: | ||
- "Processes" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@hussainweb not sure why this is not picking up in the catgories in main page. Is there somewhere else we need to add?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It should, based on my understanding of the templates. Let's merge this and we can look into that.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ok
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Now it is not showing in listing as well. Not sure if due to changed as Proposed.
https://deploy-preview-235--axelerant-engg-handbook.netlify.app/adr/adopt-semantic-versioning/
@@ -0,0 +1,42 @@ | |||
--- | |||
title: "Adopt semantic versioning for releases" | |||
date: "2022-04-13" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Let's fix the date.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@hussainweb Actually this is the date I intentionally gave. Also gave context in description
decision: "We will adopt semantic versioning for naming our releases" | ||
status: "accepted" | ||
categories: | ||
- "Processes" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It should, based on my understanding of the templates. Let's merge this and we can look into that.
|
||
## Alternatives Considered | ||
|
||
We considered an alternative were we have a indicator (e.g. prefix like `feature`) to start with that denotes whether the release is a Continuous Development/Feature release or Maintenance release. However since we also combine both feature development and maintenance fixes as one release we would need one version label that conveys both. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
How about the alternative of using date as the version indicator? For example, v20250124
for a version released today. Subsequent releases in the same day can be hyphenated, e.g. v20250124-2
.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We use the version number when communicating with clients verbally and clients also collaborate (or at least view) in our JIRA Releases board. The reason I am bit hesitant on this is because it might be difficult to convey verbally whereas it is a good method for tagging purposes.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Added above as alternative as well
Co-authored-by: hussainweb <[email protected]>
Co-authored-by: hussainweb <[email protected]>
Context on Date: https://axelerant.slack.com/archives/C013V5LQ58W/p1649827056902959?thread_ts=1649401879.229919&cid=C013V5LQ58W
Earlier document we had and archived: https://axelerant.atlassian.net/wiki/spaces/ASD/pages/3624435716/Release+versioning