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

Added semantic versioning #235

Open
wants to merge 7 commits into
base: main
Choose a base branch
from
Open

Added semantic versioning #235

wants to merge 7 commits into from

Conversation

Copy link

netlify bot commented Jan 24, 2025

Deploy Preview for axelerant-engg-handbook ready!

Name Link
🔨 Latest commit bcbce41
🔍 Latest deploy log https://app.netlify.com/sites/axelerant-engg-handbook/deploys/679c87cbbed1e50008a9e07b
😎 Deploy Preview https://deploy-preview-235--axelerant-engg-handbook.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

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"
Copy link
Contributor Author

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?

Copy link
Member

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.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ok

Copy link
Contributor Author

@Kalaiselvan88 Kalaiselvan88 Jan 31, 2025

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"
Copy link
Member

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.

Copy link
Contributor Author

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"
Copy link
Member

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.

content/adr/adopt-semantic-versioning.md Outdated Show resolved Hide resolved
content/adr/adopt-semantic-versioning.md Outdated Show resolved Hide resolved

## 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.
Copy link
Member

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.

Copy link
Contributor Author

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.

Copy link
Contributor Author

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

content/adr/adopt-semantic-versioning.md Outdated Show resolved Hide resolved
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants