CLOUDFLAREAPI: Add support for record comments and tags #4025
+444
−18
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Introducing the following Cloudflare-specific modifiers: - CF_MANAGE_COMMENTS - Domain modifier to opt into comment syncing - CF_MANAGE_TAGS - Domain modifier to opt into tag syncing - CF_COMMENT(comment) - Set a comment on a record (works on all plans) - CF_TAGS(tag1, tag2, ...) - Set tags on a record (requires paid plan) Features: - Comments and tags are read from API and displayed in get-zones output - Validation ensures CF_COMMENT/CF_TAGS require management flags enabled - Tags with reserved 'cf-' prefix are rejected - get-zones --format=js/djs auto-adds management flags when needed - Integration tests for comments (always run) and tags (-cftags flag)
Contributor
Author
|
@tlimoncelli should tags and CNAME flattening tests have a single gate ( |
Collaborator
Excellent question! Keep them separate, please. Even with a fully paid enterprise account, you can create API keys that are restricted to only support particular features. |
Contributor
Author
|
OK, ready for review then. I tested it manually quite a bit on a paid zone. I haven't tested comments alone on a free zone, I just realized. I'll do that now. |
tlimoncelli
reviewed
Jan 28, 2026
Comment on lines
+1253
to
+1269
| testgroup("CF_COMMENT create", | ||
| only("CLOUDFLAREAPI"), | ||
| domainMeta(map[string]string{"cloudflare_manage_comments": "true"}), | ||
| CfCommentCreate(), tcEmptyZone(), | ||
| ), | ||
|
|
||
| testgroup("CF_COMMENT change", | ||
| only("CLOUDFLAREAPI"), | ||
| domainMeta(map[string]string{"cloudflare_manage_comments": "true"}), | ||
| CfCommentCreate(), CfCommentChange(), | ||
| ), | ||
|
|
||
| testgroup("CF_COMMENT remove", | ||
| only("CLOUDFLAREAPI"), | ||
| domainMeta(map[string]string{"cloudflare_manage_comments": "true"}), | ||
| CfCommentCreate(), CfCommentRemove(), | ||
| ), |
Collaborator
There was a problem hiding this comment.
These can be combined. No need to clear the zone between tests. (for example, testgroup("MX" does it all in one group)
Suggested change
| testgroup("CF_COMMENT create", | |
| only("CLOUDFLAREAPI"), | |
| domainMeta(map[string]string{"cloudflare_manage_comments": "true"}), | |
| CfCommentCreate(), tcEmptyZone(), | |
| ), | |
| testgroup("CF_COMMENT change", | |
| only("CLOUDFLAREAPI"), | |
| domainMeta(map[string]string{"cloudflare_manage_comments": "true"}), | |
| CfCommentCreate(), CfCommentChange(), | |
| ), | |
| testgroup("CF_COMMENT remove", | |
| only("CLOUDFLAREAPI"), | |
| domainMeta(map[string]string{"cloudflare_manage_comments": "true"}), | |
| CfCommentCreate(), CfCommentRemove(), | |
| ), | |
| testgroup("CF_COMMENT create", | |
| only("CLOUDFLAREAPI"), | |
| domainMeta(map[string]string{"cloudflare_manage_comments": "true"}), | |
| CfCommentCreate(), | |
| CfCommentChange(), | |
| CfCommentRemove(), | |
| ), |
Comment on lines
+1273
to
+1293
| testgroup("CF_TAGS create", | ||
| only("CLOUDFLAREAPI"), | ||
| alltrue(*enableCFTags), | ||
| domainMeta(map[string]string{"cloudflare_manage_tags": "true"}), | ||
| CfTagsCreate(), tcEmptyZone(), | ||
| ), | ||
|
|
||
| testgroup("CF_TAGS change", | ||
| only("CLOUDFLAREAPI"), | ||
| alltrue(*enableCFTags), | ||
| domainMeta(map[string]string{"cloudflare_manage_tags": "true"}), | ||
| CfTagsCreate(), CfTagsChange(), | ||
| ), | ||
|
|
||
| testgroup("CF_TAGS remove", | ||
| only("CLOUDFLAREAPI"), | ||
| alltrue(*enableCFTags), | ||
| domainMeta(map[string]string{"cloudflare_manage_tags": "true"}), | ||
| CfTagsCreate(), CfTagsRemove(), | ||
| ), | ||
|
|
Collaborator
There was a problem hiding this comment.
Consolidate these:
Suggested change
| testgroup("CF_TAGS create", | |
| only("CLOUDFLAREAPI"), | |
| alltrue(*enableCFTags), | |
| domainMeta(map[string]string{"cloudflare_manage_tags": "true"}), | |
| CfTagsCreate(), tcEmptyZone(), | |
| ), | |
| testgroup("CF_TAGS change", | |
| only("CLOUDFLAREAPI"), | |
| alltrue(*enableCFTags), | |
| domainMeta(map[string]string{"cloudflare_manage_tags": "true"}), | |
| CfTagsCreate(), CfTagsChange(), | |
| ), | |
| testgroup("CF_TAGS remove", | |
| only("CLOUDFLAREAPI"), | |
| alltrue(*enableCFTags), | |
| domainMeta(map[string]string{"cloudflare_manage_tags": "true"}), | |
| CfTagsCreate(), CfTagsRemove(), | |
| ), | |
| testgroup("CF_TAGS create", | |
| only("CLOUDFLAREAPI"), | |
| alltrue(*enableCFTags), | |
| domainMeta(map[string]string{"cloudflare_manage_tags": "true"}), | |
| CfTagsCreate(), | |
| CfTagsChange(), | |
| CfTagsRemove(), | |
| ), | |
| // Helper constants/funcs for the CLOUDFLARE comments testing: | ||
|
|
||
| // A-record with comment | ||
| func CfCommentCreate() *TestCase { |
Collaborator
There was a problem hiding this comment.
Now that CfCommentCreate() and friends are only used once, please inline them. That has the benefit of making the test data more visible.
tlimoncelli
reviewed
Jan 28, 2026
| if comment, ok := rec.Metadata["cloudflare_comment"]; ok && comment != "" { | ||
| hasComments = true | ||
| } | ||
| if tags, ok := rec.Metadata["cloudflare_tags"]; ok && tags != "" { |
Collaborator
There was a problem hiding this comment.
rec.Metadata["cloudflare_tags"] returns "" if there is no "cloudflare_tags" key. It seems like the "ok" checking is overkill.
This would make CF_TAGS("") and not having any tags be equivalent. (which is a good thing. I think?)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Introduced the following Cloudflare-specific modifiers:
Features:
Fixes #1862