dnscontrol/build/generate/ownersFile.go
Tom Limoncelli 7ab7d147fb
CHORE: Move non-provider code out of /providers (#3916)
# Issue

Fixes https://github.com/StackExchange/dnscontrol/issues/3912

# Resolution

```
#!/bin/sh

# Reset

git fetch origin main
git reset --hard origin/main
git checkout main
git branch -D tlim_moveproviders
git checkout -b tlim_moveproviders
find . -name \*.bak -delete

# Move the *.go files out of providers/

mkdir -p pkg/providers
git mv providers/*.go pkg/providers

# move the _all file out of providers/

git mv providers/_all pkg/providers/_all

# Update the imports (in go.* and the affected files)

sed -i.bak -e 's@"github.com/StackExchange/dnscontrol/v4/providers"@"github.com/StackExchange/dnscontrol/v4/pkg/providers"@g' go.* $(fgrep -lr --include '*.go' '"github.com/StackExchange/dnscontrol/v4/providers"' *)
sed -i.bak -e 's@"../../providers"@"../../pkg/providers"@g' pkg/normalize/capabilities_test.go
sed -i.bak -e 's@"github.com/StackExchange/dnscontrol/v4/providers/_all"@"github.com/StackExchange/dnscontrol/v4/pkg/providers/_all"@g' go.* $(fgrep -lr --include '*.go' '"github.com/StackExchange/dnscontrol/v4/providers/_all"' *)

# Fix the docs

sed -i.bak -e 's@StackExchange/dnscontrol/blob/main/providers/_all/all.go@StackExchange/dnscontrol/blob/main/pkg/providers/_all/all.go@g' documentation/advanced-features/writing-providers.md
sed -i.bak -e 's@StackExchange/dnscontrol/providers@StackExchange/dnscontrol/pkg/providers@g' documentation/advanced-features/writing-providers.md
sed -i.bak -e 's@StackExchange/dnscontrol/v4/providers@StackExchange/dnscontrol/v4/pkg/providers@g' documentation/advanced-features/writing-providers.md
sed -i.bak -e 's@dnscontrol/providers/providers.go@dnscontrol/pkg/providers/providers.go@g' documentation/advanced-features/writing-providers.md
sed -i.bak -e 's@providers/_all/all.go@pkg/providers/_all/all.go@g' documentation/advanced-features/writing-providers.md
#sed -i.bak -e 's@@@g' documentation/advanced-features/writing-providers.md
#sed -i.bak -e 's@@@g' documentation/advanced-features/writing-providers.md

find . -name \*.bak -delete

go fmt ./...

git status

echo git commit -a -m'CHORE: Move Non-provider files in providers to pkg/providers'



```
2025-12-15 12:53:52 -05:00

69 lines
1.6 KiB
Go

package main
import (
"os"
"sort"
"strings"
"github.com/StackExchange/dnscontrol/v4/pkg/providers"
)
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
}