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

consider re-naming the project from "Taskwarrior-installation" to "tw-install" #81

Open
linuxcaffe opened this issue Aug 7, 2021 · 4 comments
Labels
good first issue Good for newcomers

Comments

@linuxcaffe
Copy link
Collaborator

and then consider changing the main executable name from "main.sh" to "tw-install.sh", so that users will be able to invoke it with specificity.

@linuxcaffe
Copy link
Collaborator Author

linuxcaffe commented Aug 7, 2021

Whatever the main executable is called, I'd like to suggest some new behaviors, and modified usage;

  • usage tw-install [-y] [task] [taskd] [etc] | [list]
  • prompt for confirmations of all significant actions, like apt update, etc, unless -y flag is used
  • on invoking tw-install, without arguments, display status of known task versions, environment and available modules
  • tw-install list lists available modules

these should probably be individual requests, but we're in the discussion phase ;-)

@linuxcaffe
Copy link
Collaborator Author

linuxcaffe commented Aug 7, 2021

possible command-line switches;
-y to automatically answer "yes" to all confirmation prompts
-l to list all available modules, showing installed status
-t [module(s)] to run tests
-v [module(s)] to show version(s)
-u [module(s)] to uninstall module(s)

@a-t-0
Copy link
Contributor

a-t-0 commented Aug 7, 2021

Thank you for your suggestions, I had been planning to come up with these kinds of arguments and did not yet have enough experience to establish them naturally, so it is great to receive your suggestions!

I took the liberty to rename the repository according to your suggestion. You already mentioned it once before, but I did not pick up on it, as I thought it was important to have the word "taskwarrior" in the repo name to make this findable for new users. However, one of the overall objectives is “positive impact” (through making it as easy possible for (new) users to use Taskwarrior). I think compliance with the Taskwarrior organisation reaches that objective better than having that word in the repo name. Hence, it is changed. My apologies for avoiding conflict and not discussing this the first time you mentioned it.

Also, I renamed uninstall.sh to tw-uninstall.sh for consistency. My first guess would be to have the behaviour/arguments of tw-uninstall.sh mirror those of tw-install.sh, but I still have to think about whether that is indeed desirable in light of their difference. The name-changes are also reflected in the README.md.

@a-t-0
Copy link
Contributor

a-t-0 commented Sep 4, 2021

Affirmative, the tw-install.sh and tw-uninstall.sh files as they willl be replaced with this filestructure:
https://github.com/TruCol/setup_your_own_GitLab_CI/blob/master/install_gitlab.sh
and this one:
https://github.com/TruCol/setup_your_own_GitLab_CI/blob/master/uninstall_gitlab.sh

These can be used as examples, as they display the desired behaviour (no arguments passed prints the options) and the arguments can be modified to reflect the desired behaviour of the taskwarrior installation (instead of the GitLab installation).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants