BUILD: Generate OWNERS files (StackExchange#2997)

build/generate/generate.go

@@ -6,6 +6,9 @@ func main() {
 	if err := generateFeatureMatrix(); err != nil {
 		log.Fatal(err)
 	}
+	if err := generateOwnersFile(); err != nil {
+		log.Fatal(err)
+	}
 	funcs, err := generateFunctionTypes()
 	if err != nil {
 		log.Fatal(err)

build/generate/ownersFile.go

@@ -0,0 +1,68 @@
+package main
+
+import (
+	"github.com/StackExchange/dnscontrol/v4/providers"
+	"os"
+	"sort"
+	"strings"
+)
+
+func generateOwnersFile() error {
+	maintainers := providers.ProviderMaintainers
+	sortedProviderNames := getSortedProviderNames(maintainers)
+
+	var ownersData strings.Builder
+	for _, providerName := range sortedProviderNames {
+		providerMaintainer := maintainers[providerName]
+		if providerMaintainer == "NEEDS VOLUNTEER" {
+			ownersData.WriteString("# ")
+		}
+		ownersData.WriteString("providers/")
+		ownersData.WriteString(getProviderDirectory(providerName))
+		ownersData.WriteString(" ")
+		ownersData.WriteString(providerMaintainer)
+		ownersData.WriteString("\n")
+	}
+
+	file, err := os.Create("OWNERS")
+	if err != nil {
+		return err
+	}
+	defer file.Close()
+
+	_, err = file.WriteString(ownersData.String())
+	if err != nil {
+		return err
+	}
+
+	return nil
+}
+
+func getProviderDirectory(providerName string) string {
+	// Strip the underscores from the providerName constants
+	providerDirectory := strings.ToLower(
+		strings.ReplaceAll(
+			providerName, "_", "",
+		),
+	)
+
+	// These providers use a different directory name
+	if providerDirectory == "cloudflareapi" {
+		providerDirectory = "cloudflare"
+	}
+	if providerDirectory == "dnsoverhttps" {
+		providerDirectory = "doh"
+	}
+
+	return providerDirectory
+}
+
+func getSortedProviderNames(maintainers map[string]string) []string {
+	providerNameSorted := make([]string, 0, len(maintainers))
+	for providerNameKey := range maintainers {
+		providerNameSorted = append(providerNameSorted, providerNameKey)
+	}
+	sort.Strings(providerNameSorted)
+
+	return providerNameSorted
+}

documentation/writing-providers.md

@@ -224,8 +224,6 @@ an automated way to test for this bug.  The manual steps are here in
   * Add the provider to the "Providers" list.
 * Create `documentation/provider/PROVIDERNAME.md`:
   * Use one of the other files in that directory as a base.
-* Edit `OWNERS`:
-  * Add the directory name and your GitHub username.
 
 {% hint style="success" %}
 **Need feedback?** Submit a draft PR!  It's a great way to get early feedback, ask about fixing

main.go

@@ -10,7 +10,7 @@ import (
 	"github.com/fatih/color"
 )
 
-//go:generate go run build/generate/generate.go build/generate/featureMatrix.go build/generate/functionTypes.go build/generate/dtsFile.go
+//go:generate go run build/generate/generate.go build/generate/featureMatrix.go build/generate/functionTypes.go build/generate/dtsFile.go build/generate/ownersFile.go
 
 // Version management. Goals:
 // 1. Someone who just does "go get" has at least some information.

providers/akamaiedgedns/akamaiEdgeDnsProvider.go

@@ -49,12 +49,15 @@ type edgeDNSProvider struct {
 }
 
 func init() {
+	const providerName = "AKAMAIEDGEDNS"
+	const providerMaintainer = "@edglynes"
 	fns := providers.DspFuncs{
 		Initializer:   newEdgeDNSDSP,
 		RecordAuditor: AuditRecords,
 	}
-	providers.RegisterDomainServiceProviderType("AKAMAIEDGEDNS", fns, features)
-	providers.RegisterCustomRecordType("AKAMAICDN", "AKAMAIEDGEDNS", "")
+	providers.RegisterDomainServiceProviderType(providerName, fns, features)
+	providers.RegisterCustomRecordType("AKAMAICDN", providerName, "")
+	providers.RegisterMaintainer(providerName, providerMaintainer)
 }
 
 // DnsServiceProvider

providers/autodns/autoDnsProvider.go

@@ -37,11 +37,14 @@ type autoDNSProvider struct {
 }
 
 func init() {
+	const providerName = "AUTODNS"
+	const providerMaintainer = "@arnoschoon"
 	fns := providers.DspFuncs{
 		Initializer:   New,
 		RecordAuditor: AuditRecords,
 	}
-	providers.RegisterDomainServiceProviderType("AUTODNS", fns, features)
+	providers.RegisterDomainServiceProviderType(providerName, fns, features)
+	providers.RegisterMaintainer(providerName, providerMaintainer)
 }
 
 // New creates a new API handle.

providers/axfrddns/axfrddnsProvider.go

@@ -172,11 +172,14 @@ func initAxfrDdns(config map[string]string, providermeta json.RawMessage) (provi
 }
 
 func init() {
+	const providerName = "AXFRDDNS"
+	const providerMaintainer = "@hnrgrgr"
 	fns := providers.DspFuncs{
 		Initializer:   initAxfrDdns,
 		RecordAuditor: AuditRecords,
 	}
-	providers.RegisterDomainServiceProviderType("AXFRDDNS", fns, features)
+	providers.RegisterDomainServiceProviderType(providerName, fns, features)
+	providers.RegisterMaintainer(providerName, providerMaintainer)
 }
 
 // Param is used to decode extra parameters sent to provider.

providers/azuredns/azureDnsProvider.go

@@ -78,12 +78,15 @@ var features = providers.DocumentationNotes{
 }
 
 func init() {
+	const providerName = "AZURE_DNS"
+	const providerMaintainer = "@vatsalyagoel"
 	fns := providers.DspFuncs{
 		Initializer:   newAzureDNSDsp,
 		RecordAuditor: AuditRecords,
 	}
-	providers.RegisterDomainServiceProviderType("AZURE_DNS", fns, features)
-	providers.RegisterCustomRecordType("AZURE_ALIAS", "AZURE_DNS", "")
+	providers.RegisterDomainServiceProviderType(providerName, fns, features)
+	providers.RegisterCustomRecordType("AZURE_ALIAS", providerName, "")
+	providers.RegisterMaintainer(providerName, providerMaintainer)
 }
 
 func (a *azurednsProvider) getExistingZones() ([]*adns.Zone, error) {

providers/azureprivatedns/azurePrivateDnsProvider.go

@@ -82,12 +82,15 @@ var features = providers.DocumentationNotes{
 }
 
 func init() {
+	const providerName = "AZURE_PRIVATE_DNS"
+	const providerMaintainer = "@matthewmgamble"
 	fns := providers.DspFuncs{
 		Initializer:   newAzureDNSDsp,
 		RecordAuditor: AuditRecords,
 	}
-	providers.RegisterDomainServiceProviderType("AZURE_PRIVATE_DNS", fns, features)
-	providers.RegisterCustomRecordType("AZURE_ALIAS", "AZURE_PRIVATE_DNS", "")
+	providers.RegisterDomainServiceProviderType(providerName, fns, features)
+	providers.RegisterCustomRecordType("AZURE_ALIAS", providerName, "")
+	providers.RegisterMaintainer(providerName, providerMaintainer)
 }
 
 func (a *azurednsProvider) getExistingZones() ([]*adns.PrivateZone, error) {

providers/bind/bindProvider.go

@@ -93,11 +93,14 @@ func initBind(config map[string]string, providermeta json.RawMessage) (providers
 }
 
 func init() {
+	const providerName = "BIND"
+	const providerMaintainer = "@tlimoncelli"
 	fns := providers.DspFuncs{
 		Initializer:   initBind,
 		RecordAuditor: AuditRecords,
 	}
-	providers.RegisterDomainServiceProviderType("BIND", fns, features)
+	providers.RegisterDomainServiceProviderType(providerName, fns, features)
+	providers.RegisterMaintainer(providerName, providerMaintainer)
 }
 
 // SoaDefaults contains the parts of the default SOA settings.

providers/bunnydns/bunnydnsProvider.go

@@ -37,11 +37,14 @@ type bunnydnsProvider struct {
 }
 
 func init() {
+	const providerName = "BUNNY_DNS"
+	const providerMaintainer = "@ppmathis"
 	fns := providers.DspFuncs{
 		Initializer:   newBunnydns,
 		RecordAuditor: AuditRecords,
 	}
-	providers.RegisterDomainServiceProviderType("BUNNY_DNS", fns, features)
+	providers.RegisterDomainServiceProviderType(providerName, fns, features)
+	providers.RegisterMaintainer(providerName, providerMaintainer)
 }
 
 func newBunnydns(settings map[string]string, _ json.RawMessage) (providers.DNSServiceProvider, error) {

providers/cloudflare/cloudflareProvider.go

@@ -64,14 +64,17 @@ var features = providers.DocumentationNotes{
 }
 
 func init() {
+	const providerName = "CLOUDFLAREAPI"
+	const providerMaintainer = "@tresni"
 	fns := providers.DspFuncs{
 		Initializer:   newCloudflare,
 		RecordAuditor: AuditRecords,
 	}
-	providers.RegisterDomainServiceProviderType("CLOUDFLAREAPI", fns, features)
-	providers.RegisterCustomRecordType("CF_REDIRECT", "CLOUDFLAREAPI", "")
-	providers.RegisterCustomRecordType("CF_TEMP_REDIRECT", "CLOUDFLAREAPI", "")
-	providers.RegisterCustomRecordType("CF_WORKER_ROUTE", "CLOUDFLAREAPI", "")
+	providers.RegisterDomainServiceProviderType(providerName, fns, features)
+	providers.RegisterCustomRecordType("CF_REDIRECT", providerName, "")
+	providers.RegisterCustomRecordType("CF_TEMP_REDIRECT", providerName, "")
+	providers.RegisterCustomRecordType("CF_WORKER_ROUTE", providerName, "")
+	providers.RegisterMaintainer(providerName, providerMaintainer)
 }
 
 // cloudflareProvider is the handle for API calls.

providers/cloudns/cloudnsProvider.go

@@ -57,12 +57,15 @@ var features = providers.DocumentationNotes{
 }
 
 func init() {
+	const providerName = "CLOUDNS"
+	const providerMaintainer = "@pragmaton"
 	fns := providers.DspFuncs{
 		Initializer:   NewCloudns,
 		RecordAuditor: AuditRecords,
 	}
-	providers.RegisterDomainServiceProviderType("CLOUDNS", fns, features)
-	providers.RegisterCustomRecordType("CLOUDNS_WR", "CLOUDNS", "")
+	providers.RegisterDomainServiceProviderType(providerName, fns, features)
+	providers.RegisterCustomRecordType("CLOUDNS_WR", providerName, "")
+	providers.RegisterMaintainer(providerName, providerMaintainer)
 }
 
 // GetNameservers returns the nameservers for a domain.

providers/cscglobal/cscglobalProvider.go

@@ -61,11 +61,14 @@ func newProvider(m map[string]string) (*providerClient, error) {
 }
 
 func init() {
-	providers.RegisterRegistrarType("CSCGLOBAL", newReg)
+	const providerName = "CSCGLOBAL"
+	const providerMaintainer = "@mikenz"
+	providers.RegisterRegistrarType(providerName, newReg)
 
 	fns := providers.DspFuncs{
 		Initializer:   newDsp,
 		RecordAuditor: AuditRecords,
 	}
-	providers.RegisterDomainServiceProviderType("CSCGLOBAL", fns, features)
+	providers.RegisterDomainServiceProviderType(providerName, fns, features)
+	providers.RegisterMaintainer(providerName, providerMaintainer)
 }

providers/desec/desecProvider.go

@@ -58,11 +58,14 @@ var defaultNameServerNames = []string{
 }
 
 func init() {
+	const providerName = "DESEC"
+	const providerMaintainer = "@D3luxee"
 	fns := providers.DspFuncs{
 		Initializer:   NewDeSec,
 		RecordAuditor: AuditRecords,
 	}
-	providers.RegisterDomainServiceProviderType("DESEC", fns, features)
+	providers.RegisterDomainServiceProviderType(providerName, fns, features)
+	providers.RegisterMaintainer(providerName, providerMaintainer)
 }
 
 // GetNameservers returns the nameservers for a domain.

providers/digitalocean/digitaloceanProvider.go

@@ -82,11 +82,14 @@ var features = providers.DocumentationNotes{
 }
 
 func init() {
+	const providerName = "DIGITALOCEAN"
+	const providerMaintainer = "@Deraen"
 	fns := providers.DspFuncs{
 		Initializer:   NewDo,
 		RecordAuditor: AuditRecords,
 	}
-	providers.RegisterDomainServiceProviderType("DIGITALOCEAN", fns, features)
+	providers.RegisterDomainServiceProviderType(providerName, fns, features)
+	providers.RegisterMaintainer(providerName, providerMaintainer)
 }
 
 // EnsureZoneExists creates a zone if it does not exist

providers/dnsimple/dnsimpleProvider.go

@@ -41,12 +41,15 @@ var features = providers.DocumentationNotes{
 }
 
 func init() {
-	providers.RegisterRegistrarType("DNSIMPLE", newReg)
+	const providerName = "DNSIMPLE"
+	const providerMaintainer = "@onlyhavecans"
+	providers.RegisterRegistrarType(providerName, newReg)
 	fns := providers.DspFuncs{
 		Initializer:   newDsp,
 		RecordAuditor: AuditRecords,
 	}
-	providers.RegisterDomainServiceProviderType("DNSIMPLE", fns, features)
+	providers.RegisterDomainServiceProviderType(providerName, fns, features)
+	providers.RegisterMaintainer(providerName, providerMaintainer)
 }
 
 const stateRegistered = "registered"

providers/dnsmadeeasy/dnsMadeEasyProvider.go

@@ -31,12 +31,15 @@ var features = providers.DocumentationNotes{
 }
 
 func init() {
+	const providerName = "DNSMADEEASY"
+	const providerMaintainer = "@vojtad"
 	fns := providers.DspFuncs{
 		Initializer:   New,
 		RecordAuditor: AuditRecords,
 	}
 
-	providers.RegisterDomainServiceProviderType("DNSMADEEASY", fns, features)
+	providers.RegisterDomainServiceProviderType(providerName, fns, features)
+	providers.RegisterMaintainer(providerName, providerMaintainer)
 }
 
 // New creates a new API handle.

providers/doh/dohProvider.go

@@ -24,7 +24,10 @@ var features = providers.DocumentationNotes{
 }
 
 func init() {
-	providers.RegisterRegistrarType("DNSOVERHTTPS", newDNSOverHTTPS, features)
+	const providerName = "DNSOVERHTTPS"
+	const providerMaintainer = "@mikenz"
+	providers.RegisterRegistrarType(providerName, newDNSOverHTTPS, features)
+	providers.RegisterMaintainer(providerName, providerMaintainer)
 }
 
 func newDNSOverHTTPS(m map[string]string) (providers.Registrar, error) {

providers/domainnameshop/domainnameshopProvider.go

@@ -47,12 +47,15 @@ var features = providers.DocumentationNotes{
 // Register with the dnscontrol system.
 // This establishes the name (all caps), and the function to call to initialize it.
 func init() {
+	const providerName = "DOMAINNAMESHOP"
+	const providerMaintainer = "@SimenBai"
 	fns := providers.DspFuncs{
 		Initializer:   newDomainNameShopProvider,
 		RecordAuditor: AuditRecords,
 	}
 
-	providers.RegisterDomainServiceProviderType("DOMAINNAMESHOP", fns, features)
+	providers.RegisterDomainServiceProviderType(providerName, fns, features)
+	providers.RegisterMaintainer(providerName, providerMaintainer)
 }
 
 // newDomainNameShopProvider creates a Domainnameshop specific DNS provider.

providers/dynadot/dynadotProvider.go

@@ -25,7 +25,10 @@ var features = providers.DocumentationNotes{
 }
 
 func init() {
-	providers.RegisterRegistrarType("DYNADOT", newDynadot, features)
+	const providerName = "DYNADOT"
+	const providerMaintainer = "@e-im"
+	providers.RegisterRegistrarType(providerName, newDynadot, features)
+	providers.RegisterMaintainer(providerName, providerMaintainer)
 }
 
 func newDynadot(m map[string]string) (providers.Registrar, error) {

providers/easyname/easynameProvider.go

@@ -23,7 +23,10 @@ var features = providers.DocumentationNotes{
 }
 
 func init() {
-	providers.RegisterRegistrarType("EASYNAME", newEasyname, features)
+	const providerName = "EASYNAME"
+	const providerMaintainer = "@tresni"
+	providers.RegisterRegistrarType(providerName, newEasyname, features)
+	providers.RegisterMaintainer(providerName, providerMaintainer)
 }
 
 func newEasyname(m map[string]string) (providers.Registrar, error) {