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 170d87f800 Update version tag in README and examples		2020-02-15 16:58:25 +01:00
.github/workflows	Fix bats and shellcheck steps	2019-10-12 17:41:07 +02:00
examples	Update version tag in README and examples	2020-02-15 16:58:25 +01:00
test	Add support for Cloudflare API token	2020-01-03 12:13:48 +01:00
action.yml	Add support for Cloudflare API token	2020-01-03 12:13:48 +01:00
Dockerfile	Upgrade DNSControl to v2.11	2020-02-15 16:33:59 +01:00
entrypoint.sh	Remove unnecessary trailing commas	2020-02-15 16:55:06 +01:00
LICENSE.txt	First commit.	2019-01-05 12:24:28 +01:00
README.md	Update version tag in README and examples	2020-02-15 16:58:25 +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 dnsconfig.js file. This action does not communicate with the DNS providers, hence does not require any secrets to be set.

name: Check

on: pull_request

jobs:
  check:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@master

      - name: DNSControl check
        uses: koenrh/dnscontrol-action@v2.11
        with:
          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.

name: Preview

on: pull_request

jobs:
  preview:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@master

      - name: DNSControl preview
        uses: koenrh/dnscontrol-action@v2.11
        env:
          CLOUDFLARE_API_KEY: ${{ secrets.CLOUDFLARE_API_KEY }}
          CLOUDFLARE_API_USER: ${{ secrets.CLOUDFLARE_API_USER }}
        with:
          args: preview

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. The example workflow depicted below contains a filtering pattern so that it only runs on the master branch.

name: Push

on:
  push:
    branches:
      - master

jobs:
  push:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@master

      - name: DNSControl push
        uses: koenrh/dnscontrol-action@v2.11
        env:
          CLOUDFLARE_API_KEY: ${{ secrets.CLOUDFLARE_API_KEY }}
          CLOUDFLARE_API_USER: ${{ secrets.CLOUDFLARE_API_USER }}
        with:
          args: push

Secrets

Depending on the DNS providers that are used, this action requires secrets to be set.

README.md

DNSControl Action

Usage

check

preview

push

Secrets

Azure DNS

Cloudflare

DigitalOcean

DNSimple

Gandi

Gandi V5

Google CLOUD DNS

Linode

Name.com

Namecheap

NS1

OVH

Amazon Route 53

SoftLayer

Vultr