mirror of https://github.com/koenrh/dnscontrol-action.git synced 2024-09-20 12:05:57 +08:00

Deploy your DNS configuration using GitHub Actions using DNSControl.

dns github-action starred-koenrh-repo starred-repo

Go to file

Koen Rouwhorst 983c9306ba Add migrated GitHub workflow		2019-08-11 14:09:03 +02:00
.github	Add migrated GitHub workflow	2019-08-11 14:09:03 +02:00
examples	Added examples README.	2019-01-05 16:18:17 +01:00
test	Added tests for entrypoint script.	2019-01-28 21:12:34 +01:00
Dockerfile	Upgrade dnscontrol v2.9	2019-05-28 09:48:22 +02:00
entrypoint.sh	Added tests for entrypoint script.	2019-01-28 21:12:34 +01:00
LICENSE.txt	First commit.	2019-01-05 12:24:28 +01:00
README.md	Updated README.	2019-01-05 15:12:33 +01:00

README.md

DNSControl Action

Deploy your DNS configuration using GitHub Actions using DNSControl.

Usage

These are the three relevant sub commands to use with this action.

check

Run the action with the 'check' argument in order to check and validate the dnscontrol.js file. This action does not communicate with the DNS providers, hence does not require any secrets to be set.

action "DNSControl check" {
  uses = "koenrh/dnscontrol-action@master"
  args = "check"
}

preview

Run the action with the 'preview' argument to check what changes need to be made. It prints out what DNS records are expected to be created, modified or deleted. This action requires the secrets for the specified DNS providers.

action "DNSControl preview" {
  uses = "koenrh/dnscontrol-action@master"
  args = "preview"
  secrets = ["CLOUDFLARE_API_USER", "CLOUDFLARE_API_KEY"]
}

This is the action you probably want to run for each branch so that proposed changes could be verified before an authorized person merges these changes into master.

push

Run the action with the 'push' arugment to publish the changes to the specified DNS providers.

Running the action with the 'push' argument will publish the changes with the specified DNS providers. You should probably only use this command combined with the GitHub Filters action to make sure that only changes in the master branch are deployed to production.

action "DNSControl push" {
  uses = "koenrh/dnscontrol-action@master"
  args = "push"
  secrets = ["CLOUDFLARE_API_KEY", "CLOUDFLARE_API_USER"]
}

You should probably only use this command combined with the GitHub Filters action to make sure that only changes in the master branch are deployed to production.