Skip to content

Commit

Permalink
docs: get ready for version 1.14.1 (#928)
Browse files Browse the repository at this point in the history
  • Loading branch information
favonia authored Sep 13, 2024
1 parent 729b661 commit dbde79b
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 2 deletions.
13 changes: 13 additions & 0 deletions CHANGELOG.markdown
Original file line number Diff line number Diff line change
@@ -1,3 +1,16 @@
# [1.14.1](https://github.com/favonia/cloudflare-ddns/compare/v1.14.0...v1.14.1) (2024-09-13)

This is a minor release that addresses minor issues and improves the usability of the new feature for managing WAF lists, which was initially introduced in version 1.14.0.

### Bug Fixes

- reduce unnecessary quotation marks in logging ([#925](https://github.com/favonia/cloudflare-ddns/issues/925)) ([dc3a26b](https://github.com/favonia/cloudflare-ddns/commit/dc3a26b18c92990e9fe4d2a4d5e6d47ea6153ffb))

### Features

- **api:** clear a WAF list when it cannot be deleted ([#908](https://github.com/favonia/cloudflare-ddns/issues/908)) ([1acf11d](https://github.com/favonia/cloudflare-ddns/commit/1acf11d311addfc504695c788213226b51e5b89b))
- **api:** warn about mismatched attributes ([#921](https://github.com/favonia/cloudflare-ddns/issues/921)) ([80388a0](https://github.com/favonia/cloudflare-ddns/commit/80388a0959c6828fde2ee55b90100b215ccbeed6))

# [1.14.0](https://github.com/favonia/cloudflare-ddns/compare/v1.13.2...v1.14.0) (2024-08-25)

This is a major release with many improvements! The most significant new feature is the ability to maintain a [WAF list](https://developers.cloudflare.com/waf/tools/lists/) of detected IP addresses; you can then refer to the list in your firewall rules. Please consult the [README](./README.markdown). The second most important update is to use a variant of [the Happy Eyeballs (Fast Fallback) algorithm](https://en.wikipedia.org/wiki/Happy_Eyeballs) to detect the blockage of 1.1.1.1. As the name of the new algorithm suggests, you should not notice any delay due to the detection, being happy. 😄
Expand Down
4 changes: 2 additions & 2 deletions docs/DESIGN.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -29,10 +29,10 @@ The source code follows the [standard Go project layout](https://github.com/gola

Here is some arbitrary coding convention that I chose to follow. It may change in the future, but the whole codebase should be consistent with it at any time:

1. These are in general not quoted in the logging because they use only “safe” characters and usually do not cause confusion in a textual context; the formatter `%s` should be used instead of `%q`:
1. These values are generally not enclosed in quotation marks within the logs because they only contain “safe” characters and typically do not lead to misunderstandings without them. The `%s` formatter should be used instead of `%q` for these values.
- Cloudflare IDs (DNS zone IDs, DNS record IDs, WAF list IDs, etc.)
- Domain names
- Full list references (`account/name`)
- Full WAF list references (`account/name`)
2. A variable of type `map[..]...` should not be named in a plural form just because it is of type `map[...]...`. For example, a mapping from IP networks to detected IPs should be named `detectedIP` not `detectedIPs`.

## Network Security Threat Model
Expand Down

0 comments on commit dbde79b

Please sign in to comment.