Auto Git Config Script Added and Tab_Data TOML Updated. by fam007e · Pull Request #448 · ChrisTitusTech/linutil

fam007e · 2024-09-17T15:42:51Z

Type of Change

New feature

Description

This PR introduces a script that automates the configuration of Git for users, allowing them to:

Set up their GitHub email.
Generate an SSH key of their chosen type (Ed25519 or RSA).
Additionally, it includes consequential changes to the tab_data.toml file for proper integration.

Testing

Verified GitHub email input and SSH key generation (Ed25519 and RSA).
Tested SSH connection to GitHub to ensure proper setup.

Impact

This change simplifies the Git setup process, ensuring consistency across environments and making it easier for users to configure their Git and GitHub SSH keys.

Issue related to PR

Checklist

My code adheres to the coding and style guidelines of the project.
I have performed a self-review of my own code.
I have commented my code, particularly in hard-to-understand areas.
I have made corresponding changes to the documentation.
My changes generate no errors/warnings/merge conflicts.

…b_data toml file.

koibtw

You should move this to utils/

tabs/system-setup/tab_data.toml

tabs/system-setup/git-auto-conf-cli.sh

koibtw · 2024-09-17T16:18:38Z

tabs/system-setup/git-auto-conf-cli.sh

+    # Prompt user to confirm they've added the key to GitHub
+    while true; do
+        printf "Have you pasted your SSH public key into your GitHub account? (y/n): "
+        read yn
+        case "$yn" in
+            [Yy]* ) echo "Proceeding..."; break ;;
+            [Nn]* ) echo "Please paste your SSH public key into GitHub and try again."; exit ;;
+            * ) echo "Please answer yes (y) or no (n)." ;;
+        esac
+    done
+
+    # Test the SSH connection with GitHub
+    ssh -T git@github.com
+}


I don't know if this GitHub part is neccessary. @nnyyxxxx ?

Looks useless

and invasive

the users dont know if the information they're putting into linutil is being tracked or not without looking at the source code so this is bad @fam007e

But as far as I know linutil is binary running in user's specific environment so text being in user's clipboard is NOT supposed be an issue here.
Since you have raised an issue I will change it anyway unlike what my opinion is on this matter.

koibtw · 2024-09-17T16:21:18Z

Your script should also check if git is installed and actually set up commit signing (and set up git overall) with the generated key.

Co-authored-by: Adam Perkowski <adas1per@protonmail.com>

koibtw · 2024-09-17T17:46:16Z

@fam007e Can you draft this PR for now (and the other ones as well)? Chris is going to be streaming soon and with almost 60 open PRs let's just not waste his time before this is done.

ghost · 2024-09-17T17:49:12Z

Yeah i'm going to just say it now, THIS PR is a total mess; and a joke, you're using functions in common-script that shouldn't be used for checking deps like curl or git, and on top of that you're asking the user if they want to test their GIT SSH key which is sooo invasive. Please just close this.

ghost · 2024-09-17T17:53:58Z

tabs/utils/git-auto-conf-cli.sh

+    else
+        echo "Skipping passphrase setup."
+    fi
+    echo "SSH key generation and setup completed.\nPlease copy the key from your ssh dir and paste it to your corresponding account ssh key add section of your github settings page.\nThen run this command to verify ssh connection:\nssh -T git@github.com"


Suggested change

echo "SSH key generation and setup completed.\nPlease copy the key from your ssh dir and paste it to your corresponding account ssh key add section of your github settings page.\nThen run this command to verify ssh connection:\nssh -T git@github.com"

printf "SSH key generation and setup completed.\nPlease copy the key from your ssh dir and paste it to your corresponding account ssh key add section of your github settings page.\nThen run this command to verify ssh connection:\nssh -T git@github.com"

You CANNOT use new lines in echo without it being non-posix, use printf

fam007e · 2024-09-17T17:54:07Z

Yeah i'm going to just say it now, THIS PR is a total mess; and a joke, you're using functions in common-script that shouldn't be used for checking deps like curl or git, and on top of that you're asking the user if they want to test their GIT SSH key which is sooo invasive. Please just close this.

But @adamperkowski told me to add deps check for git... 🙃

…oved to utils dir as a concsequence affected tabs TOML is edited

ghost · 2024-09-17T17:54:38Z

Yeah i'm going to just say it now, THIS PR is a total mess; and a joke, you're using functions in common-script that shouldn't be used for checking deps like curl or git, and on top of that you're asking the user if they want to test their GIT SSH key which is sooo invasive. Please just close this.

