Merge pull request #30 from koenrh/koenrh/prepare-v3.3

Prepare version 3.3

CHANGELOG.md

@@ -0,0 +1,9 @@
+# Changelog
+
+## Unreleased
+
+## v3.3.0
+
+- Add support for publishing the output of the 'preview' command as a comment to
+    the pull request. [\#26](https://github.com/koenrh/dnscontrol-action/pull/26)
+    ([@svenluijten](https://github.com/svenluijten))

README.md

@@ -24,7 +24,7 @@ jobs:
   check:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@master
+      - uses: actions/checkout@v2
 
       - name: DNSControl check
         uses: koenrh/dnscontrol-action@v3
@@ -47,7 +47,7 @@ jobs:
   preview:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@master
+      - uses: actions/checkout@v2
 
       - name: DNSControl preview
         uses: koenrh/dnscontrol-action@v3
@@ -58,7 +58,8 @@ jobs:
 ```
 
 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`.
+could be verified before an authorized person merges these changes into the default
+branch.
 
 #### Pull request comment
 
@@ -105,7 +106,7 @@ 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.
+pattern so that it only runs on the default branch.
 
 ```yaml
 name: Push
@@ -113,13 +114,13 @@ name: Push
 on:
   push:
     branches:
-      - master
+      - main
 
 jobs:
   push:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@master
+      - uses: actions/checkout@v2
 
       - name: DNSControl push
         uses: koenrh/dnscontrol-action@v3

examples/README.md

@@ -2,5 +2,6 @@
 
 Find in this folder two GitHub Actions workflow examples.
 
-* [deploy-master.yml](deploy-master.yml): On merge into master, deploy the DNS configuration.
-* [test-pull-request.yml](test-pull-request.yml): Lint the `dnsconfig.js` configuration file using ESLint, and preview the DNS changes.
+* [deploy.yml](deploy.yml): On merge into default branch, deploy the DNS changes.
+* [test.yml](test.yml): Lint `dnsconfig.js` configuration file using ESLint, and
+    preview the DNS changes.

examples/deploy.yml

@@ -4,13 +4,13 @@ name: deploy
 on:
   push:
     branches:
-      - master
+      - main
 
 jobs:
   dnscontrol:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@master
+      - uses: actions/checkout@v2
 
       - name: DNSControl push
         uses: koenrh/dnscontrol-action@v3

examples/test.yml

@@ -8,7 +8,7 @@ jobs:
     name: ESLint
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@master
+      - uses: actions/checkout@v2
 
       - name: Run ESLint
         uses: koenrh/actions/eslint@master
@@ -19,7 +19,7 @@ jobs:
     name: DNSControl
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@master
+      - uses: actions/checkout@v2
 
       - name: Preview
         uses: koenrh/dnscontrol-action@v3