Publish Docs to Netlify and AWS

[milzi234]

Short description

When applied, this change allows for the documentation to be published to Netlify and AWS based on the secrets and variables present (see the comment in documentation.yml)

Variables:

• PUBLISH_DOCS_TO_AWS: Set to 'true' to enable publishing to AWS

• PUBLISH_DOCS_TO_NETLIFY: Set to 'true' to enable publishing to Netlify

• PUBLISH_DOCS_TO_WEB1: Set to 'true' to enable publishing to Web1

• PUBLISH_PRS_TO_NETLIFY: Set to 'true' to publish PR previews to Netlify

• AWS_REGION: AWS region for S3 and CloudFront

• AWS_S3_BUCKET_DOCS: S3 bucket name for documentation

• AWS_CLOUDFRONT_DISTRIBUTION_ID_DNSDIST: CloudFront distribution ID for DNSdist docs

• AWS_CLOUDFRONT_DISTRIBUTION_ID_DOCS: CloudFront distribution ID for PowerDNS docs

• NETLIFY_SITE_ID_DOCS: Netlify site ID for PowerDNS docs

• NETLIFY_SITE_ID_DNSDIST: Netlify site ID for DNSdist docs

• REC_DOCS_DIR: Directory for Recursor docs on Web1

• AUTH_DOCS_DIR: Directory for Authoritative Server docs on Web1

• WEB1_HOSTKEY: SSH host key for Web1

• DOCS_HOST: Hostname for documentation server

Secrets:

• AWS_ACCESS_KEY_ID: AWS access key ID
• AWS_SECRET_ACCESS_KEY: AWS secret access key
• NETLIFY_API_TOKEN: API token for Netlify
• WEB1_DOCS_SECRET: SSH key for Web1 access

Checklist

I have:

• read the CONTRIBUTING.md document
• compiled this code
• tested this code
• included documentation (including possible behaviour changes)
• documented the code
• added or modified regression test(s)
• added or modified unit test(s)

Notes

I'm not sure I refactored the code that uploads to web1 correctly and couldn't test that path

[coveralls]

Pull Request Test Coverage Report for Build 12008405860

Warning: This coverage report may be inaccurate.

This pull request's base commit is no longer the HEAD commit of its target branch. This means it includes changes from outside the original pull request, including, potentially, unrelated coverage changes.

• For more information on this, see Tracking coverage changes with pull request builds.
• To avoid this issue with future PRs, see these Recommended CI Configurations.
• For a quick fix, rebase this PR at GitHub. Your next report should be accurate.

Details

• 0 of 0 changed or added relevant lines in 0 files are covered.
• 332 unchanged lines in 17 files lost coverage.
• Overall coverage increased (+0.09%) to 64.767%

---

Files with Coverage Reduction	New Missed Lines	%
pdns/recursordist/syncres.cc	1	79.56%
pdns/pollmplexer.cc	1	84.31%
pdns/rcpgenerator.cc	2	89.74%
pdns/recursordist/test-syncres_cc2.cc	3	89.03%
pdns/iputils.cc	3	55.76%
pdns/recursordist/rec-tcp.cc	4	64.81%
pdns/signingpipe.cc	5	86.33%
pdns/dnsdistdist/dnsdist-carbon.cc	6	63.78%
pdns/recursordist/rec-tcpout.cc	6	50.79%
pdns/recursordist/filterpo.hh	7	87.88%

Totals
Change from base Build 11891742819:	0.09%
Covered Lines:	125938
Relevant Lines:	163641

---

💛 - Coveralls

[Habbie]

Nice work!

Generally appears fine. I left a few comments/questions about permissions. The .yml is conflicted now, sadly, I hope it's not a tough merge. Also the spellchecker wants a few words added to expect.txt.

I have set the relevant variables/secrets meanwhile.

[milzi234]

I have rebased my fork on top of the current master and removed the Netlify PR handling

[Habbie]

the spell checker is unhappy (needs a few words in expect.txt) and the binary checker is unhappy (I said before that we can ignore it, but I recently realised adding exclusions is easy - look for tinydns in .github/workflows/codeql-analysis.yml)

[Habbie]

Let's merge this on monday!