Merge pull request #77 from ConductorOne/mbburch/update-sdk-v0_3_10

Update baton-sdk to v0.3.10 and remove sorting from output_config

Author: MB Burch

.github/workflows/output_config.yaml

@@ -25,9 +25,7 @@ jobs:
         run: go build -o connector ./cmd/baton-github
 
       - name: Run and save output
-        # Sort the fields array by name to ensure consistent ordering
-        run: |
-          ./connector config | jq '.fields |= sort_by(.name)' > config_schema.json
+        run: ./connector config > config_schema.json
 
       - name: Commit changes
         uses: EndBug/add-and-commit@v9

go.mod

@@ -3,7 +3,7 @@ module github.com/conductorone/baton-github
 go 1.23.4
 
 require (
-	github.com/conductorone/baton-sdk v0.3.8
+	github.com/conductorone/baton-sdk v0.3.10
 	github.com/deckarep/golang-set/v2 v2.8.0
 	github.com/ennyjfrick/ruleguard-logfatal v0.0.2
 	github.com/golang-jwt/jwt/v5 v5.2.2

go.sum

@@ -58,8 +58,8 @@ github.com/cenkalti/backoff/v4 v4.3.0/go.mod h1:Y3VNntkOUPxTVeUxJ/G5vcM//AlwfmyY
 github.com/census-instrumentation/opencensus-proto v0.2.1/go.mod h1:f6KPmirojxKA12rnyqOA5BBL4O983OfeGPqjHWSTneU=
 github.com/client9/misspell v0.3.4/go.mod h1:qj6jICC3Q7zFZvVWo7KLAzC3yx5G7kyvSDkc90ppPyw=
 github.com/cncf/udpa/go v0.0.0-20191209042840-269d4d468f6f/go.mod h1:M8M6+tZqaGXZJjfX53e64911xZQV5JYwmTeXPW+k8Sc=
-github.com/conductorone/baton-sdk v0.3.8 h1:AuRBGVbgw8TcDPix7Ho7qwMucsPqP8hIh2lABUbY7Xg=
-github.com/conductorone/baton-sdk v0.3.8/go.mod h1:lWZHgu025Rsgs5jvBrhilGti0zWF2+YfaFY/bWOS/g0=
+github.com/conductorone/baton-sdk v0.3.10 h1:e1J0Y2knHTbzn9bAsjElmhv5lRpYwI6ixw0Ak+gx0JY=
+github.com/conductorone/baton-sdk v0.3.10/go.mod h1:lWZHgu025Rsgs5jvBrhilGti0zWF2+YfaFY/bWOS/g0=
 github.com/conductorone/dpop v0.2.3 h1:s91U3845GHQ6P6FWrdNr2SEOy1ES/jcFs1JtKSl2S+o=
 github.com/conductorone/dpop v0.2.3/go.mod h1:gyo8TtzB9SCFCsjsICH4IaLZ7y64CcrDXMOPBwfq/3s=
 github.com/conductorone/dpop/integrations/dpop_grpc v0.2.3 h1:kLMCNIh0Mo2vbvvkCmJ3ixsPbXEJ6HPcW53Ku9yje3s=

pkg/config/config.go

@@ -4,30 +4,38 @@ import (
 	"github.com/conductorone/baton-sdk/pkg/field"
 )
 
+// TODO (mb): Make sure we don't need field.WithRequired(true) for required fields.
 var (
 	accessTokenField = field.StringField(
 		"token",
+		field.WithDisplayName("Personal access token"),
 		field.WithDescription("The GitHub access token used to connect to the GitHub API."),
+		field.WithIsSecret(true),
 	)
 	orgsField = field.StringSliceField(
 		"orgs",
+		field.WithDisplayName("Organizations"),
 		field.WithDescription("Limit syncing to specific organizations."),
 	)
 	instanceUrlField = field.StringField(
 		"instance-url",
+		field.WithDisplayName("GitHub instance URL"),
 		field.WithDescription(`The GitHub instance URL to connect to. (default "https://github.com")`),
 	)
 	appIDField = field.StringField(
 		"app-id",
+		field.WithDisplayName("GitHub App ID"),
 		field.WithDescription("The GitHub App to connect to."),
 	)
 
 	appPrivateKeyPath = field.StringField(
 		"app-privatekey-path",
+		field.WithDisplayName("GitHub App private key (.pem)"),
 		field.WithDescription("Path to private key that is used to connect to the GitHub App"),
 	)
 	syncSecrets = field.BoolField(
 		"sync-secrets",
+		field.WithDisplayName("Sync secrets"),
 		field.WithDescription(`Whether to sync secrets or not`),
 	)
 	fieldRelationships = []field.SchemaFieldRelationship{
@@ -43,11 +51,17 @@ var (
 )
 
 //go:generate go run ./gen
-var Config = field.NewConfiguration([]field.SchemaField{
-	accessTokenField,
-	orgsField,
-	instanceUrlField,
-	syncSecrets,
-	appIDField,
-	appPrivateKeyPath,
-}, fieldRelationships...)
+var Config = field.NewConfiguration(
+	[]field.SchemaField{
+		accessTokenField,
+		orgsField,
+		instanceUrlField,
+		syncSecrets,
+		appIDField,
+		appPrivateKeyPath,
+	},
+	field.WithConstraints(fieldRelationships...),
+	field.WithConnectorDisplayName("GitHub v2"),
+	field.WithHelpUrl("/docs/baton/github-v2"),
+	field.WithIconUrl("/static/app-icons/github.svg"),
+)