But @adamperkowski told me to add deps check for git... 🙃

And I'm telling you that your implementation is wrong 👎

ghost · 2024-09-17T17:56:39Z

tabs/utils/git-auto-conf-cli.sh

+
+# Function to prompt for GitHub configuration
+setup_git_config() {
+    checkCommandRequirements "git"


Yeah this implementation is completely WRONG, you clearly do not know what you're doing, using "checkcommandrequirements" from common script will exit the script if git is not found which is BAD and should not be used in this SCENARIO 👎

ghost · 2024-09-17T17:57:22Z

Draft these PRs they are not ready in the slightest.

ghost · 2024-09-17T17:58:37Z

tabs/system-setup/tab_data.toml

 [[data]]
 name = "Remove Snaps"
 script = "4-remove-snaps.sh"
+


Suggested change

Remove this line...

@fam007e ONCE AGAIN, this extra line has not been removed, please remove it

tabs/utils/git-auto-conf-cli.sh

ghost · 2024-09-17T18:02:09Z

tabs/utils/git-auto-conf-cli.sh

+
+# Main execution
+checkEnv
+checkCommandRequirements "git"


NO. This implementation is STILL wrong, what do you not understand? I explained it to you in a previous review; Exiting the script if git is not found is NOT good. Do not implement it like this...

koibtw · 2024-09-17T18:04:33Z

tabs/utils/git-auto-conf-cli.sh

+
+# Main execution
+checkEnv
+checkCommandRequirements "git"


You need to do what this PR does: #436

ghost · 2024-09-17T18:05:56Z

tabs/utils/git-auto-conf-cli.sh

+
+# Main execution
+checkEnv
+checkCommandRequirements "git"


@fam007e The other review on this issue is NOT resolved, I don't understand what you do not understand this implementation is incorrect and will exit the script upon git not being found, this is not what we want. Seriously dude.. We have tried explaining to you many times over.

koibtw · 2024-09-17T18:11:31Z

tabs/utils/git-auto-conf-cli.sh

+    printf "Choose your SSH key type:"
+    printf "1. Ed25519 (recommended)"
+    printf "2. RSA (legacy)"
+    printf "Enter your choice (1 or 2): "


Not like that. This is how it looks with printfs:
Choose your SSH key type:1. Ed25519 (recommended)2. RSA (legacy)Enter your choice (1 or 2):

Suggested change

printf "Choose your SSH key type:"

printf "1. Ed25519 (recommended)"

printf "2. RSA (legacy)"

printf "Enter your choice (1 or 2): "

echo "Choose your SSH key type:"

echo "1. Ed25519 (recommended)"

echo "2. RSA (legacy)"

printf "Enter your choice (1 or 2): "

koibtw · 2024-09-17T18:11:41Z

tabs/utils/git-auto-conf-cli.sh

+        1) key_algo="ed25519" ;;
+        2) key_algo="rsa" ;;
+        *)
+            printf "Invalid choice. Exiting."


Suggested change

printf "Invalid choice. Exiting."

echo "Invalid choice. Exiting."

koibtw · 2024-09-17T18:12:49Z

tabs/utils/git-auto-conf-cli.sh

+    printf "Do you want to use a passphrase? (y/n): "
+    read use_passphrase
+
+    # If user opts for a passphrase, add key to SSH agent
+    if [ "$use_passphrase" = "y" ]; then
+        ssh-add -l >/dev/null 2>&1 || eval "$(ssh-agent -s)"
+        ssh-add "$ssh_key_path"
+    else
+        printf "Skipping passphrase setup."
+    fi


Suggested change

printf "Do you want to use a passphrase? (y/n): "

read use_passphrase

# If user opts for a passphrase, add key to SSH agent

if [ "$use_passphrase" = "y" ]; then

ssh-add -l >/dev/null 2>&1 || eval "$(ssh-agent -s)"

ssh-add "$ssh_key_path"

else

printf "Skipping passphrase setup."

fi

printf "Do you want to use a passphrase? (Y/n): "

read use_passphrase

case "$use_passphrase" in

n|N)

echo "Skipping passphrase setup."

;;

*)

ssh-add -l >/dev/null 2>&1 || eval "$(ssh-agent -s)"

ssh-add "$ssh_key_path"

;;

esac

koibtw · 2024-09-17T18:13:04Z

tabs/utils/git-auto-conf-cli.sh

