koenrh / dnscontrol-action

Deploy your DNS configuration using GitHub Actions using DNSControl.

Hello! 👋 I'm an experienced engineer and tech lead with a strong security background. I love working with product, design, engineering, and legal to help build and ship secure products.

I'm currently leading the security program at Framer, a web-based collaborative prototyping and design tool for teams.

dnscontrol-action's Issues

Add Dependabot to keep the base image up-to-date

See Dependabot for Docker

Update to DNSControl v3.15.0?

HI!

Thank you for your work.
An update to v3.15.0 would be great :)

Thanks!

Source for upstream container?

The ghcr.io/koenrh/dnscontrol:v3.13.0@sha256:2e0ff54e609f418d285b776f3bbceee35b73eac8637731395e1a001ad7c38898 upstream container used by the Dockerfile doesn't seem to have any public github repo or build chain.

It would be great to have one.

I have created https://github.com/Firefishy/dnscontrol-docker as an initial start (including github actions)

executing /github/workspace/dnsconfig.js: A record name argument validation failed

executing /github/workspace/dnsconfig.js: A record name argument validation failed

Missing v3 tag/branch or docs need update

The docs example for the action is koenrh/dnscontrol-action@v3 but the v3 tag/branch is missing

Fix docs to use full version e.g.: koenrh/[email protected]

The `set-output` command is deprecated and will be disabled soon.

Everything is working fine, but I'm getting the following warning:

The set-output command is deprecated and will be disabled soon. Please upgrade to using Environment Files. For more information see: https://github.blog/changelog/2022-10-11-github-actions-deprecating-save-state-and-set-output-commands/

Update to 3.13.0

Hello,

We have a problem with a provider's TXT too long entries and we seen that the last dnscontrol release 3.13.0 corrected it. Is it possible to update your container ? Could we help you to do this ?

Best regards

Add GitHub Actions Job Summaries

https://github.blog/2022-05-09-supercharging-github-actions-with-job-summaries/

Allow usage with native environment variable support

Hey, it was awesome to see this action exists.

I am not sure if you are aware, but dnscontrol supports environment variables natively in creds.json. It will already replace anything that looks like $SOME_VAR if it finds a matching env var.

Here is an example of how I set it up. For local dev I just have a .env file that I gitignore, and for CI I put the vars into secrets. I can check in the "template" creds.json, but still inject the values at runtime.

I could see this somewhat simplifying this action not needing to manage all possible env vars explicitly. But also breaking backward compatibility, since your current version will nuke anything in creds.json and people may be depending on how you set it up.

I've done that in my fork and it seems to work well.

Thoughts?

Add tests for Bash scripts

See Bats

Update GitHub Actions workflow examples in README to new YAML syntax

https://help.github.com/en/articles/migrating-github-actions-from-hcl-syntax-to-yaml-syntax

Diactritics on Preview

Hello,

I am seeing unknown diacrtitics when it posts the preview text as GitHub comment. Any ideas on how to fix that?

******************** Domain: domain
1 correction
#1: 
�[31m- DELETE CNAME webhooks.domain domain. ttl=300�[0m

******************** Domain: domain2
1 correction
#1: 
�[31m- DELETE CNAME webhooks.domain domain. ttl=300�[0m

Filter the "Pull request comment" output

If you have many domains, the comment posted to the PR is very long. I've found it better if the GHA log shows all the output, but what gets posted as a comment is filtered heavily.

We use this script immediately after the echo "$OUTPUT" line.

(this is from memory)

OUTPUT=$(echo "$OUTPUT" | bin/filter-preview.sh)

Here's the filter-preview.sh script:

$ cat bin/filter-preview.sh
#!/bin/bash

grep -v -e '\.\.\.0 corrections$' |\
  grep -v -e '\.\.\. (skipping)' |\
  grep -v -e '----- Getting nameservers from:'

• The multiple grep's can probably be combined
• It probably doesn't need to be a separate script, but it is easier to debug that way. It also permits me to use the script on the command line when I'm making changes outside of GHA.

Link to this on dnscontrol?

Hey this GHA is really neat!

Would you like to link to it from the DNSControl README or other docs?

Document how to get this action to publish the output of the 'preview' command as a PR comment

See: #26

My specific usecase was that I want my own GitHub action to comment the diff of dnscontrol preview on the PR, instead of having to dig down into the "Checks" tab after every push. I'm open to other names than "output", but I wanted to keep it nice and generic, as "diff" wouldn't be suitable for commands like dnscontrol push or check.

Something along the lines of:

- name: Comment diff on PR
  uses: unsplash/comment-on-pr@master
  env:
    GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
  with:
    msg: |
      ```
      ${{ steps.preview.outputs.output }}
      ```
    check_for_duplicate_msg: true

Add instructions on keeping the DNSControl Action up to date with GitHub Dependabot

Update the README to add instructions on keeping the DNSControl Action up to date with GitHub Dependabot.

Keeping your actions up to date with GitHub Dependabot

filter-preview-output.sh no longer needed

filter-preview-output.sh is no longer needed.

As of StackExchange/dnscontrol#2203 the default output is filtered similar to how filter-preview-output.sh filters output. The --full flag gets the old format. As of now, I can't imagine filter-preview-output.sh is finding anything to filter.

ESLint config example

I'm currently trying to use your example GitHub actions flows and the ESLint is failing (because of "no ESLint config file being found").
Do you have an example on how to get ESLint running in a new repo that is used for dnscontrol?

So far from researching it seems that I would need to use npm to create a package.json in the repo that "points" to the correct folder.