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

Should we tag 1.0 soon? #84

Open
mholt opened this issue Feb 19, 2022 · 9 comments
Open

Should we tag 1.0 soon? #84

mholt opened this issue Feb 19, 2022 · 9 comments
Assignees

Comments

@mholt
Copy link
Member

mholt commented Feb 19, 2022

Any other outstanding issues before we tag v1.0.0?

@aabelix
Copy link
Contributor

aabelix commented Aug 16, 2022

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

@aabelix
Copy link
Contributor

aabelix commented Aug 22, 2022

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

This requested was rejected by #111.

@mholt
Copy link
Member Author

mholt commented Aug 26, 2022

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

@coolaj86
Copy link
Contributor

coolaj86 commented Oct 24, 2023

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

adding an embed feature before 1.0

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

@mholt
Copy link
Member Author

mholt commented Oct 24, 2023

I forgot about this issue 😆

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 mholt self-assigned this Oct 24, 2023
@coolaj86
Copy link
Contributor

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?

@francislavoie
Copy link
Member

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

@coolaj86
Copy link
Contributor

coolaj86 commented Oct 24, 2023

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.

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

No branches or pull requests

4 participants