StackExchange/dnscontrol
1
1
Fork 0
mirror of https://github.com/StackExchange/dnscontrol.git synced 2025-02-24 15:43:08 +08:00
Code Issues Projects Releases Packages Wiki Activity

DOC: NEW: How to test a branch (#3264)

Browse source 
Co-authored-by: Jeffrey Cafferata <jeffrey@jcid.nl>
This commit is contained in:
Tom Limoncelli 2024-12-19 13:18:58 -05:00 committed by GitHub
parent 76bbdc191a
commit 1a1e592a5d
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 66 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
documentation/SUMMARY.md
View file

@ -186,6 +186,7 @@
* [Writing new DNS providers](writing-providers.md)
* [Creating new DNS Resource Types (rtypes)](adding-new-rtypes.md)
* [Integration Tests](integration-tests.md)
* [Test a branch](test-a-branch.md)
* [Unit Testing DNS Data](unittests.md)
* [Bug Triage Process](bug-triage.md)
* [Bring-Your-Own-Secrets for automated testing](byo-secrets.md)

65
documentation/test-a-branch.md Normal file
View file

@ -0,0 +1,65 @@
### Test A Branch
Instructions for testing DNSControl at a particular PR or branch.
## Using Docker
Using Docker assures you're using the latest version of Go and doesn't require you to install anything on your machine, other than Docker!
Assumptions:
* `/THE/PATH` -- Change this to the full path to where your dnsconfig.js and other files are located.
* `INSERT_BRANCH_HERE` -- The branch you want to test. The branch associated with a PR is listed on [https://github.com/StackExchange/dnscontrol/branches](https://github.com/StackExchange/dnscontrol/branches).
```
docker run -it -v /THE/PATH:/dns golang
git clone https://github.com/StackExchange/dnscontrol.git
cd dnscontrol
git checkout INSERT_BRANCH_HERE
go install
cd /dns
dnscontrol preview
```
If you want to run the integration tests, follow the
[Integration Tests](https://docs.dnscontrol.org/developer-info/integration-tests) document
as usual. The directory to be in is `/go/dnscontrol/integrationTest`.
```
cd /go/dnscontrol/integrationTest
go test -v -verbose -provider INSERT_PROVIDER_NAME -start 1 -end 3
```
Change `INSERT_PROVIDER_NAME` to the name of your provider (BIND, ROUTE53, GCLOUD, etc.)
## Not using Docker
Assumptions:
* `/THE/PATH` -- Change this to the full path to where your dnsconfig.js and other files are located.
* `INSERT_BRANCH_HERE` -- The branch you want to test. The branch associated with a PR is listed on [https://github.com/StackExchange/dnscontrol/branches](https://github.com/StackExchange/dnscontrol/branches).
Step 1: Install Go
[https://go.dev/dl/](https://go.dev/dl/)
Step 2: Check out the software
```
git clone https://github.com/StackExchange/dnscontrol.git
cd dnscontrol
git checkout INSERT_BRANCH_HERE
go install
cd /THE/PATH
dnscontrol preview
```
Step 3: Clean up
`go install` put the `dnscontrol` program in your `$HOME/bin` directory. You probably want to remove it.
```
$ rm -i $HOME/bin/dnscontrol
```