hackoregon / backend-examplar-2018

an example dockerized geo-aware django backend
MIT License
4 stars 5 forks source link

Always use the verbose version of command-line parameters, where available #52

Closed MikeTheCanuck closed 6 years ago

MikeTheCanuck commented 6 years ago

As I'm reviewing the env var usage from 2017 projects, I noticed that in this script: https://github.com/hackoregon/team-budget/blob/master/budget_proj/bin/ecs-deploy.sh

you can call command-line parameters as the verbose or compact versions e.g.

When reviewing the usage of command-line parameters in our scripts (and others), I have always found it much more readable to see the expanded version of a parameter than the compact version.

In this particular case, for example, I had always glossed past our usage of these parameters in the docker-push.sh script - and never quite felt confident that I knew what that script is doing. Now that I see the expanded names of these parameters, it becomes much clearer to me what we're really doing here.

I know this approach isn't everyone's preference so I'd like to discuss it here if possible.

znmeb commented 6 years ago

I'm in favor of verbose options - readability trumps brevity (at least until you get to a line so long the shell croaks).

BrianHGrant commented 6 years ago

Ditto, assume if line gets too long you could use the '/' to split up?

This is why I opted for the gunicorn.py config instead of a single unintelligible command

We should look at docker commands to march this pattern as well.

znmeb commented 6 years ago

Yeah - right now I'm looking at the examplar to see how much of the setup code I can move into the create / build steps. If it only has to be done once it ought to be possible to do it in the Dockerfile.

MikeTheCanuck commented 6 years ago

OK, so the work here is to expand the shortened flags in /bin/deploy.sh: https://github.com/hackoregon/backend-examplar-2018/pull/60/files#diff-01dd223246b3d82a911250aceaac85b5

nam20485 commented 6 years ago

Is this close-able now? Or are there still areas where we need to replace the shorthand command with the verbose ones?