Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Publish Docs to Netlify and AWS #14767

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Conversation

milzi234
Copy link

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
Copy link

coveralls commented Oct 11, 2024

Pull Request Test Coverage Report for Build 11910350616

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • 89 unchanged lines in 10 files lost coverage.
  • Overall coverage increased (+0.006%) to 64.688%

Files with Coverage Reduction New Missed Lines %
pdns/packethandler.cc 1 72.62%
pdns/pollmplexer.cc 1 83.66%
pdns/recursordist/aggressive_nsec.cc 2 66.39%
pdns/dnsdistdist/dnsdist-carbon.cc 6 62.7%
pdns/recursordist/rec-tcpout.cc 6 50.79%
pdns/remote_logger.cc 6 52.02%
pdns/recursordist/rec-main.cc 10 62.34%
ext/json11/json11.cpp 12 62.72%
pdns/recursordist/test-syncres_cc1.cc 13 89.14%
pdns/recursordist/rec-system-resolve.cc 32 54.76%
Totals Coverage Status
Change from base Build 11891742819: 0.006%
Covered Lines: 125773
Relevant Lines: 163606

💛 - Coveralls

Copy link
Member

@Habbie Habbie left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

.github/workflows/documentation.yml Show resolved Hide resolved
.github/workflows/documentation.yml Show resolved Hide resolved
.github/workflows/documentation.yml Outdated Show resolved Hide resolved
Francisco Laguna de la Vera and others added 2 commits November 19, 2024 10:43
When applied, this commit allows for the documentation to be published to Netlify and AWS based on the secrets and variables present (see the comment in documentation.yml)
…ding with GHA instead of letting netlify build things
@milzi234
Copy link
Author

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

@Habbie
Copy link
Member

Habbie commented Nov 19, 2024

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)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants