Skip to content

Commit

Permalink
go update & unstable => stable (#18)
Browse files Browse the repository at this point in the history
* ci: update ci version to 1.23
* Updating README.md
* Running tests and linter with go 1.21 and latest stable
  • Loading branch information
FranciscoKurpiel authored Nov 8, 2024
1 parent ef6ba81 commit a6bbb91
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 8 deletions.
6 changes: 3 additions & 3 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ jobs:
test:
strategy:
matrix:
go: ["1.21"]
go: ["1.21", "stable"]
name: test
runs-on: ubuntu-latest
steps:
Expand All @@ -31,8 +31,8 @@ jobs:
golangci:
strategy:
matrix:
go: ["1.21"]
lint: ["v1.55.2"]
go: ["1.21", "stable"]
lint: ["v1.61.0"]
name: lint
runs-on: ubuntu-latest
steps:
Expand Down
17 changes: 14 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,19 +3,30 @@

## About

Non-Official GO CloudFlare DNS API client for go. It was created because
Non-Official GO CloudFlare DNS API client. It was created because
the official API is not stable and breaks its consumers multiple times
a year. Some of the breaks are immediately apparent because the compiler
itself can find the problem, sometimes the expectation can't be detected
automatically, while when the returned error is changed, leading to
unexpected behavior in code that might be mission-critical.

This library is being used on a system that manages dozens of domains with
thousands of records, and makes hundreds of changes per day. It show up to
be reliable, and eliminating multiple issues that were present when the
official library was being used.

The original library also has an implementation that requires an unbounded
amount of memory when listing records. This implementation is `O(1)` in
memory for all operations.

Exponential back-off is implemented and heavily tested.

This library was designed to support only the DNS service.

## Project Status

This project is in pre-release stage and backwards compatibility is not
guaranteed.
This version is stable, being used in production. It will provide backwards
compatibility according to go module conventions.

## How to Get

Expand Down
2 changes: 0 additions & 2 deletions go.mod
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@ module github.com/simplesurance/cfdns

go 1.21

toolchain go1.21.4

require (
github.com/fatih/color v1.18.0
golang.org/x/exp v0.0.0-20231110203233-9a3e6036ecaa
Expand Down

0 comments on commit a6bbb91

Please sign in to comment.