Merge pull request #27 from PRODYNA/feature/26-mark-foreign-domains

feature/26 mark foreign domains

action.yaml

@@ -23,13 +23,18 @@ inputs:
     description: 'The verbosity level'
     required: false
     default: 1
+  own-domains:
+    description: 'Own domains to filter users by email domain'
+    required: false
+    default: ''
 runs:
   using: 'docker'
-  image: 'docker://ghcr.io/prodyna/github-users:v1.8'
+  image: 'docker://ghcr.io/prodyna/github-users:v1.9'
   env:
     ACTION: ${{ inputs.action }}
     ENTERPRISE: ${{ inputs.enterprise }}
     GITHUB_TOKEN: ${{ inputs.github-token }}
     TEMPLATE_FILE: ${{ inputs.template-file }}
     MARKDOWN_FILE: ${{ inputs.markdown-file }}
     VERBOSE: ${{ inputs.verbose }}
+    OWN_DOMAINS: ${{ inputs.own-domains }}

config/config.go

@@ -15,6 +15,7 @@ const (
 	keyTemplateFile = "TEMPLATE_FILE"
 	keyVerbose      = "VERBOSE"
 	keyMarkdownFile = "MARKDOWN_FILE"
+	keyOwnDomains   = "OWN_DOMAINS"
 )
 
 type Config struct {
@@ -23,6 +24,7 @@ type Config struct {
 	GithubToken  string
 	TemplateFile string
 	MarkdownFile string
+	OwnDomains   string
 }
 
 func New() (*Config, error) {
@@ -32,6 +34,7 @@ func New() (*Config, error) {
 	flag.StringVar(&c.GithubToken, keyGithubToken, lookupEnvOrString("GITHUB_TOKEN", ""), "The GitHub Token to use for authentication.")
 	flag.StringVar(&c.TemplateFile, keyTemplateFile, lookupEnvOrString("TEMPLATE_FILE", "template/members.tpl"), "The template file to use for rendering the result.")
 	flag.StringVar(&c.MarkdownFile, keyMarkdownFile, lookupEnvOrString("MARKDOWN_FILE", "USERS.md"), "The markdown file to write the result to.")
+	flag.StringVar(&c.OwnDomains, keyOwnDomains, lookupEnvOrString("OWN_DOMAINS", ""), "The comma separated list of domains to consider as own domains.")
 	verbose := flag.Int("verbose", lookupEnvOrInt(keyVerbose, 0), "Verbosity level, 0=info, 1=debug. Overrides the environment variable VERBOSE.")
 
 	level := slog.LevelInfo

main.go

@@ -7,20 +7,6 @@ import (
 	"os"
 )
 
-const (
-	keyAction       = "ACTION"
-	keyOrganization = "ORGANIZATION"
-	keyGithubToken  = "GITHUB_TOKEN"
-	keyTemplateFile = "TEMPLATE_FILE"
-)
-
-type Config struct {
-	Action       string
-	Enterprise   string
-	GithubToken  string
-	TemplateFile string
-}
-
 func main() {
 	c, err := config.New()
 	if err != nil {
@@ -34,6 +20,7 @@ func main() {
 		userlist.WithGithubToken(c.GithubToken),
 		userlist.WithTemplateFile(c.TemplateFile),
 		userlist.WithMarkdownFile(c.MarkdownFile),
+		userlist.WithOwnDomains(c.OwnDomains),
 	)
 
 	err = ulc.Validate()

template/members.tpl

@@ -4,7 +4,7 @@ Last updated: {{ .Updated }}
 
 | # | GitHub Login | GitHub name | E-Mail | Contributions |
 | --- | --- | --- | --- | --- |
-{{ range .Users }} | {{ .Number }} | [{{ .Login }}](https://github.com/enterprises/{{ $.Enterprise.Slug }}/people/{{ .Login }}/sso) | {{ .Name }} | {{ .Email }}  | {{if .Contributions}}:green_square:{{else}}:red_square:{{end}} [{{.Contributions }}](https://github.com/{{ .Login }}) |
+{{ range .Users }} | {{ .Number }} | [{{ .Login }}](https://github.com/enterprises/{{ $.Enterprise.Slug }}/people/{{ .Login }}/sso) | {{ .Name }} | {{ if .IsOwnDomain }}:green_square:{{else}}:red_square:{{end}} {{ .Email }}  | {{if .Contributions}}:green_square:{{else}}:red_square:{{end}} [{{.Contributions }}](https://github.com/{{ .Login }}) |
 {{ end }}
 
 {{ if .Users }}_{{ len .Users }} users_{{ else }}No users found.{{ end }}

userlist/constructor.go

@@ -1,5 +1,7 @@
 package userlist
 
+import "strings"
+
 func New(options ...func(*UserListConfig)) *UserListConfig {
 	config := &UserListConfig{
 		validated: false,
@@ -40,3 +42,9 @@ func WithMarkdownFile(markdownFile string) func(*UserListConfig) {
 		config.markdownFile = markdownFile
 	}
 }
+
+func WithOwnDomains(ownDomains string) func(*UserListConfig) {
+	return func(config *UserListConfig) {
+		config.ownDomains = strings.Split(ownDomains, ",")
+	}
+}

userlist/members.go

@@ -5,6 +5,7 @@ import (
 	"github.com/shurcooL/githubv4"
 	"golang.org/x/oauth2"
 	"log/slog"
+	"strings"
 	"time"
 )
 
@@ -57,7 +58,7 @@ func (c *UserListConfig) loadMembers() error {
 
 	window := 25
 	variables := map[string]interface{}{
-		"slug":  githubv4.String("prodyna"),
+		"slug":  githubv4.String(c.enterprise),
 		"first": githubv4.Int(window),
 		"after": (*githubv4.String)(nil),
 	}
@@ -81,6 +82,7 @@ func (c *UserListConfig) loadMembers() error {
 				Login:         e.Node.User.Login,
 				Name:          e.Node.User.Name,
 				Email:         e.Node.SamlIdentity.NameId,
+				IsOwnDomain:   IsOwnDomain(e.Node.SamlIdentity.NameId, c.ownDomains),
 				Contributions: e.Node.User.ContributionsCollection.ContributionCalendar.TotalContributions,
 			}
 			c.userList.upsertUser(u)
@@ -97,3 +99,15 @@ func (c *UserListConfig) loadMembers() error {
 	c.loaded = true
 	return nil
 }
+
+func IsOwnDomain(email string, ownDomains []string) bool {
+	if len(ownDomains) == 0 {
+		return true
+	}
+	for _, domain := range ownDomains {
+		if strings.HasSuffix(email, domain) {
+			return true
+		}
+	}
+	return false
+}

userlist/userlist.go

@@ -25,6 +25,7 @@ type UserListConfig struct {
 	validated    bool
 	loaded       bool
 	userList     UserList
+	ownDomains   []string
 }
 
 type UserList struct {
@@ -44,6 +45,7 @@ type User struct {
 	Login         string `json:"Login"`
 	Name          string `json:"Name"`
 	Email         string `json:"Email"`
+	IsOwnDomain   bool   `json:"IsOwnDomain"`
 	Contributions int    `json:"Contributions"`
 	Organizations *[]Organization
 }
@@ -80,7 +82,8 @@ func (c *UserListConfig) Validate() error {
 		"enterprise", c.enterprise,
 		"template", c.templateFile,
 		"githubToken", "***",
-		"markdownFile", c.markdownFile)
+		"markdownFile", c.markdownFile,
+		slog.Any("ownDomains", c.ownDomains))
 	return nil
 }