maintainers/scripts: Lint check-maintainer-github-handles.sh

[l0b0]

Motivation for this change

ShellCheck compliance and detecting errors earlier, see #133088, #21166.

Things done

• Built on platform(s)
  • x86_64-linux
  • aarch64-linux
  • x86_64-darwin
  • aarch64-darwin
• For non-Linux: Is sandbox = true set in nix.conf? (See Nix manual)
• Tested, as applicable:
  • NixOS test(s) (look inside nixos/tests)
  • and/or package tests
  • or, for functions and "core" functionality, tests in lib/tests or pkgs/test
  • made sure NixOS tests are linked to the relevant packages
• Tested compilation of all packages that depend on this change using nix-shell -p nixpkgs-review --run "nixpkgs-review rev HEAD". Note: all changes have to be committed, also see nixpkgs-review usage
• Tested basic functionality of all binary files (usually in ./result/bin/)
• 21.11 Release Notes (or backporting 21.05 Release notes)
  • (Package updates) Added a release notes entry if the change is major or breaking
  • (Module updates) Added a release notes entry if the change is significant
  • (Module addition) Added a release notes entry if adding a new NixOS module
  • (Release notes changes) Ran nixos/doc/manual/md-to-db.sh to update generated release notes
• Fits CONTRIBUTING.md.

@Artturin

[SuperSandro2000]

That should probably be kept.

[l0b0]

If you can explain why, I could include that in the comment. As it stands, I feel like that just looks like accidentally committed test code.

[SuperSandro2000]

I think that is when you want to manually check only a few users.

[l0b0]

Documented, cheers.

[SuperSandro2000]

That is so explicit that most people will not know what this means. I guess:

errexit is -e and nounset is -u?

[l0b0]

That is so explicit that most people will not know what this means.

That sentence doesn't make sense to me:

• How can something more explicit be harder to understand, unless you've only ever seen the abbreviation?
• Someone with no experience of either is going to find the longer option easier to read than the abbreviation, and might even get an inkling of what it actually means when seeing more than a single character.
• It is easy to search for the long version using a search engine or man bash. The single character abbreviation, not so much.

[SuperSandro2000]

How can something more explicit be harder to understand, unless you've only ever seen the abbreviation?

That answers itself. If you only ever have seen the short variant you don't know it.

Someone with no experience of either is going to find the longer option easier to read than the abbreviation, and might even get an inkling of what it actually means when seeing more than a single character.

The bash options are not self describing and someone having no experience will not understand either.

It is easy to search for the long version using a search engine

Since I am not the only person using the short options you will find a lot of results when searching https://www.google.com/search?q=set+-euo+pipefail

or man bash. The single character abbreviation, not so much.

Thats true. The bash man page is just to long.

[Artturin]

let it run for 11 minutes and no issues
had to do this though

diff --git a/maintainers/scripts/check-maintainer-github-handles.sh b/maintainers/scripts/check-maintainer-github-handles.sh
index a5555ca9e90..b7007ecc6a5 100755
--- a/maintainers/scripts/check-maintainer-github-handles.sh
+++ b/maintainers/scripts/check-maintainer-github-handles.sh
@@ -11,7 +11,7 @@ function checkCommits {
     local ret status tmp user
     user="$1"
     tmp=$(mktemp)
-    curl --silent -w "%{http_code}" \
+    curl --silent -u artturin:${GITHUB_TOKEN} -w "%{http_code}" \
          "https://github.com/NixOS/nixpkgs/commits?author=$user" \
          > "$tmp"
     # the last line of tmp contains the http status
@@ -42,7 +42,7 @@ export -f checkCommits
 function checkUser {
     local user="$1"
     local status=
-    status="$(curl --silent --head "https://github.com/${user}" | grep Status)"
+    status="$(curl --silent -u artturin:${GITHUB_TOKEN} --head "https://github.com/${user}" | grep Status)"
     # checks whether a user handle can be found on github
     if [[ "$status" =~ 404 ]]; then
         printf "%s\t\t\t\t%s\n" "$status" "$user"

the script has some pre-existing though such as not properly catching non-existant user handles

[SuperSandro2000]

Can you do a PR to add that to the script? Having the GITHUB_TOKEN is far more important. Also you don't need to input your username, -u ":$GITHUB_TOKEN" will just work fine.