Proposal: Please start using Semantic Versioning

[KateGo520]

I found that this project already supports Go modules. But sadly, the tags doesn't follow Semantic Versioning, which means that all tags of this project will be ignored by Go modules and replaced by pseudo-versions, go get acts weirdly when tags are not in that form. It would be great to have the tagged release be named in the format vX.X.X format so that go mod can read it.

	github.com/elazarl/goproxy v0.0.0-20200710112657-153946a5f232

Else the mod file shows something like github.com/elazarl/goproxy v0.0.0-20200710112657-153946a5f232 which is not very readable and difficult to upgrade. It’s hard to verify which version is in use. This is not conducive to version control

So, I propose this project to follow Semantic Versioning in future versions. For example, v1.0.1, v2.0.0, v3.1.0-alpha, v3.1.0-beta.2etc.

[KateGo520]

@kimor79 @n-i-x Could you help me review this issue? Thx :p

[elazarl]

Sounds great to me. This project predates go modules, and tags were supposed to support some primitive versioning by HTTP redirect. There were times...

[KateGo520]

@elazarl Thank you for your reply and look forward to a new version for module. : D

[elazarl]

@KateGo520 can you help me with how to set version to the submodule ext/?

[wolfogre]

@elazarl If there is any problem with how to set version to the submodule, you can find how "golang/tools" do it: https://github.com/golang/tools/tags

Semantic versioning is so important for go modules, sorry to trouble you but could you please speed this up?

[detro]

Given how actively supported and widely adopted this project seems to be, I'd love to see some semantic versioning. It does make for a more ergonomic experience, as well as it deliver a sense of "craftmanship" superior to go.mod lines like:

github.com/elazarl/goproxy v0.0.0-20220328115640-894aeddb713e

So, big support for this issue.

[elazarl]

@detro sounds a very good idea.

[detro]

Hey @elazarl are you looking for a contribution to do this or am I missing something? :)

[elazarl]

@detro a PR would be awesome. I'm unfotunately very limited in the time I can invest, but I'm happy to review and merge PRs.

[JanneKiiskila]

This one probably cannot be covered via PRs @elazarl , the tag injection is done directly via git tag -commands as far as I'm aware, so someone with repo write access could do it.

[jeffwidman]

To bump this again, @elazarl this requires a maintainer.

If you aren't quite sure how to do this, I'm happy to volunteer to help... we use this project at my day job, so it's easy for me to justify spending a little time to help maintain the project.

I helped another open source go library switch to modules here: https://github.com/vishvananda/netns/releases

I think once you've seen it done a time or two it'd be easy to understand how it works and handle it going forward if you want.

[elazarl]

I'll be happy for a PR and guidance. Thanks

…

On Fri, Jul 26, 2024, 19:48 Jeff Widman ***@***.***> wrote: To bump this again, @elazarl <https://github.com/elazarl> this requires a maintainer. If you aren't quite sure how to do this, I'm happy to volunteer to help... we use this project at my day job, so it's easy for me to justify spending a little time to help maintain the project. I helped another open source go library switch to modules here: https://github.com/vishvananda/netns/releases I think once you've seen it done a time or two it'd be easy to understand how it works and handle it going forward if you want. — Reply to this email directly, view it on GitHub <#394 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAB7RIXDNYNH6EMRIR6Y3UDZOJ4XNAVCNFSM6AAAAABLQ3DYH2VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDENJTGEZDQOBSGY> . You are receiving this because you were mentioned.Message ID: ***@***.***>

[JanneKiiskila]

https://semver.org/ is a good introduction.
Essentially:

• major version is bumped, if any incompatible API-changes are done.
• minor version is bumped, if any new features are added (can include also fixes - depends on release rate).
• patch version is bumped, if things are fixed.

v1.0.0 is usually considered the 1st stable release.

[jeffwidman]

@elazarl as noted above, this is not something that happens via PR's... it happens via Git tags which requires write access to the repo.

As I said, I'm happy to show how to do this, but you'll need to either give me write permissions on the repo (aka make me a temporary maintainer), or we can do a video call where we screenshare and I walk you through what you need to do.

Happy to help, let me know what you'd prefer.

[jeffwidman]

Gentle nudge on this. Feel free to email me directly--my email is in my GitHub profile.

[rgoltz]

Now, it's start using the offical (GitHub)-release-tags. Here is a local test:

go get github.com/elazarl/goproxy@latest
go: upgraded github.com/elazarl/goproxy v0.0.0-20240726154733-8b0c20506380 => v1.2.5

Also the https://pkg.go.dev/github.com/elazarl/goproxy?tab=versions started using the offical release-versions:

[jeffwidman]

@ErikPelli I think this can be closed now?

BTW, I work on the team at GitHub and we use this library internally as part of ... thanks for all your recent hard work on this project... I personally help maintain multiple open source libs myself, so I understand/appreciate all the work that goes into doing that.

[ErikPelli]

Hi @jeffwidman, thanks for the good words, I see you are enjoying Ruby in dependabot project, I've used it with Rails in the past, but I prefer to use Go eheh.

Yup, I'll soon close this issue, since we officially started to use semantic versioning in this project.
It's a pleasure that Dependabot/Github itself uses this open source project, I joined some months ago, after it has been stale for a while, and I have merged a bunch of pending fixes and updates (and some more are still pending).
I've seen that you opened some pull requests, thanks, I'll look at them soon! Any help is always appreciated!

As you said, open source is a great hobby, which has a real impact on others, and I'll continue to maintain this project for the sake of it.
Unluckily it doesn't pay the bills: I'm still searching for contract jobs (b2b) where I can provide Go software development expertise, if you (or anyone else) know someone in their networks that can be interested, let me know!

[jeffwidman]

Thanks for the heads up. I'll pass the word around.