xcaddy icon indicating copy to clipboard operation
xcaddy copied to clipboard

Should we tag 1.0 soon?

Open mholt opened this issue 3 years ago • 9 comments

Any other outstanding issues before we tag v1.0.0?

mholt avatar Feb 19 '22 22:02 mholt

Totally! May I suggest including fix #112 that is required to support plugins for go compiler 1.17?

akeskimo avatar Aug 16 '22 10:08 akeskimo

Totally! May I suggest including fix #112 that is required to support plugins for go compiler 1.17?

This requested was rejected by #111.

akeskimo avatar Aug 22 '22 11:08 akeskimo

I might want to look into maybe adding an embed feature before 1.0, now that Caddy's file server supports embedded content.

mholt avatar Aug 26 '22 17:08 mholt

Tag v1.0 please. Telling people they need to install xcaddy@0 is... well, it looks bad.

v0 has no guarantees.

v1 has guarantees.

v2 and plenty of other numbers are available if those guarantees need to be broken.

🙇‍♂️

coolaj86 avatar Oct 24 '23 16:10 coolaj86

adding an embed feature before 1.0

That can wait for v1.1. New features are not-breaking and therefore valid for minor releases.

coolaj86 avatar Oct 24 '23 16:10 coolaj86

I forgot about this issue :laughing:

We can probably tag 1.0... breaking changes are just inconvenient for people. Most people use this as a CLI and not a library so a v2 is just more annoying since they'll download the latest and it'll work different, rather than a Go lib that locks in the major version. So I just wanted to minimize pain points.

mholt avatar Oct 24 '23 17:10 mholt

Adding a feature to a CLI is non-semver breaking. New flags, new subcommands, no problem.

The main point of versioning an CLI is that you can count on the flags and subcommands that you use to be available in your local scripts as well as ci build process.

So whether or not the embed feature is here now it won't break anything to add it later.

#amiright?

coolaj86 avatar Oct 24 '23 17:10 coolaj86

True, it wouldn't be breaking, but it does feel nicer to tag 1.0 when "feature complete".

francislavoie avatar Oct 24 '23 18:10 francislavoie

Documenting webi xcaddy@1 is easy and it will work even when v2 comes out.

Documenting webi xcaddy@0 is worrisome and unreliable.

Feature complete never happens except for very small projects (and rarely at that). This has already surpassed the ability to become feature complete. Stable is better than complete.

coolaj86 avatar Oct 24 '23 18:10 coolaj86