mirror/stackexchange-dnscontrol
1
0
Fork 0
mirror of https://github.com/StackExchange/dnscontrol.git synced 2024-05-11 05:55:12 +00:00
Code Issues Releases Activity

DOCS: [GitBook] Added code blocks syntax (#2136)

Browse Source 
Co-authored-by: Tom Limoncelli <tlimoncelli@stackoverflow.com>
This commit is contained in:
Jeffrey Cafferata
2023-03-11 14:42:33 +01:00
committed by GitHub
parent 4ad56417c0
commit b2a8d4c671
1 changed files with 26 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

42
documentation/adding-new-rtypes.md
View File

@@ -88,8 +88,10 @@ Please add the function alphabetically with the others. Also, please run
[prettier](https://github.com/prettier/prettier) on the file to ensure [prettier](https://github.com/prettier/prettier) on the file to ensure
your code conforms to our coding standard: your code conforms to our coding standard:
npm install prettier ```shell
node_modules/.bin/prettier --write pkg/js/helpers.js npm install prettier
node_modules/.bin/prettier --write pkg/js/helpers.js
```
Any time you change `pkg/js/helpers.js`, run `go generate` to regenerate `pkg/js/static.go`. Any time you change `pkg/js/helpers.js`, run `go generate` to regenerate `pkg/js/static.go`.
@@ -114,8 +116,10 @@ Test `013-mx.js` is a very simple one and is good for cloning.
Run these tests via: Run these tests via:
cd dnscontrol/pkg/js ```shell
go test ./... cd dnscontrol/pkg/js
go test ./...
```
If this works, then you know the `dnsconfig.js` and `helpers.js` If this works, then you know the `dnsconfig.js` and `helpers.js`
code is working correctly. code is working correctly.
@@ -136,16 +140,18 @@ list.
Each `testgroup()` is a named list of tests. Each `testgroup()` is a named list of tests.
```javascript {% code title="integration_test.go" lineNumbers="true" %}
testgroup("MX", <<< 1 ```go
tc("MX record", mx("@", 5, "foo.com.")), <<< 2 testgroup("MX",
tc("Change MX pref", mx("@", 10, "foo.com.")), <<< 3 tc("MX record", mx("@", 5, "foo.com.")),
tc("MX record", <<< 4 tc("Change MX pref", mx("@", 10, "foo.com.")),
tc("MX record",
mx("@", 10, "foo.com."), mx("@", 10, "foo.com."),
mx("@", 20, "bar.com."), mx("@", 20, "bar.com."),
), ),
) )
``` ```
{% endcode %}
Line 1: `testgroup()` gives a name to a group of tests. It also tells Line 1: `testgroup()` gives a name to a group of tests. It also tells
the system to delete all records for this domain so that the tests the system to delete all records for this domain so that the tests
@@ -182,8 +188,10 @@ in the source code.
To run the integration test with the BIND provider: To run the integration test with the BIND provider:
cd dnscontrol/integrationTest ```shell
go test -v -verbose -provider BIND cd dnscontrol/integrationTest
go test -v -verbose -provider BIND
```
Once the code works for BIND, consider submitting a PR at this point. Once the code works for BIND, consider submitting a PR at this point.
(The earlier you submit a PR, the earlier we can provide feedback.) (The earlier you submit a PR, the earlier we can provide feedback.)
@@ -200,10 +208,12 @@ flag to the provider and re-run the integration tests:
For example, this will run the tests on Amazon AWS Route53: For example, this will run the tests on Amazon AWS Route53:
export R53_DOMAIN=dnscontroltest-r53.com # Use a test domain. ```shell
export R53_KEY_ID=CHANGE_TO_THE_ID export R53_DOMAIN=dnscontroltest-r53.com # Use a test domain.
export R53_KEY='CHANGE_TO_THE_KEY' export R53_KEY_ID=CHANGE_TO_THE_ID
go test -v -verbose -provider ROUTE53 export R53_KEY='CHANGE_TO_THE_KEY'
go test -v -verbose -provider ROUTE53
```
The test should reveal any bugs. Keep iterating between fixing the The test should reveal any bugs. Keep iterating between fixing the
code and running the tests. When the tests all work, you are done. code and running the tests. When the tests all work, you are done.