-
-
Notifications
You must be signed in to change notification settings - Fork 354
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
Phase out environment variables prefixed DRONE_, use WOODPECKER_ #209
Comments
Let's do it. It has been a maintenance pain. The main reason for keeping both prefixes is to ease the migration from Drone. While I've seen users migrating from 0.8, many of the new users are either coming from Drone 1.X, or new to Woodpecker completely. Let's drop |
How about using the occasion for these additional clean-ups?
IMO it would help to remove the guesswork and make the code more maintainable. |
... and rename |
It's best practice for many projects to prefix the env variables by the project name, so let's use WOODPECKER_. The xdg env variable should keep the name as it is. |
XDG_CACHE_HOME is a standard env variable name from freedesktop and it's only the base path where the let's encrypt certificates are stored. |
Currently (as of v0.13.0), every environment variable for configuring woodpecker seems to come in two flavours: One prefixed
DRONE_
and one prefixedWOODPECKER_
.The coexistence of these two versions of variables with identical meaning makes documentation, help text, and error messages hard to read (see my PR #208 for an example).
To improve the user experience, I recommend to make a decision regarding when to drop the
DRONE_
spelling and communicate that decision clearly.Since woodpecker is still in the v0.x.x major version realm, I would argue such a change could happen with any minor version bump.
The text was updated successfully, but these errors were encountered: