Fix drwatson as author for project setup git commits (#299)

* Use keyword author for project setup git commits

* Test initialize_project keeps git config

* Increment patch version

Author: grahamas

Project.toml

@@ -1,7 +1,7 @@
 name = "DrWatson"
 uuid = "634d3b9d-ee7a-5ddf-bec9-22491ea816e1"
 repo = "https://github.com/JuliaDynamics/DrWatson.jl.git"
-version = "2.7.0"
+version = "2.7.1"
 
 [deps]
 Dates = "ade2ca70-3891-5945-98fb-dc099432e06a"

src/project_setup.jl

@@ -274,12 +274,8 @@ function initialize_project(path, name = default_name_from_path(path);
 
     if git
         repo = LibGit2.init(path)
-        gc = LibGit2.GitConfig(repo)
-        LibGit2.get(gc, "user.name", LibGit2.getconfig("user.name", false)) ||
-            LibGit2.set!(gc, "user.name", "DrWatson")
-        LibGit2.get(gc, "user.email", LibGit2.getconfig("user.email", false)) ||
-            LibGit2.set!(gc, "user.email", "no@mail")
-        LibGit2.commit(repo, "Initial commit")
+        sig = LibGit2.Signature("DrWatson", "no@mail", round(Int, time()), 0)
+        LibGit2.commit(repo, "Initial commit"; author=sig, committer=sig)
     end
 
     Pkg.activate(path)
@@ -293,11 +289,14 @@ function initialize_project(path, name = default_name_from_path(path);
     # Instantiate template
     folders, ph_files = insert_folders(path, template, placeholder)
 
-    git && LibGit2.add!(repo, "Project.toml")
-    git && LibGit2.add!(repo, "Manifest.toml")
-    git && LibGit2.add!(repo, folders...)
-    placeholder && git && LibGit2.add!(repo, ph_files...)
-    git && LibGit2.commit(repo, "Folder setup by DrWatson")
+    if git
+        LibGit2.add!(repo, "Project.toml")
+        LibGit2.add!(repo, "Manifest.toml")
+        LibGit2.add!(repo, folders...)
+        placeholder && LibGit2.add!(repo, ph_files...)
+        sig = LibGit2.Signature("DrWatson", "no@mail", round(Int, time()), 0)
+        LibGit2.commit(repo, "Folder setup by DrWatson"; author=sig, committer=sig)
+    end
 
     # Default files
     # chmod is needed, as the file permissions are not set correctly when adding the package with `add`.
@@ -320,8 +319,11 @@ function initialize_project(path, name = default_name_from_path(path);
     w *= compat_entry()
     write(joinpath(path, "Project.toml"), w, pro)
     push!(files, "Project.toml")
-    git && LibGit2.add!(repo, files...)
-    git && LibGit2.commit(repo, "File setup by DrWatson")
+    if git
+        LibGit2.add!(repo, files...)
+        sig = LibGit2.Signature("DrWatson", "no@mail", round(Int, time()), 0)
+        LibGit2.commit(repo, "File setup by DrWatson"; author=sig, committer=sig)
+    end
     return path
 end
 

test/project_tests.jl

@@ -1,6 +1,8 @@
 using Pkg, Test, DrWatson
 using LibGit2
 LibGit2.default_signature() = LibGit2.Signature("TEST", "TEST@TEST.COM", round(time(), 0), 0)
+global_user_name = LibGit2.getconfig("user.name", "")
+global_user_email = LibGit2.getconfig("user.email", "")
 
 cd(@__DIR__)
 path = "test project"
@@ -12,6 +14,9 @@ Pkg.activate()
 # @test DrWatson.is_standard_julia_project() # we cant test this on CI
 
 initialize_project(path, force = true)
+repo = LibGit2.GitRepo(path)
+@test LibGit2.getconfig(repo, "user.name", "") == global_user_name
+@test LibGit2.getconfig(repo, "user.email", "") == global_user_email
 
 cd(path) do
     @test DrWatson.default_name_from_path(".") == path
@@ -45,6 +50,9 @@ end
 @test_throws ErrorException initialize_project(path, name)
 
 initialize_project(path, name; force = true, authors = ["George", "Nick"])
+repo = LibGit2.GitRepo(path)
+@test LibGit2.getconfig(repo, "user.name", "") == global_user_name
+@test LibGit2.getconfig(repo, "user.email", "") == global_user_email
 # test gitdescribe:
 com = gitdescribe(path)
 @test !occursin('-', com) # no dashes = no git describe