mirrors/external-dns
1
0
Fork 0
mirror of https://github.com/kubernetes-sigs/external-dns.git synced 2026-05-04 14:21:33 +02:00
Code Issues Packages Projects Releases Wiki Activity

Added some documentation

Browse Source
This commit is contained in:
Johannes Grumböck 2020-10-03 15:50:22 +02:00
parent db2817da70
commit 63be26d798
1 changed files with 10 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/contributing/getting-started.md
View File

@ -48,3 +48,13 @@ You can pick which `Source` and `Provider` to use at runtime via the `--source`
A typical way to start on, e.g. a CoreDNS provider, would be to add a `coredns.go` to the providers package and implement the interface methods. Then you would have to register your provider under a name in `main.go`, e.g. `coredns`, and would be able to trigger it's functions via setting `--provider=coredns`.
Note, how your provider doesn't need to know anything about where the DNS records come from, nor does it have to figure out the difference between the current and the desired state, it merely executes the actions calculated by the plan.
# Running Github Actions locally
You can also extend the CI workflow which is currently implemented as Github Action within the [workflow](../../.github/workflow) folder.
In order to test your changes before commiting you can leverage [act](https://github.com/nektos/act) to run the Github Action locally.
Follow the installation instructions in the nektos/act [README.md](https://github.com/nektos/act/blob/master/README.md).
Afterwards just run `act` within the root folder of the project.
For further usage of `act` refer to its documentation.