make utils_manual.jl, fix branches in PKGINFOS

Author: KronosTheLate

docs/utils.jl

@@ -82,34 +82,34 @@ const PKGINFOS = [
     PkgInfo(pkgname="LazyJSON", username="JuliaCloud", branch="master", docslink=nothing),
     PkgInfo(pkgname="BSON", username="JuliaIO", branch="master", docslink=nothing),
     PkgInfo(pkgname="JSONRPC", username="julia-vscode", branch="master", docslink=nothing),
-    PkgInfo(pkgname="PropCheck", username="Seelengrab", branch="master"),
-    PkgInfo(pkgname="Supposition", username="Seelengrab", branch="master"),
-    PkgInfo(pkgname="JCheck", username="ps-pat", branch="master"),
+    PkgInfo(pkgname="PropCheck", username="Seelengrab"),
+    PkgInfo(pkgname="Supposition", username="Seelengrab"),
+    PkgInfo(pkgname="JCheck", username="ps-pat"),
     PkgInfo(pkgname="ProfileView", username="timholy", branch="master"),
     PkgInfo(pkgname="ProfileVega", username="davidanthoff", branch="master"),
     PkgInfo(pkgname="StatProfilerHTML", username="tkluck", branch="master"),
     PkgInfo(pkgname="ProfileSVG", username="kimikage", branch="master"),
-    PkgInfo(pkgname="PProf", username="JuliaPerf", branch="master"),
-    PkgInfo(pkgname="ProfileCanvas", username="pfitzseb", branch="master"),
+    PkgInfo(pkgname="PProf", username="JuliaPerf"),
+    PkgInfo(pkgname="ProfileCanvas", username="pfitzseb"),
     PkgInfo(pkgname="BenchmarkTools", username="JuliaCI", branch="master"),
-    PkgInfo(pkgname="Chairmarks", username="LilithHafner", branch="master"),
+    PkgInfo(pkgname="Chairmarks", username="LilithHafner"),
     PkgInfo(pkgname="PkgBenchmark", username="JuliaCI", branch="master"),
     PkgInfo(pkgname="BenchmarkCI", username="tkf", branch="master"),
     PkgInfo(pkgname="AirspeedVelocity", username="MilesCranmer", branch="master"),
-    PkgInfo(pkgname="PkgJogger", username="awadell1", branch="master"),
+    PkgInfo(pkgname="PkgJogger", username="awadell1"),
     PkgInfo(pkgname="FactCheck", username="JuliaAttic", branch="master", docslink=nothing),
     PkgInfo(pkgname="Spec", username="zenna", branch="master"),
-    PkgInfo(pkgname="TestTools", username="velexi-research", branch="master"),
+    PkgInfo(pkgname="TestTools", username="velexi-research"),
     PkgInfo(pkgname="IntervalSets", username="JuliaMath", branch="master"),
     PkgInfo(pkgname="Intervals", username="invenia", branch="master"),
     PkgInfo(pkgname="IntervalArithmetic", username="JuliaIntervals", branch="master"),
     PkgInfo(pkgname="Franklin", username="tlienart", branch="master"),
     PkgInfo(pkgname="StaticWebPages", username="Humans-of-Julia", branch="master"),
-    PkgInfo(pkgname="DataFrames", username="JuliaData", branch="master"),
+    PkgInfo(pkgname="DataFrames", username="JuliaData"),
     PkgInfo(pkgname="InMemoryDatasets", username="sl-solution", branch="master"),
-    PkgInfo(pkgname="JuliaDB", username="JuliaData", branch="master"),
-    PkgInfo(pkgname="Tidier", username="TidierOrg", branch="master"),
-    PkgInfo(pkgname="DTables", username="JuliaParallel", branch="master"),
+    PkgInfo(pkgname="JuliaDB", username="JuliaData"),
+    PkgInfo(pkgname="Tidier", username="TidierOrg"),
+    PkgInfo(pkgname="DTables", username="JuliaParallel"),
     PkgInfo(pkgname="WaterLily", username="weymouth", branch="master"),
     PkgInfo(pkgname="Oceananigans", username="CliMA", branch="main"),
     PkgInfo(pkgname="Clang", username="JuliaInterop", branch="master"),
@@ -140,7 +140,7 @@ const PKGINFOS = [
     PkgInfo(pkgname="DelimitedFiles", username="JuliaData", docslink="http://delimitedfiles.juliadata.org/dev/"),
     PkgInfo(pkgname="CSVFiles", username="queryverse", branch="master", docslink=nothing),
     PkgInfo(pkgname="ChunkedCSV", username="RelationalAI", docslink=nothing),
-    PkgInfo(pkgname="TableReader", username="bicycle1885 "),
+    PkgInfo(pkgname="TableReader", username="bicycle1885", branch="master"),
     PkgInfo(pkgname="DLMReader", username="sl-solution"),
     PkgInfo(pkgname="ReadWriteDlm2", username="strickek", docslink=nothing),
 ]
@@ -264,4 +264,4 @@ function lx_baz(com, _)
   brace_content = Franklin.content(com.braces[1]) # input string
   # do whatever you want here
   return uppercase(brace_content)
-end
+end

docs/utils_manual.jl

@@ -0,0 +1,52 @@
+#*===========================================================================================================================*#
+#*==========================   Utility functions for interactive, manual use by humans, not bots   ==========================*#
+#*===========================================================================================================================*#
+
+#! Run this in your local Julia project, not the project for the web-page!
+
+##? Check if the branchname in PKGINFOS mismatches the value found automatically:
+include("utils.jl")   # To define PKGINFOS
+using GitHub
+buffered_github_responses = Dict{String, Repo}()   # Access takes some time, and you can reach rate limits. Caching responses helps alleviate these issues. 
+
+#? See https://github.com/JuliaWeb/GitHub.jl?tab=readme-ov-file#authentication for information about authentuication.
+if haskey(ENV, "GITHUB_AUTH")
+    is_authenticated = true
+    auth = GitHub.authenticate(ENV["GITHUB_AUTH"]) # don't hardcode your access tokens!
+else
+    is_authenticated = false
+end
+GitHub.repo(PKGINFOS[1].repolink[begin+length("https://github.com/"):end]; auth)|>propertynames
+let
+    n_packages = length(PKGINFOS)
+    n_good_packages = 0  # Initialization
+    for PKGINFO in PKGINFOS
+        if haskey(buffered_github_responses, PKGINFO.pkgname)
+            true_branchname = buffered_github_responses[PKGINFO.pkgname].default_branch
+        else
+            try
+                if is_authenticated
+                    repo_object = GitHub.repo(PKGINFO.repolink[begin+length("https://github.com/"):end]; auth)
+                else
+                    repo_object = GitHub.repo(PKGINFO.repolink[begin+length("https://github.com/"):end])
+                end
+                true_branchname = repo_object.default_branch
+                buffered_github_responses[PKGINFO.pkgname] = repo_object
+            catch e
+                @warn "Caught an error while requesting data about the GitHub repo for $(PKGINFO.pkgname). Rethrowing error."
+                rethrow(e)
+            end
+        end
+        defined_branchname = PKGINFO.branch
+        if true_branchname == defined_branchname
+            n_good_packages += 1
+        else
+            @info """
+            Discrepancy found for package "$(PKGINFO.pkgname)"
+            True default branch:     $true_branchname
+            Branch name in PKGINFOS: $defined_branchname
+            """
+        end
+    end
+    @info "Check complete. $n_good_packages/$n_packages had the right branch name."
+end