✨ Identify and Publish DNS Records to Repository + Refactor Bin Files

[jasonBirchall]

👀 Purpose

• Connects to R021: Tag Resources in DNS Repository to Indicate GitHub Pages Delegation operations-engineering#4782

• This pull request introduces automation for updating identifying and updating GitHub Pages records. A workflow runs weekly, identifies all GitHub Pages delegations, as per their managing custom domains documentation, and creates a pull request if there are any changes to the records.

• This PR also refactors the layout of the repository. There were a number of executables building up in the root of the repo. I decided to group these and place them in a directory named bin.

♻️ What's changed

• Introduces a new Python file called bin/update_github_pages_config.py, this file will loop over our hostedzones directory looking for records associated with GitHub pages.
• Introduces a new directory called bin that holds all entrypoints for jobs in this repository.
• Moves all python files into this directory.
• Refactors all test files importing python modules.
• Introduces a GitHub workflow file called .github/workflows/check-github-pages-records.yaml that will run the update_github_pages_config once per week. Upon changes, a new PR will be raised.
• Introduces a new config file that will contain all records delegating to GitHub pages. This config file will be used to ensure the records are validated and secured against the organisation.

📝 Notes

• I have deliberately omitted one or two GH delegations to see the process in action once merged.

[github-actions]

🦙 MegaLinter status: ✅ SUCCESS

Descriptor	Linter	Files	Fixed	Errors	Elapsed time
✅ YAML	prettier	1	0	0	0.25s
✅ YAML	yamllint	1		0	0.19s

See detailed report in MegaLinter reports
Set VALIDATE_ALL_CODEBASE: true in mega-linter.yml to validate all sources, not only the diff

MegaLinter is graciously provided by