JuliaCI/PkgTemplates.jl

"Git hosting service username is required"

Open

#327 opened on Nov 6, 2021

View on GitHub
 (4 comments) (4 reactions) (0 assignees)Julia (697 stars) (112 forks)batch import
Documentationgood-first-issuehelp wanted

Description

Hi. I'm just trying out PkgTemplates.jl in an attempt to master some of the more advanced package features - but ran into some difficulties.

New user's perspective

On my first attempt at using PkgTemplates.jl, I followed the instructions @ https://invenia.github.io/PkgTemplates.jl/stable/user/:

julia> using PkgTemplates

julia> t=Template()
ERROR: Git: Git hosting service username is required, set one with keyword `user="<username>"`

I was very surprised to see an error message so early on.

New user's perspective

I am mostly familiar with Git, but I did not understand this message.

  • I thought this meant I did not setup my (global) user.name and/or user.email settings in my .gitconfig - but this appears to be something else.
  • After a bit of searching around, I found the help on Template mentioned the github.user setting. Before that instant, I was unaware that .gitconfig could store github-specific parameters.
  • In retrospect, I can see that the error message was hinting I could specify the user parameter in my call to Template() - but in my mind, it sounded like I needed to add something to my .gitconfig directly.

I get that PkgTemplates.jl is meant to simplify the configuration of Julia's more advanced package features. As such, it might well be targeting more advanced users. Nonetheless, I sort of feel like some background might be missing from the User Guide.

Contributor guide