Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix link to report card #99

Merged
merged 6 commits into from
Sep 23, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -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
Expand Down
29 changes: 16 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,21 +3,24 @@
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)
[![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)

## 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.

Expand Down Expand Up @@ -55,9 +58,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

Expand Down
2 changes: 1 addition & 1 deletion tsigkeys_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -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
}
})
Expand Down