add comments

Author: moutonjeremy

pkg/config/config.go

@@ -14,7 +14,7 @@ var (
 	Debug bool
 )
 
-// InitConfiguration => set configuration from env vars or command parameters
+// InitConfiguration - set configuration from env vars or command parameters
 func InitConfiguration() []cli.Flag {
 	return []cli.Flag{
 		&cli.IntFlag{

pkg/metrics/get_billable_from_github.go

@@ -21,6 +21,7 @@ var (
 	)
 )
 
+// getBillableFromGithub - return billable informations for MACOS, WINDOWS and UBUNTU runners.
 func getBillableFromGithub() {
 	for {
 		for _, repo := range config.Github.Repositories.Value() {

pkg/metrics/get_runners_from_github.go

@@ -21,6 +21,7 @@ var (
 	)
 )
 
+// getRunnersFromGithub - return information about runners and their status for a specific repo
 func getRunnersFromGithub() {
 	for {
 		for _, repo := range config.Github.Repositories.Value() {

pkg/metrics/get_runners_organization_from_github.go

@@ -21,6 +21,7 @@ var (
 	)
 )
 
+// getRunnersOrganizationFromGithub - return information about runners and their status for an organization
 func getRunnersOrganizationFromGithub() {
 	opt := &github.ListOptions{PerPage: 10}
 	for {

pkg/metrics/get_workflow_runs_from_github.go

@@ -35,6 +35,7 @@ var (
 	)
 )
 
+// getWorkflowRunsFromGithub - return informations and status about a worflow
 func getWorkflowRunsFromGithub() {
 	for {
 		for _, repo := range config.Github.Repositories.Value() {

pkg/metrics/metrics.go

@@ -16,6 +16,7 @@ var (
 	err    error
 )
 
+// InitMetrics - register metrics in prometheus lib and start func for monitor
 func InitMetrics() {
 	prometheus.MustRegister(runnersGauge)
 	prometheus.MustRegister(runnersOrganizationGauge)

pkg/metrics/workflows_cache.go

@@ -15,6 +15,7 @@ var (
 	workflows map[string]map[int64]github.Workflow
 )
 
+// workflowCache - used for limit calls to github api
 func workflowCache() {
 	for {
 		ww := make(map[string]map[int64]github.Workflow)

pkg/server/routes.go

@@ -18,6 +18,7 @@ var (
 	index   = fasthttpadaptor.NewFastHTTPHandlerFunc(pprof.Index)
 )
 
+// prometheusHandler - fastHTTP handler for prometheus metrics
 func prometheusHandler() fasthttp.RequestHandler {
 	return fasthttpadaptor.NewFastHTTPHandler(promhttp.Handler())
 }

pkg/server/server.go

@@ -12,6 +12,7 @@ import (
 	"github-actions-exporter/pkg/metrics"
 )
 
+// RunServer - run http server for expose metrics
 func RunServer(ctx *cli.Context) error {
 	metrics.InitMetrics()