Skip to content

[FEATURE] make Consul.NET versioning independent of Consul versioning#586

Open
MohamedM216 wants to merge 19 commits intoG-Research:masterfrom
MohamedM216:independent-consulnet-versioning
Open

[FEATURE] make Consul.NET versioning independent of Consul versioning#586
MohamedM216 wants to merge 19 commits intoG-Research:masterfrom
MohamedM216:independent-consulnet-versioning

Conversation

@MohamedM216
Copy link
Contributor

Description

make Consul.NET versioning independent of Consul versioning

Related Issues

#541

Additional Context

Checklist

Please make sure to check the following before submitting your pull request:

  • Did you read the contributing guidelines?
  • Did you update the docs?
  • Did you write any tests to validate this change?

<Project>
<PropertyGroup>
<VersionPrefix>1.7.14.12</VersionPrefix>
<VersionPrefix>2.0.0</VersionPrefix>
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Just a random number greater than the latest version. @marcin-krystianc please let me know your thoughts.

Copy link
Contributor

Choose a reason for hiding this comment

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

I think 1.8.0 would be better (because we are not making any API/ABI breaking change so bumping the major version is not necessary).

@MohamedM216
Copy link
Contributor Author

@marcin-krystianc I've updated the PR to address the requested changes

Copy link
Contributor

@marcin-krystianc marcin-krystianc left a comment

Choose a reason for hiding this comment

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

Hi, few more comments. I've somehow forgot to submit them yesterday.

For example version `1.6.1.0` is going to be normalized to `1.6.1`. So to avoid problems, versions and tags with zero in the fourth part should be avoided and explicit three part version should be used instead.
**MAJOR.MINOR.PATCH**

The library version is independent from the version of Consul server. Consul's HTTP API is largely backward compatible, therefore different versions of Consul.NET may work with multiple Consul server versions.
Copy link
Contributor

Choose a reason for hiding this comment

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

I would add one more sentence with a historical context, e.g.:

"Historically, the project used four-component version numbers (e.g. 1.7.14.3) where the first three components matched a Consul server version. Starting with version 1.8.0, the project switched to standard three-component semantic versioning. Consul's HTTP API is largely backward compatible, therefore different versions of Consul.NET may work with multiple Consul server versions."

<Project>
<PropertyGroup>
<VersionPrefix>1.7.14.12</VersionPrefix>
<VersionPrefix>2.0.0</VersionPrefix>
Copy link
Contributor

Choose a reason for hiding this comment

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

I think 1.8.0 would be better (because we are not making any API/ABI breaking change so bumping the major version is not necessary).

@MohamedM216 MohamedM216 force-pushed the independent-consulnet-versioning branch from 4bfa571 to 00348ed Compare March 4, 2026 14:19
@MohamedM216 MohamedM216 force-pushed the independent-consulnet-versioning branch from 2bf8087 to f17f8e1 Compare March 5, 2026 14:36
README.md Outdated
[![Twitter Follow](https://img.shields.io/twitter/follow/oss_gr.svg?label=Twitter)](https://twitter.com/oss_gr)

[![Consul API: 1.7.14](https://img.shields.io/badge/Consul%20API%20version-1.7.14-red)](https://github.com/hashicorp/consul/tree/v1.7.14/api)
![Consul API](https://img.shields.io/badge/Consul%20API-supported-red)
Copy link
Contributor

Choose a reason for hiding this comment

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

I think that this badge does not add any value now, it is just a noise. I would remove it.

MohamedM216 and others added 5 commits March 10, 2026 06:17
Co-authored-by: Marcin Krystianc <marcin.krystianc@gmail.com>
Co-authored-by: Marcin Krystianc <marcin.krystianc@gmail.com>
Co-authored-by: Marcin Krystianc <marcin.krystianc@gmail.com>
Removed the Consul API badge from the README.
Co-authored-by: Marcin Krystianc <marcin.krystianc@gmail.com>
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.

3 participants