Skip to content

Commit 16ee9d1

Browse files
authored
CHORE: generate-all.sh (#4008)
<!-- ## Before submiting a pull request Please make sure you've run the following commands from the root directory. bin/generate-all.sh (this runs commands like "go generate", fixes formatting, and so on) ## Release changelog section Help keep the release changelog clear by pre-naming the proper section in the GitHub pull request title. Some examples: * CICD: Add required GHA permissions for goreleaser * DOCS: Fixed providers with "contributor support" table * ROUTE53: Allow R53_ALIAS records to enable target health evaluation More examples/context can be found in the file .goreleaser.yml under the 'build' > 'changelog' key. !-->
1 parent 081fb72 commit 16ee9d1

File tree

2 files changed

+42
-37
lines changed

2 files changed

+42
-37
lines changed

commands/types/dnscontrol.d.ts

Lines changed: 40 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -179,9 +179,9 @@ declare const DISABLE_REPEATED_DOMAIN_CHECK: RecordModifier;
179179

180180

181181
/**
182-
* A adds an A record To a domain. The name should be the relative label for the record. Use `@` for the domain apex.
182+
* `A` adds an [IPv4 Address record](https://www.rfc-editor.org/rfc/rfc1035) to a domain. The name should be the relative label for the record. Use `@` for the domain apex.
183183
*
184-
* The address should be an ip address, either a string, or a numeric value obtained via [IP](../top-level-functions/IP.md).
184+
* The address should be an IP address, either a string, or a numeric value obtained via [IP](../top-level-functions/IP.md).
185185
*
186186
* Modifiers can be any number of [record modifiers](https://docs.dnscontrol.org/language-reference/record-modifiers) or JSON objects, which will be merged into the record's metadata.
187187
*
@@ -199,7 +199,7 @@ declare const DISABLE_REPEATED_DOMAIN_CHECK: RecordModifier;
199199
declare function A(name: string, address: string | number, ...modifiers: RecordModifier[]): DomainModifier;
200200

201201
/**
202-
* AAAA adds an AAAA record To a domain. The name should be the relative label for the record. Use `@` for the domain apex.
202+
* `AAAA` adds an [IPv6 Address record](https://www.rfc-editor.org/rfc/rfc3596) to a domain. The name should be the relative label for the record. Use `@` for the domain apex.
203203
*
204204
* The address should be an IPv6 address as a string.
205205
*
@@ -410,7 +410,7 @@ declare const AUTODNSSEC_ON: DomainModifier;
410410
declare function AZURE_ALIAS(name: string, type: "A" | "AAAA" | "CNAME", target: string, ...modifiers: RecordModifier[]): DomainModifier;
411411

412412
/**
413-
* `CAA()` adds a CAA record to a domain. The name should be the relative label for the record. Use `@` for the domain apex.
413+
* `CAA` adds a [Certification Authority Authorization record](https://www.rfc-editor.org/rfc/rfc8659) to a domain. The name should be the relative label for the record. Use `@` for the domain apex.
414414
*
415415
* Tag can be one of
416416
* 1. `"issue"`
@@ -445,8 +445,9 @@ declare function AZURE_ALIAS(name: string, type: "A" | "AAAA" | "CNAME", target:
445445
declare function CAA(name: string, tag: "issue" | "issuewild" | "iodef" | "contactemail" | "contactphone" | "issuemail" | "issuevmc", value: string, ...modifiers: RecordModifier[]): DomainModifier;
446446

447447
/**
448-
* DNSControl contains a `CAA_BUILDER` which can be used to simply create
449-
* [`CAA()`](../domain-modifiers/CAA.md) records for your domains. Instead of creating each [`CAA()`](../domain-modifiers/CAA.md) record
448+
* `CAA_BUILDER` adds a [Certification Authority Authorization record](https://www.rfc-editor.org/rfc/rfc8659) to a domain.
449+
*
450+
* `CAA_BUILDER` eases the creation of [`CAA`](CAA.md) records. Instead of creating each [`CAA`](CAA.md) record
450451
* individually, you can simply configure your report mail address, the
451452
* authorized certificate authorities and the builder cares about the rest.
452453
*
@@ -469,7 +470,7 @@ declare function CAA(name: string, tag: "issue" | "issuewild" | "iodef" | "conta
469470
* );
470471
* ```
471472
*
472-
* `CAA_BUILDER()` builds multiple records:
473+
* `CAA_BUILDER` builds multiple records:
473474
*
474475
* ```javascript
475476
* D("example.com", REG_MY_PROVIDER, DnsProvider(DSP_MY_PROVIDER),
@@ -510,7 +511,7 @@ declare function CAA(name: string, tag: "issue" | "issuewild" | "iodef" | "conta
510511
* );
511512
* ```
512513
*
513-
* `CAA_BUILDER()` then builds (the same) multiple records - all with CAA_CRITICAL flag set:
514+
* `CAA_BUILDER` then builds (the same) multiple records - all with CAA_CRITICAL flag set:
514515
*
515516
* ```javascript
516517
* D("example.com", REG_MY_PROVIDER, DnsProvider(DSP_MY_PROVIDER),
@@ -555,7 +556,7 @@ declare function CAA_BUILDER(opts: { label?: string; iodef: string; iodef_critic
555556
* generate "Dynamic Single Redirects" for a limited number of use cases. See
556557
* [`CLOUDFLAREAPI`](../../provider/cloudflareapi.md) for details.
557558
*
558-
* `CF_REDIRECT` uses Cloudflare-specific features ("Forwarding URL" Page
559+
* `CF_REDIRECT` uses [Cloudflare](../../provider/cloudflareapi.md)-specific features ("Forwarding URL" Page
559560
* Rules) to generate a HTTP 301 permanent redirect.
560561
*
561562
* If _any_ `CF_REDIRECT` or [`CF_TEMP_REDIRECT`](CF_TEMP_REDIRECT.md) functions are used then
@@ -586,7 +587,7 @@ declare function CAA_BUILDER(opts: { label?: string; iodef: string; iodef_critic
586587
declare function CF_REDIRECT(source: string, destination: string, ...modifiers: RecordModifier[]): DomainModifier;
587588

588589
/**
589-
* `CF_SINGLE_REDIRECT` is a Cloudflare-specific feature for creating HTTP redirects. 301, 302, 303, 307, 308 are supported.
590+
* `CF_SINGLE_REDIRECT` is a [Cloudflare](../../provider/cloudflareapi.md)-specific feature for creating HTTP redirects. 301, 302, 303, 307, 308 are supported.
590591
* Typically one uses 302 (temporary) or 301 (permanent).
591592
*
592593
* This feature manages dynamic "Single Redirects". (Single Redirects can be
@@ -635,7 +636,7 @@ declare function CF_SINGLE_REDIRECT(name: string, code: number, when: string, th
635636
* generate "Dynamic Single Redirects" for a limited number of use cases. See
636637
* [`CLOUDFLAREAPI`](../../provider/cloudflareapi.md) for details.
637638
*
638-
* `CF_TEMP_REDIRECT` uses Cloudflare-specific features ("Forwarding URL" Page
639+
* `CF_TEMP_REDIRECT` uses [Cloudflare](../../provider/cloudflareapi.md)-specific features ("Forwarding URL" Page
639640
* Rules) to generate a HTTP 302 temporary redirect.
640641
*
641642
* If _any_ [`CF_REDIRECT`](CF_REDIRECT.md) or `CF_TEMP_REDIRECT functions are used then
@@ -695,7 +696,7 @@ declare function CF_WORKER_ROUTE(pattern: string, script: string): DomainModifie
695696
declare function CLOUDNS_WR(name: string, target: string, ...modifiers: RecordModifier[]): DomainModifier;
696697

697698
/**
698-
* CNAME adds a CNAME record to the domain. The name should be the relative label for the domain.
699+
* `CNAME` adds a [Canonical name record](https://www.rfc-editor.org/rfc/rfc1035) to the domain. The name should be the relative label for the domain.
699700
* Using `@` or `*` for CNAME records is not recommended, as different providers support them differently.
700701
*
701702
* Target should be a string representing the CNAME target. If it is a single label we will assume it is a relative name on the current domain. If it contains *any* dots, it should be a fully qualified domain name, ending with a `.`.
@@ -872,7 +873,7 @@ declare function D(name: string, registrar: string, ...modifiers: DomainModifier
872873
declare function DEFAULTS(...modifiers: DomainModifier[]): void;
873874

874875
/**
875-
* DHCID adds a DHCID record to the domain.
876+
* `DHCID` adds a [DHCP identifier record](https://www.rfc-editor.org/rfc/rfc4701) to the domain.
876877
*
877878
* Digest should be a string.
878879
*
@@ -887,14 +888,14 @@ declare function DEFAULTS(...modifiers: DomainModifier[]): void;
887888
declare function DHCID(name: string, digest: string, ...modifiers: RecordModifier[]): DomainModifier;
888889

889890
/**
890-
* `DISABLE_IGNORE_SAFETY_CHECK()` disables the safety check. Normally it is an
891-
* error to insert records that match an `IGNORE()` pattern. This disables that
891+
* `DISABLE_IGNORE_SAFETY_CHECK` disables the safety check. Normally it is an
892+
* error to insert records that match an `IGNORE` pattern. This disables that
892893
* safety check for the entire domain.
893894
*
894-
* It replaces the per-record `IGNORE_NAME_DISABLE_SAFETY_CHECK()` which is
895+
* It replaces the per-record `IGNORE_NAME_DISABLE_SAFETY_CHECK` which is
895896
* deprecated as of DNSControl v4.0.0.0.
896897
*
897-
* See [`IGNORE()`](../domain-modifiers/IGNORE.md) for more information.
898+
* See [`IGNORE`](../domain-modifiers/IGNORE.md) for more information.
898899
*
899900
* ## Syntax
900901
*
@@ -1089,7 +1090,7 @@ declare function DKIM_BUILDER(opts: { selector: string; pubkey?: string; label?:
10891090
declare function DMARC_BUILDER(opts: { label?: string; version?: string; policy: 'none' | 'quarantine' | 'reject'; subdomainPolicy?: 'none' | 'quarantine' | 'reject'; alignmentSPF?: 'strict' | 's' | 'relaxed' | 'r'; alignmentDKIM?: 'strict' | 's' | 'relaxed' | 'r'; percent?: number; rua?: string[]; ruf?: string[]; failureOptions?: { SPF: boolean, DKIM: boolean } | string; failureFormat?: string; reportInterval?: Duration; ttl?: Duration }): DomainModifier;
10901091

10911092
/**
1092-
* DNAME adds a DNAME record to the domain.
1093+
* `DNAME` adds a [Delegation name record](https://www.rfc-editor.org/rfc/rfc6672) to the domain.
10931094
*
10941095
* Target should be a string.
10951096
*
@@ -1192,7 +1193,7 @@ declare function DOMAIN_ELSEWHERE(name: string, registrar: string, nameserver_na
11921193
declare function DOMAIN_ELSEWHERE_AUTO(name: string, domain: string, registrar: string, dnsProvider: string): void;
11931194

11941195
/**
1195-
* DS adds a DS record to the domain.
1196+
* `DS` adds a [Delegation signer record](https://www.rfc-editor.org/rfc/rfc4034) to the domain.
11961197
*
11971198
* Key Tag should be a number.
11981199
*
@@ -1297,7 +1298,7 @@ declare function DS(name: string, keytag: number, algorithm: number, digesttype:
12971298
declare function D_EXTEND(name: string, ...modifiers: DomainModifier[]): void;
12981299

12991300
/**
1300-
* DefaultTTL sets the TTL for all subsequent records following it in a domain that do not explicitly set one with [`TTL`](../record-modifiers/TTL.md). If neither `DefaultTTL` or `TTL` exist for a record,
1301+
* DefaultTTL sets the Time To Live (TTL) for all subsequent records following it in a domain that do not explicitly set one with [`TTL`](../record-modifiers/TTL.md). If neither `DefaultTTL` or `TTL` exist for a record,
13011302
* the record will inherit the DNSControl global internal default of 300 seconds. See also [`DEFAULTS`](../top-level-functions/DEFAULTS.md) to override the internal defaults.
13021303
*
13031304
* NS records are currently a special case, and do not inherit from `DefaultTTL`. See [`NAMESERVER_TTL`](../domain-modifiers/NAMESERVER_TTL.md) to set a default TTL for all NS records.
@@ -1969,6 +1970,8 @@ declare function INCLUDE(domain: string): DomainModifier;
19691970
declare function IP(ip: string): number;
19701971

19711972
/**
1973+
* `LOC` add a [Location record](https://www.rfc-editor.org/rfc/rfc1876) to the domain.
1974+
*
19721975
* The parameter number types ingested are as follows:
19731976
*
19741977
* ```
@@ -2407,7 +2410,7 @@ declare function LUA(name: string, rtype: string, contents: string | string[], .
24072410
declare function M365_BUILDER(opts: { label?: string; mx?: boolean; autodiscover?: boolean; dkim?: boolean; skypeForBusiness?: boolean; mdm?: boolean; domainGUID?: string; initialDomain?: string }): DomainModifier;
24082411

24092412
/**
2410-
* MX adds an MX record to the domain.
2413+
* `MX` adds a [Mail exchange record](https://www.rfc-editor.org/rfc/rfc1035) to the domain.
24112414
*
24122415
* Priority should be a number.
24132416
*
@@ -2784,7 +2787,7 @@ declare function NAPTR(subdomain: string, order: number, preference: number, ter
27842787
declare const NO_PURGE: DomainModifier;
27852788

27862789
/**
2787-
* NS adds a NS record to the domain. The name should be the relative label for the domain.
2790+
* `NS` adds a [Name server record](https://www.rfc-editor.org/rfc/rfc1035) to the domain. The name should be the relative label for the domain.
27882791
*
27892792
* The name may not be `@` (the bare domain), as that is controlled via [`NAMESERVER()`](NAMESERVER.md).
27902793
* The difference between `NS()` and [`NAMESERVER()`](NAMESERVER.md) is explained in the [`NAMESERVER()` description](NAMESERVER.md).
@@ -2883,7 +2886,7 @@ declare function NewDnsProvider(name: string, meta?: object): string;
28832886
declare function NewRegistrar(name: string, type?: string, meta?: object): string;
28842887

28852888
/**
2886-
* OPENPGPKEY adds a OPENPGPKEY record to the domain.
2889+
* `OPENPGPKEY` adds an [OpenPGP public key record](https://www.rfc-editor.org/rfc/rfc7929) to the domain.
28872890
*
28882891
* So far, no transformation is applied to the parameters. The data will be passed to the DNS server as-is.
28892892
* Reference RFC 7929 for details.
@@ -2912,7 +2915,7 @@ declare function PANIC(message: string): never;
29122915
/**
29132916
* **DEPRECATED**: This record type is deprecated. Please use `URL` (for temporary redirects) or `URL301` (for permanent redirects) instead. PORKBUN_URLFWD will continue to work but is no longer recommended for new configurations.
29142917
*
2915-
* `PORKBUN_URLFWD` is a Porkbun-specific feature that maps to Porkbun's URL forwarding feature, which creates HTTP 301 (permanent) or 302 (temporary) redirects.
2918+
* `PORKBUN_URLFWD` is a [Porkbun](../../provider/porkbun.md)-specific feature that maps to Porkbun's URL forwarding feature, which creates HTTP 301 (permanent) or 302 (temporary) redirects.
29162919
*
29172920
* ```javascript
29182921
* D("example.com", REG_MY_PROVIDER, DnsProvider(DSP_MY_PROVIDER),
@@ -2933,7 +2936,7 @@ declare function PANIC(message: string): never;
29332936
declare function PORKBUN_URLFWD(name: string, target: string, ...modifiers: RecordModifier[]): DomainModifier;
29342937

29352938
/**
2936-
* PTR adds a PTR record to the domain.
2939+
* `PTR` adds a [PTR Resource record](https://www.rfc-editor.org/rfc/rfc1035) to the domain.
29372940
*
29382941
* The name is normally a relative label for the domain, or a FQDN that ends with `.`. If magic mode is enabled (see below) it can also be an IP address, which will be replaced by the proper string automatically, thus
29392942
* saving the user from having to reverse the IP address manually.
@@ -3255,7 +3258,9 @@ declare function REV(address: string): string;
32553258
declare function REVCOMPAT(rfc: string): string;
32563259

32573260
/**
3258-
* `RP()` adds an RP record to a domain.
3261+
* `RP` adds an [Responsible Person record](https://www.rfc-editor.org/rfc/rfc1183) to a domain.
3262+
*
3263+
* An RP record contains contact details for the domain. Usually an email address with the `@` replaced by a `.`.
32593264
*
32603265
* The RP implementation in DNSControl is still experimental and may change.
32613266
*
@@ -3270,7 +3275,7 @@ declare function REVCOMPAT(rfc: string): string;
32703275
declare function RP(name: string, mbox: string, txt: string, ...modifiers: RecordModifier[]): DomainModifier;
32713276

32723277
/**
3273-
* `SMIMEA` adds a `SMIMEA` record to a domain. The name should be the hashed and stripped local part of the e-mail.
3278+
* `SMIMEA` adds an [S/MIME cert association record](https://www.rfc-editor.org/rfc/rfc8162) to a domain. The name should be the hashed and stripped local part of the e-mail.
32743279
*
32753280
* To create the name, you can the following command:
32763281
*
@@ -3302,7 +3307,7 @@ declare function RP(name: string, mbox: string, txt: string, ...modifiers: Recor
33023307
declare function SMIMEA(name: string, usage: number, selector: number, type: number, certificate: string, ...modifiers: RecordModifier[]): DomainModifier;
33033308

33043309
/**
3305-
* `SOA` adds an `SOA` record to a domain. The name should be `@`. ns and mbox are strings. The other fields are unsigned 32-bit ints.
3310+
* `SOA` adds a [Start of Authority record](https://www.rfc-editor.org/rfc/rfc1035) to a domain. The name should be `@`. ns and mbox are strings. The other fields are unsigned 32-bit ints.
33063311
*
33073312
* ```javascript
33083313
* D("example.com", REG_MY_PROVIDER, DnsProvider(DSP_MY_PROVIDER),
@@ -3311,8 +3316,8 @@ declare function SMIMEA(name: string, usage: number, selector: number, type: num
33113316
* ```
33123317
*
33133318
* ## Notes
3314-
* * The serial number is managed automatically. It isn't even a field in `SOA()`.
3315-
* * Most providers automatically generate SOA records. They will ignore any `SOA()` statements.
3319+
* * The serial number is managed automatically. It isn't even a field in `SOA`.
3320+
* * Most providers automatically generate SOA records. They will ignore any `SOA` statements.
33163321
* * The mbox field should not be set to a real email address unless you love spam and hate your privacy.
33173322
*
33183323
* There is more info about `SOA` in the documentation for the [BIND provider](../../provider/bind.md).
@@ -3606,7 +3611,7 @@ declare function SOA(name: string, ns: string, mbox: string, refresh: number, re
36063611
declare function SPF_BUILDER(opts: { label?: string; overflow?: string; overhead1?: string; raw?: string; ttl?: Duration; txtMaxSize?: number; parts: string[]; flatten?: string[] }): DomainModifier;
36073612

36083613
/**
3609-
* `SRV` adds a `SRV` record to a domain. The name should be the relative label for the record.
3614+
* `SRV` adds a [Service locator record](https://www.rfc-editor.org/rfc/rfc2782) to a domain. The name should be the relative label for the record.
36103615
*
36113616
* Priority, weight, and port are ints.
36123617
*
@@ -3624,7 +3629,7 @@ declare function SPF_BUILDER(opts: { label?: string; overflow?: string; overhead
36243629
declare function SRV(name: string, priority: number, weight: number, port: number, target: string, ...modifiers: RecordModifier[]): DomainModifier;
36253630

36263631
/**
3627-
* `SSHFP` contains a fingerprint of a SSH server which can be validated before SSH clients are establishing the connection.
3632+
* `SSHFP` adds a [SSH Public Key Fingerprint record](https://www.rfc-editor.org/rfc/rfc4255) to the domain. The record contains a fingerprint of a SSH server which can be validated before SSH clients are establishing the connection.
36283633
*
36293634
* **Algorithm** (type of the key)
36303635
*
@@ -3657,7 +3662,7 @@ declare function SRV(name: string, priority: number, weight: number, port: numbe
36573662
declare function SSHFP(name: string, algorithm: 0 | 1 | 2 | 3 | 4, type: 0 | 1 | 2, value: string, ...modifiers: RecordModifier[]): DomainModifier;
36583663

36593664
/**
3660-
* SVCB adds an SVCB record to a domain. The name should be the relative label for the record. Use `@` for the domain apex.
3665+
* `SVCB` adds a [Service Binding record](https://www.rfc-editor.org/rfc/rfc9460) to a domain. The name should be the relative label for the record. Use `@` for the domain apex.
36613666
*
36623667
* The priority must be a positive number, the address should be an ip address, either a string, or a numeric value obtained via [IP](../top-level-functions/IP.md).
36633668
*
@@ -3676,7 +3681,7 @@ declare function SSHFP(name: string, algorithm: 0 | 1 | 2 | 3 | 4, type: 0 | 1 |
36763681
declare function SVCB(name: string, priority: number, target: string, params: string, ...modifiers: RecordModifier[]): DomainModifier;
36773682

36783683
/**
3679-
* `TLSA` adds a `TLSA` record to a domain. The name should be the relative label for the record.
3684+
* `TLSA` adds a [TLSA certificate association record](https://www.rfc-editor.org/rfc/rfc6698) to a domain. The name should be the relative label for the record.
36803685
*
36813686
* Usage, selector, and type are ints.
36823687
*
@@ -3727,7 +3732,7 @@ declare function TLSA(name: string, usage: number, selector: number, type: numbe
37273732
declare function TTL(ttl: Duration): RecordModifier;
37283733

37293734
/**
3730-
* `TXT` adds an `TXT` record To a domain. The name should be the relative
3735+
* `TXT` adds a [Text record](https://www.rfc-editor.org/rfc/rfc1035) to a domain. The name should be the relative
37313736
* label for the record. Use `@` for the domain apex.
37323737
*
37333738
* The contents is either a single or multiple strings. To

documentation/release/release-engineering.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,10 +32,10 @@ git commit -am "CHORE: generate-all.sh"
3232
## Step 2. Tag the commit in main that you want to release
3333

3434
```shell
35-
git tag -l |grep -F v4. | sort --version-sort --field-separator=. --key=2,2 | tail
36-
export VERSION=v4.x.0
3735
git checkout main
3836
git pull --rebase --ff-only --prune
37+
git tag -l |grep -F v4. | sort --version-sort --field-separator=. --key=2,2 | tail
38+
export VERSION=v4.x.0
3939
git tag -m "Release $VERSION" -a $VERSION
4040
git push origin HEAD --tags
4141
```

0 commit comments

Comments
 (0)