Merge pull request #28 from Interhyp/org-specific-user-suffix

feat: allow for organization-specific memberSuffixes

Author: tstollin

api/v1alpha1/applyconfiguration/api/v1alpha1/organizationspec.go

@@ -365,6 +365,14 @@ type OrganizationSpec struct {
 	// +optional
 	Location string `json:"location,omitempty"`
 
+	// MemberSuffix defines a suffix appended to each team member username before matching/adding them on GitHub.
+	// Useful when GitHub usernames follow a naming convention (e.g. enterprise suffix).
+	// Is ignored if environment variable GITHUB_MEMBER_SUFFIX is set.
+	// +kubebuilder:validation:MaxLength=100
+	// +optional
+	// +kubebuilder:default=""
+	MemberSuffix string `json:"memberSuffix,omitempty"`
+
 	// Website is the organization's website URL.
 	// This appears on the organization's GitHub profile page as a clickable link.
 	// +kubebuilder:validation:MaxLength=255

api/v1alpha1/organization_types.go

@@ -368,6 +368,14 @@ spec:
                 maxLength: 39
                 minLength: 1
                 type: string
+              memberSuffix:
+                default: ""
+                description: |-
+                  MemberSuffix defines a suffix appended to each team member username before matching/adding them on GitHub.
+                  Useful when GitHub usernames follow a naming convention (e.g. enterprise suffix).
+                  Is ignored if environment variable GITHUB_MEMBER_SUFFIX is set.
+                maxLength: 100
+                type: string
               name:
                 description: |-
                   Name is the organization's display name shown on the GitHub profile.

config/crd/bases/github.interhyp.de_organizations.yaml

@@ -27,6 +27,9 @@ spec:
     credentialsSecretName: acme-corp-app-credentials  # Secret in credentials namespace
   plan: enterprise                          # enterprise | team | free
 
+  # --- Team Members ---
+  memberSuffix: "@acme-corp.com"            # Appended to usernames in Team.spec.members; overridden by GITHUB_MEMBER_SUFFIX env var
+
   # --- Custom Properties ---
   # Define metadata fields that repositories must/can set
   customProperties:
@@ -199,6 +202,19 @@ Some features require specific GitHub plans:
 | Internal repository visibility | `enterprise` |
 | Runner groups | `team` or `enterprise` |
 
+## Team Member Suffix
+
+When GitHub usernames in your enterprise follow a naming convention (e.g. `[email protected]`), set `spec.memberSuffix` so you can write plain usernames in `Team.spec.members` without repeating the suffix everywhere:
+
+```yaml
+spec:
+  memberSuffix: "@acme-corp.com"
+```
+
+With this set, a team member listed as `john.doe` in `Team.spec.members` will be looked up and added on GitHub as `[email protected]`.
+
+The global `GITHUB_MEMBER_SUFFIX` environment variable takes precedence over this field if set. For multi-organization setups where different orgs use different naming conventions, `spec.memberSuffix` is the preferred approach since the env var applies uniformly to all organizations.
+
 ## Related Resources
 
 - [Repository Configuration](repository.md) - Configure repositories in this organization

docs/configuration/organization.md

@@ -621,6 +621,7 @@ _Appears in:_
 | `rulesetPresets` _[LocalObjectReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.34/#localobjectreference-v1-core) array_ | RulesetPresetList references RulesetPreset CRDs that define repository rulesets for this organization.<br />Rulesets enforce policies like branch protection, required reviews, and status checks.<br />See: https://docs.github.com/en/rest/orgs/rules |  |  |
 | `description` _string_ | Description is a human-readable description of the organization.<br />This appears on the organization's GitHub profile page. |  |  |
 | `location` _string_ | Location is the organization's location (e.g., "Munich, Germany").<br />This appears on the organization's GitHub profile page. |  | MaxLength: 100 <br />Optional: \{\} <br /> |
+| `memberSuffix` _string_ | MemberSuffix defines a suffix appended to each team member username before matching/adding them on GitHub.<br />Useful when GitHub usernames follow a naming convention (e.g. enterprise suffix).<br />Is ignored if environment variable GITHUB_MEMBER_SUFFIX is set. |  | MaxLength: 100 <br />Optional: \{\} <br /> |
 | `website` _string_ | Website is the organization's website URL.<br />This appears on the organization's GitHub profile page as a clickable link. |  | MaxLength: 255 <br />Optional: \{\} <br /> |
 | `plan` _string_ | Plan indicates the GitHub plan tier for this organization (enterprise, team, or free).<br />Determines whether Enterprise-only features (e.g., custom properties, runner groups) are reconciled or skipped. | enterprise | Enum: [enterprise team free] <br />Optional: \{\} <br /> |
 

docs/crds.md

@@ -5,6 +5,8 @@ import (
 	"fmt"
 	"os"
 
+	githubv1alpha1 "github.com/Interhyp/git-hubby/api/v1alpha1"
+	"sigs.k8s.io/controller-runtime/pkg/client"
 	logPkg "sigs.k8s.io/controller-runtime/pkg/log"
 )
 
@@ -14,6 +16,22 @@ func (t *GitHubTeamReconciler) reconcileTeamMembers(ctx context.Context) error {
 	if t.Kubernetes.Resource.IsIDPTeam() {
 		return nil // IDP teams manage members via the identity provider
 	}
+
+	envMemberSuffix := os.Getenv("GITHUB_MEMBER_SUFFIX")
+	k8sOrgs := make(map[string]githubv1alpha1.Organization)
+	if envMemberSuffix == "" {
+		// need to fetch orgs to check for org specific memberSuffixes later
+		for _, orgRef := range t.Kubernetes.Resource.Spec.OrganizationRefs {
+			var org githubv1alpha1.Organization
+			if err := t.Kubernetes.Client.Get(ctx, client.ObjectKey{Name: orgRef.Name, Namespace: t.Kubernetes.Resource.Namespace}, &org); err != nil {
+				log.Error(err, "unable to fetch Organization for Team", "organization", orgRef)
+				return err
+			}
+			// index by GitHub login for easier mapping
+			k8sOrgs[org.GetLogin()] = org
+		}
+	}
+
 	for _, githubOrg := range t.Team.Organizations.Current {
 		log = log.WithValues("organization", githubOrg.Resource)
 
@@ -32,8 +50,12 @@ func (t *GitHubTeamReconciler) reconcileTeamMembers(ctx context.Context) error {
 			}
 		}
 
+		memberSuffix := envMemberSuffix
+		if org, ok := k8sOrgs[githubOrg.Resource]; ok {
+			memberSuffix = org.Spec.MemberSuffix
+		}
+
 		for _, memberRef := range t.Kubernetes.Resource.Spec.Members {
-			memberSuffix := os.Getenv("GITHUB_MEMBER_SUFFIX")
 			memberRef += memberSuffix
 			log := log.WithValues("member", memberRef)
 			log.V(1).Info("Processing member")