Doc pusher

src/pusher/webhook.go

@@ -12,6 +12,8 @@ import (
 	"gopkg.in/go-playground/webhooks.v3/gitlab"
 )
 
+// SetupWebhook creates and exposes a GitLab webhook using a given configuration.
+// Returns an error if the webhook couldn't be set up.
 func SetupWebhook(cfg *config.Config) error {
 	hook := gitlab.New(&gitlab.Config{
 		Secret: cfg.Webhook.Secret,
@@ -25,27 +27,33 @@ func SetupWebhook(cfg *config.Config) error {
 	)
 }
 
+// HandlePush is called each time a push event is sent by GitLab on the webhook.
 func HandlePush(payload interface{}, header webhooks.Header) {
 	var err error
 
+	// Process the payload using the right structure
 	pl := payload.(gitlab.PushEventPayload)
 
+	// Clone or pull the repository
 	if _, err = git.Sync(cfg.Git); err != nil {
 		panic(err)
 	}
 
+	// Iterate over the commits descriptions from the payload
 	for _, commit := range pl.Commits {
 		// We don't want to process commits made by the puller
 		if commit.Author.Email == cfg.Git.CommitsAuthor.Email {
 			continue
 		}
 
+		// Push all added files
 		for _, addedFile := range commit.Added {
 			if err = pushFile(addedFile); err != nil {
 				panic(err)
 			}
 		}
 
+		// Push all modified files
 		for _, modifiedFile := range commit.Modified {
 			if err = pushFile(modifiedFile); err != nil {
 				panic(err)
@@ -63,6 +71,10 @@ func HandlePush(payload interface{}, header webhooks.Header) {
 	}
 }
 
+// pushFile pushes the content of a given file to the Grafana API in order to
+// create or update a dashboard.
+// Returns an error if there was an issue reading the file or sending its content
+// to the Grafana instance.
 func pushFile(filename string) error {
 	filePath := cfg.Git.ClonePath + "/" + filename
 	fileContent, err := ioutil.ReadFile(filePath)