+    else
+        printf "Skipping passphrase setup."
+    fi
+    printf "SSH key generation and setup completed.\nPlease copy the key from your ssh dir and paste it to your corresponding account ssh key add section of your github settings page.\nThen run this command to verify ssh connection:\nssh -T git@github.com"


Suggested change

printf "SSH key generation and setup completed.\nPlease copy the key from your ssh dir and paste it to your corresponding account ssh key add section of your github settings page.\nThen run this command to verify ssh connection:\nssh -T git@github.com"

printf "SSH key generation and setup completed.\nPlease copy the key from your ssh dir and paste it to your corresponding account ssh key add section of your github settings page.\nThen run this command to verify ssh connection:\nssh -T git@github.com\n"

koibtw · 2024-09-17T18:16:16Z

Draft this until everything is done.

fam007e · 2024-09-17T18:23:14Z

Draft this until everything is done.

Plz check the recent commit. Hopefully I did not mess this up.

ghost · 2024-09-17T18:26:02Z

Draft this until everything is done.

Plz check the recent commit. Hopefully I did not mess this up.

Yeah.. you're creating more problems and it's being implemented incorrectly.

ghost · 2024-09-17T18:38:35Z

@fam007e Is this a joke?

Please close this PR, you're making it worse.

auto git config's script added and consequential change is made to ta…

d430358

…b_data toml file.

koibtw mentioned this pull request Sep 17, 2024

NerdFonts installer script added and consequential change to tab_data TOML file. #446

Closed

12 tasks

koibtw requested changes Sep 17, 2024

View reviewed changes

fam007e and others added 3 commits September 17, 2024 22:55

Update tabs/system-setup/tab_data.toml

78cad31

Co-authored-by: Adam Perkowski <adas1per@protonmail.com>

Update tabs/system-setup/git-auto-conf-cli.sh

5040b27

Co-authored-by: Adam Perkowski <adas1per@protonmail.com>

Update tabs/system-setup/git-auto-conf-cli.sh

5947b33

Co-authored-by: Adam Perkowski <adas1per@protonmail.com>

ghost reviewed Sep 17, 2024

View reviewed changes

check cmd req for git cmd is added and the script for git config is m…

bb095b0

…oved to utils dir as a concsequence affected tabs TOML is edited

ghost reviewed Sep 17, 2024

View reviewed changes

tabs/utils/git-auto-conf-cli.sh Show resolved Hide resolved

ghost reviewed Sep 17, 2024

View reviewed changes

check cmd req for git cmd is added at the main exec part

8c7557b

koibtw requested changes Sep 17, 2024

View reviewed changes

removed extra line from the script

8a14b10

ghost reviewed Sep 17, 2024

View reviewed changes

removed echo cmd

b7134ce

koibtw requested changes Sep 17, 2024

View reviewed changes

new fresh approach

521c8e5

ok if this is not to your liking close and trash the PR, I am done

ff70494

fam007e closed this Sep 17, 2024

ghost mentioned this pull request Sep 17, 2024

Add code understanding & testing point to Contributing Guidelines #451

Merged

2 tasks

	echo "SSH key generation and setup completed.\nPlease copy the key from your ssh dir and paste it to your corresponding account ssh key add section of your github settings page.\nThen run this command to verify ssh connection:\nssh -T git@github.com"
	printf "SSH key generation and setup completed.\nPlease copy the key from your ssh dir and paste it to your corresponding account ssh key add section of your github settings page.\nThen run this command to verify ssh connection:\nssh -T git@github.com"

	printf "Invalid choice. Exiting."
	echo "Invalid choice. Exiting."

Conversation

fam007e commented Sep 17, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Type of Change

Description

Testing

Impact

Issue related to PR

Checklist

Uh oh!

koibtw left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

koibtw commented Sep 17, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

koibtw commented Sep 17, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ghost commented Sep 17, 2024

Uh oh!

Choose a reason for hiding this comment

Uh oh!

fam007e commented Sep 17, 2024

Uh oh!

ghost commented Sep 17, 2024

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ghost commented Sep 17, 2024

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

koibtw commented Sep 17, 2024

Uh oh!

fam007e commented Sep 17, 2024

Uh oh!

ghost commented Sep 17, 2024

Uh oh!

ghost commented Sep 17, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Comments

fam007e commented Sep 17, 2024 •

edited

Loading

koibtw commented Sep 17, 2024 •

edited

Loading

koibtw commented Sep 17, 2024 •

edited

Loading