From 30ac29053b037e68814383ccd3f18ed8ddc84dcf Mon Sep 17 00:00:00 2001 From: Johannes Eiglsperger Date: Mon, 23 Sep 2024 16:43:17 +0200 Subject: [PATCH 1/6] Fix link to report card --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 5c7391a..e8a37b4 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ This community project provides bindings for PowerDNS Authoritative Server. It's not associated with the official PowerDNS product itself. [![Test coverage](https://img.shields.io/badge/coverage-100%25-success)](https://github.com/joeig/go-powerdns/tree/master/.github/testcoverage.yml) -[![Go Report Card](https://goreportcard.com/badge/github.com/joeig/go-powerdns)](https://goreportcard.com/report/github.com/joeig/go-powerdns) +[![Go Report Card](https://goreportcard.com/badge/github.com/joeig/go-powerdns/v3)](https://goreportcard.com/report/github.com/joeig/go-powerdns/v3) [![PkgGoDev](https://pkg.go.dev/badge/github.com/joeig/go-powerdns/v3)](https://pkg.go.dev/github.com/joeig/go-powerdns/v3) ## Features From f3c9a7d5d67adcc844b206f78e709c8fcb9a9690 Mon Sep 17 00:00:00 2001 From: Johannes Eiglsperger Date: Mon, 23 Sep 2024 16:43:28 +0200 Subject: [PATCH 2/6] Bump copyright year --- LICENSE | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/LICENSE b/LICENSE index 5f612b3..6b41868 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ MIT License -Copyright (c) 2021 Johannes Eiglsperger +Copyright (c) 2024 Johannes Eiglsperger Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal From 8da380082c1b955f5d8ea363b6baf240e448ba97 Mon Sep 17 00:00:00 2001 From: Johannes Eiglsperger Date: Mon, 23 Sep 2024 16:43:56 +0200 Subject: [PATCH 3/6] Fix misspelling --- tsigkeys_test.go | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tsigkeys_test.go b/tsigkeys_test.go index 51e7bc9..0cf9aba 100644 --- a/tsigkeys_test.go +++ b/tsigkeys_test.go @@ -278,7 +278,7 @@ func TestDeleteTSIGKey(t *testing.T) { t.Run("Remove existing TSIG Key", func(t *testing.T) { err := p.TSIGKeys.Delete(context.Background(), *existingTSIGKey.ID) if err != nil { - t.Errorf("expected successfull delete got error: %v", err) + t.Errorf("expected successful delete got error: %v", err) return } }) From f23c474b18f54d12883832368915d223beea3b9d Mon Sep 17 00:00:00 2001 From: Johannes Eiglsperger Date: Mon, 23 Sep 2024 16:47:24 +0200 Subject: [PATCH 4/6] Add links to features --- README.md | 20 +++++++++++--------- 1 file changed, 11 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index e8a37b4..e57b1e9 100644 --- a/README.md +++ b/README.md @@ -9,15 +9,17 @@ It's not associated with the official PowerDNS product itself. ## Features -* Conveniently manage - * zones - * resource records - * cryptokeys - * TSIG keys - * servers - * statistics - * configuration -* It works entirely with the Go standard library and can easily be customized.[^1] +Conveniently manage + +* [zones](https://github.com/joeig/go-powerdns?tab=readme-ov-file#getaddchangedelete-zones) +* [resource records](https://github.com/joeig/go-powerdns?tab=readme-ov-file#addchangedelete-resource-records) +* [cryptokeys](https://github.com/joeig/go-powerdns?tab=readme-ov-file#handle-dnssec-cryptographic-material) (DNSSEC) +* [TSIG keys](https://github.com/joeig/go-powerdns?tab=readme-ov-file#createchangedelete-tsig-keys) +* [servers](https://pkg.go.dev/github.com/joeig/go-powerdns/v3#ServersService) +* [statistics](https://github.com/joeig/go-powerdns?tab=readme-ov-file#request-server-information-and-statistics) +* [configuration](https://pkg.go.dev/github.com/joeig/go-powerdns/v3#ConfigService) + +It works entirely with the Go standard library and can easily be customized.[^1] [^1]: There is a dependency for `github.com/jarcoal/httpmock`, which is used by the test suite. From 733ae7fe44b384b13972754b87f04f9c47ce42db Mon Sep 17 00:00:00 2001 From: Johannes Eiglsperger Date: Mon, 23 Sep 2024 16:49:29 +0200 Subject: [PATCH 5/6] Wording of the migration note --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index e57b1e9..aebdfe6 100644 --- a/README.md +++ b/README.md @@ -57,9 +57,9 @@ pdns := powerdns.New("http://localhost:80", "localhost", powerdns.WithAPIKey("ap ctx := context.Background() ``` -#### Migrating `NewClient` to `New` +#### Migrate `NewClient` to `New` -See the [release notes for v3.13.0](https://github.com/joeig/go-powerdns/releases/tag/v3.13.0). +If you have used `NewClient` before and want to migrate to `New`, please see the [release notes for v3.13.0](https://github.com/joeig/go-powerdns/releases/tag/v3.13.0). ### Get/add/change/delete zones From 364b38746b1b299cf5b22c054431c6c56b772839 Mon Sep 17 00:00:00 2001 From: Johannes Eiglsperger Date: Mon, 23 Sep 2024 16:51:23 +0200 Subject: [PATCH 6/6] Add CodeQL badge --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index aebdfe6..ee7a91d 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,8 @@ This community project provides bindings for PowerDNS Authoritative Server. It's not associated with the official PowerDNS product itself. -[![Test coverage](https://img.shields.io/badge/coverage-100%25-success)](https://github.com/joeig/go-powerdns/tree/master/.github/testcoverage.yml) +[![Test coverage](https://img.shields.io/badge/coverage-100%25-success)](https://github.com/joeig/go-powerdns/blob/main/.github/testcoverage.yml) +[![CodeQL](https://github.com/joeig/go-powerdns/actions/workflows/github-code-scanning/codeql/badge.svg)](https://github.com/joeig/go-powerdns/actions/workflows/github-code-scanning/codeql) [![Go Report Card](https://goreportcard.com/badge/github.com/joeig/go-powerdns/v3)](https://goreportcard.com/report/github.com/joeig/go-powerdns/v3) [![PkgGoDev](https://pkg.go.dev/badge/github.com/joeig/go-powerdns/v3)](https://pkg.go.dev/github.com/joeig/go-powerdns/v3)