mirror of https://github.com/koenrh/dnscontrol-action.git synced 2024-11-10 09:02:52 +08:00

Deploy your DNS configuration using GitHub Actions using DNSControl.

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

Find a file

Koen Rouwhorst 38a9f0dfdc Update tests		2019-10-12 17:53:57 +02:00
.github/workflows	Fix bats and shellcheck steps	2019-10-12 17:41:07 +02:00
examples	Added examples README.	2019-01-05 16:18:17 +01:00
test	Update tests	2019-10-12 17:53:57 +02:00
action.yml	Add actions.yml	2019-10-12 17:06:23 +02:00
Dockerfile	Upgrade dnscontrol v2.9	2019-05-28 09:48:22 +02:00
entrypoint.sh	Update input environment variable names	2019-10-12 17:48:37 +02:00
LICENSE.txt	First commit.	2019-01-05 12:24:28 +01:00
README.md	Add GitHub Actions build workflow badge	2019-09-22 19:36:59 +02: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.

name: Check

on: pull_request

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

      - name: DNSControl check
        uses: koenrh/dnscontrol-action@master
        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@master
        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@master
        env:
          CLOUDFLARE_API_KEY: ${{ secrets.CLOUDFLARE_API_KEY }}
          CLOUDFLARE_API_USER: ${{ secrets.CLOUDFLARE_API_USER }}
        with:
          args: push