Caddy: v2: Implement git module

[vrongmeal]

Creating this issue to track progress for git module similar to the v1 git plugin.

[vrongmeal]

Currently implementing the module using the git bindings for go.

• [ ] Basic implementation of service by fetching at regular intervals.
• [ ] Webhook implementation to fetch as soon as changes are detected.

[mholt]

Something to consider: https://github.com/src-d/go-git/issues/1295

Perhaps the hard fork is a better dependency for now: https://github.com/go-git/go-git

Also, to clarify, this plugin will be hosted in a separate repository. You're welcome to track it here until your repo is pushed, though, I guess.

Thanks for working on this! Have fun with it!

[vrongmeal]

There are a few things I wanted to discuss. The following is the struct that implements the module:

type Git struct {
    // URL of the git repository.
    Repo string `json:"repo"`

    // Path to clone the repository in.
    //
    // Defaults to site root. Can be absolute or relative to site root.
    Path string `json:"path,omitempty"`

    // Branch or tag of the repository to clone.
    //
    // Defaults to master. `{latest}` can be used as a
    // placeholder for latest tag which ensures the most recent tag is
    // always pulled.
    Branch string `json:"branch,omitempty"`

    // Git access token required for private repositories.
    Token string `json:"token,omitempty"`

    // Depth of commits to fetch.
    Depth int `json:"depth,omitempty"`

    // Interval is the number of seconds between pulls.
    //
    // Defaults to 3600 (1 hour). Minimum interval is 5. An interval
    // of -1 disables periodic pull.
    Interval int `json:"interval,omitempty"`
}

Can we rename branch to something like tree?

Secondly, any other suggestions in this? The webhook part I'll implement later on. Also, I've added access token option for private repos. I'll also add the option for fetching using private key. (IMO using access tokens is a better way)

[mholt]

Great start!

Can we rename branch to something like tree?

Yes! That's a better name IMO.

Secondly, any other suggestions in this?

So far:

• // URL of the git repository. -- does this have to be the HTTPS form or can it also be SSH? Would be good to decide (or support both) and clarify. (Preferably both if it's not too hard.)
• {latest} can be used as a placeholder -- before this plugin is stable, we should decide on a properly-namespaced placeholder, like {git.repo.latest} or something.
• // Interval is the number of seconds between pulls. -- make this a caddy.Duration value, rather than requiring it to be seconds.
• // Depth of commits to fetch. -- under what circumstances? All pulls? The v1 plugin has clone_args and pull_args which seem useful, have you considered that instead, maybe more flexible that way? (I dunno myself, I've never needed them.)
• // Git access token required for private repositories. - this is fine, but before tagging a stable release you'll want to decide if you want to use the same field to specify a key file and, if so, maybe name it differently.

[tobya]

ping @abiosoft

[francislavoie]

Can we rename branch to something like tree?

Hmm, what's the reasoning for this? IMO branch feels more natural to me, even if it can also be a tag.

{latest} can be used as a placeholder -- before this plugin is stable, we should decide on a properly-namespaced placeholder, like {git.repo.latest} or something.

@mholt pretty sure this isn't the same kind of placeholder in the Caddy sense, it's just an internal magic value if I'm reading correctly.

[mholt]

Hmm, what's the reasoning for this? IMO branch feels more natural to me, even if it can also be a tag.

I think "tree" is more technically accurate, and makes it a little clearer that you're not limited to just branch names. I'm not particularly opinionated about the name of that field tbh.

pretty sure this isn't the same kind of placeholder in the Caddy sense, it's just an internal magic value if I'm reading correctly.

I'm not so sure, it seems like something exposed to the user.

[awoodbeck]

Be aware of the edge case presented by relative SSH URLs if you rely on url.Parse to validate the Repo field.

[mholt]

Closing, since this is now being tracked at https://github.com/vrongmeal/caddygit