Self-Hosted CICD Runners Guidance #70
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
AErmie
requested review from
wrnu,
harsimranmaan,
MaxWardle and
abibat-adesina
as code owners
3 tasks
wrnu
approved these changes
Jan 6, 2025
AErmie
added a commit
that referenced
this pull request
Jan 6, 2025
* Minor fixes (typos, etc.) * Updates with new content * More updates * Added details about AMBA, and governance best practices * Added more content * Replaced 'Cloud Pathfinder' with 'Public Cloud' * Fixed broken page link * Update docs/azure/best-practices/azure-ai.md Co-authored-by: Pilar Solares <[email protected]> * Update docs/azure/best-practices/azure-ai.md Co-authored-by: Pilar Solares <[email protected]> * Update docs/azure/best-practices/azure-ai.md Co-authored-by: Pilar Solares <[email protected]> * Update docs/azure/get-started-with-azure/bc-govs-azure-landing-zone-overview.md Co-authored-by: Pilar Solares <[email protected]> * Update docs/azure/get-started-with-azure/bc-govs-azure-landing-zone-overview.md Co-authored-by: Pilar Solares <[email protected]> * Update docs/azure/design-build-deploy/user-management.md Co-authored-by: Pilar Solares <[email protected]> * Update docs/azure/design-build-deploy/requirements.md Co-authored-by: Pilar Solares <[email protected]> * Update docs/azure/design-build-deploy/networking.md Co-authored-by: Pilar Solares <[email protected]> * Update docs/azure/best-practices/azure-ai.md Co-authored-by: Pilar Solares <[email protected]> * Update docs/azure/best-practices/azure-ai.md Co-authored-by: Pilar Solares <[email protected]> * Broken link fixes (#53) * Fix "owner" value so links to team page work properly in DevHub Fix "owner" value so links to team page work properly in DevHub. Currently, the link to team owning the docs is broken in Devhub. This change will fix so it displays.a team details page when clicked. * TechDocs Updates for Azure Contnet (#52) * Minor fixes (typos, etc.) * Updates with new content * More updates * Added details about AMBA, and governance best practices * Added more content * Replaced 'Cloud Pathfinder' with 'Public Cloud' * Fixed broken page link * Update docs/azure/best-practices/azure-ai.md Co-authored-by: Pilar Solares <[email protected]> * Update docs/azure/best-practices/azure-ai.md Co-authored-by: Pilar Solares <[email protected]> * Update docs/azure/best-practices/azure-ai.md Co-authored-by: Pilar Solares <[email protected]> * Update docs/azure/get-started-with-azure/bc-govs-azure-landing-zone-overview.md Co-authored-by: Pilar Solares <[email protected]> * Update docs/azure/get-started-with-azure/bc-govs-azure-landing-zone-overview.md Co-authored-by: Pilar Solares <[email protected]> * Update docs/azure/design-build-deploy/user-management.md Co-authored-by: Pilar Solares <[email protected]> * Update docs/azure/design-build-deploy/requirements.md Co-authored-by: Pilar Solares <[email protected]> * Update docs/azure/design-build-deploy/networking.md Co-authored-by: Pilar Solares <[email protected]> * Update docs/azure/best-practices/azure-ai.md Co-authored-by: Pilar Solares <[email protected]> * Update docs/azure/best-practices/azure-ai.md Co-authored-by: Pilar Solares <[email protected]> --------- Co-authored-by: Adin Ermie <[email protected]> Co-authored-by: Warren Uniewski <[email protected]> Co-authored-by: Pilar Solares <[email protected]> * Fixed broken links * Update docs/aws/design-build-and-deploy-an-application/requirements-for-building-your-application.md Co-authored-by: Copilot <[email protected]> --------- Co-authored-by: Shea Phillips <[email protected]> Co-authored-by: Abibat Adesina <[email protected]> Co-authored-by: Warren Uniewski <[email protected]> Co-authored-by: Adin Ermie <[email protected]> Co-authored-by: Pilar Solares <[email protected]> Co-authored-by: Copilot <[email protected]> * Workflow updates (#55) * Fix "owner" value so links to team page work properly in DevHub Fix "owner" value so links to team page work properly in DevHub. Currently, the link to team owning the docs is broken in Devhub. This change will fix so it displays.a team details page when clicked. * TechDocs Updates for Azure Contnet (#52) * Minor fixes (typos, etc.) * Updates with new content * More updates * Added details about AMBA, and governance best practices * Added more content * Replaced 'Cloud Pathfinder' with 'Public Cloud' * Fixed broken page link * Update docs/azure/best-practices/azure-ai.md Co-authored-by: Pilar Solares <[email protected]> * Update docs/azure/best-practices/azure-ai.md Co-authored-by: Pilar Solares <[email protected]> * Update docs/azure/best-practices/azure-ai.md Co-authored-by: Pilar Solares <[email protected]> * Update docs/azure/get-started-with-azure/bc-govs-azure-landing-zone-overview.md Co-authored-by: Pilar Solares <[email protected]> * Update docs/azure/get-started-with-azure/bc-govs-azure-landing-zone-overview.md Co-authored-by: Pilar Solares <[email protected]> * Update docs/azure/design-build-deploy/user-management.md Co-authored-by: Pilar Solares <[email protected]> * Update docs/azure/design-build-deploy/requirements.md Co-authored-by: Pilar Solares <[email protected]> * Update docs/azure/design-build-deploy/networking.md Co-authored-by: Pilar Solares <[email protected]> * Update docs/azure/best-practices/azure-ai.md Co-authored-by: Pilar Solares <[email protected]> * Update docs/azure/best-practices/azure-ai.md Co-authored-by: Pilar Solares <[email protected]> --------- Co-authored-by: Adin Ermie <[email protected]> Co-authored-by: Warren Uniewski <[email protected]> Co-authored-by: Pilar Solares <[email protected]> * Added PR workflow * YAML syntax fix * Added CODEOWNERS file * Update .github/CODEOWNERS --------- Co-authored-by: Shea Phillips <[email protected]> Co-authored-by: Abibat Adesina <[email protected]> Co-authored-by: Warren Uniewski <[email protected]> Co-authored-by: Adin Ermie <[email protected]> Co-authored-by: Pilar Solares <[email protected]> * More link fixes (#54) * Fix "owner" value so links to team page work properly in DevHub Fix "owner" value so links to team page work properly in DevHub. Currently, the link to team owning the docs is broken in Devhub. This change will fix so it displays.a team details page when clicked. * TechDocs Updates for Azure Contnet (#52) * Minor fixes (typos, etc.) * Updates with new content * More updates * Added details about AMBA, and governance best practices * Added more content * Replaced 'Cloud Pathfinder' with 'Public Cloud' * Fixed broken page link * Update docs/azure/best-practices/azure-ai.md Co-authored-by: Pilar Solares <[email protected]> * Update docs/azure/best-practices/azure-ai.md Co-authored-by: Pilar Solares <[email protected]> * Update docs/azure/best-practices/azure-ai.md Co-authored-by: Pilar Solares <[email protected]> * Update docs/azure/get-started-with-azure/bc-govs-azure-landing-zone-overview.md Co-authored-by: Pilar Solares <[email protected]> * Update docs/azure/get-started-with-azure/bc-govs-azure-landing-zone-overview.md Co-authored-by: Pilar Solares <[email protected]> * Update docs/azure/design-build-deploy/user-management.md Co-authored-by: Pilar Solares <[email protected]> * Update docs/azure/design-build-deploy/requirements.md Co-authored-by: Pilar Solares <[email protected]> * Update docs/azure/design-build-deploy/networking.md Co-authored-by: Pilar Solares <[email protected]> * Update docs/azure/best-practices/azure-ai.md Co-authored-by: Pilar Solares <[email protected]> * Update docs/azure/best-practices/azure-ai.md Co-authored-by: Pilar Solares <[email protected]> --------- Co-authored-by: Adin Ermie <[email protected]> Co-authored-by: Warren Uniewski <[email protected]> Co-authored-by: Pilar Solares <[email protected]> * More broken link fixes --------- Co-authored-by: Shea Phillips <[email protected]> Co-authored-by: Abibat Adesina <[email protected]> Co-authored-by: Warren Uniewski <[email protected]> Co-authored-by: Adin Ermie <[email protected]> Co-authored-by: Pilar Solares <[email protected]> * Workflow fixes (#56) * Fix "owner" value so links to team page work properly in DevHub Fix "owner" value so links to team page work properly in DevHub. Currently, the link to team owning the docs is broken in Devhub. This change will fix so it displays.a team details page when clicked. * TechDocs Updates for Azure Contnet (#52) * Minor fixes (typos, etc.) * Updates with new content * More updates * Added details about AMBA, and governance best practices * Added more content * Replaced 'Cloud Pathfinder' with 'Public Cloud' * Fixed broken page link * Update docs/azure/best-practices/azure-ai.md Co-authored-by: Pilar Solares <[email protected]> * Update docs/azure/best-practices/azure-ai.md Co-authored-by: Pilar Solares <[email protected]> * Update docs/azure/best-practices/azure-ai.md Co-authored-by: Pilar Solares <[email protected]> * Update docs/azure/get-started-with-azure/bc-govs-azure-landing-zone-overview.md Co-authored-by: Pilar Solares <[email protected]> * Update docs/azure/get-started-with-azure/bc-govs-azure-landing-zone-overview.md Co-authored-by: Pilar Solares <[email protected]> * Update docs/azure/design-build-deploy/user-management.md Co-authored-by: Pilar Solares <[email protected]> * Update docs/azure/design-build-deploy/requirements.md Co-authored-by: Pilar Solares <[email protected]> * Update docs/azure/design-build-deploy/networking.md Co-authored-by: Pilar Solares <[email protected]> * Update docs/azure/best-practices/azure-ai.md Co-authored-by: Pilar Solares <[email protected]> * Update docs/azure/best-practices/azure-ai.md Co-authored-by: Pilar Solares <[email protected]> --------- Co-authored-by: Adin Ermie <[email protected]> Co-authored-by: Warren Uniewski <[email protected]> Co-authored-by: Pilar Solares <[email protected]> * Workflow fixes * Added workflow_dispatch --------- Co-authored-by: Shea Phillips <[email protected]> Co-authored-by: Abibat Adesina <[email protected]> Co-authored-by: Warren Uniewski <[email protected]> Co-authored-by: Adin Ermie <[email protected]> Co-authored-by: Pilar Solares <[email protected]> * Additional Link Fixes (#57) * Fix "owner" value so links to team page work properly in DevHub Fix "owner" value so links to team page work properly in DevHub. Currently, the link to team owning the docs is broken in Devhub. This change will fix so it displays.a team details page when clicked. * TechDocs Updates for Azure Contnet (#52) * Minor fixes (typos, etc.) * Updates with new content * More updates * Added details about AMBA, and governance best practices * Added more content * Replaced 'Cloud Pathfinder' with 'Public Cloud' * Fixed broken page link * Update docs/azure/best-practices/azure-ai.md Co-authored-by: Pilar Solares <[email protected]> * Update docs/azure/best-practices/azure-ai.md Co-authored-by: Pilar Solares <[email protected]> * Update docs/azure/best-practices/azure-ai.md Co-authored-by: Pilar Solares <[email protected]> * Update docs/azure/get-started-with-azure/bc-govs-azure-landing-zone-overview.md Co-authored-by: Pilar Solares <[email protected]> * Update docs/azure/get-started-with-azure/bc-govs-azure-landing-zone-overview.md Co-authored-by: Pilar Solares <[email protected]> * Update docs/azure/design-build-deploy/user-management.md Co-authored-by: Pilar Solares <[email protected]> * Update docs/azure/design-build-deploy/requirements.md Co-authored-by: Pilar Solares <[email protected]> * Update docs/azure/design-build-deploy/networking.md Co-authored-by: Pilar Solares <[email protected]> * Update docs/azure/best-practices/azure-ai.md Co-authored-by: Pilar Solares <[email protected]> * Update docs/azure/best-practices/azure-ai.md Co-authored-by: Pilar Solares <[email protected]> --------- Co-authored-by: Adin Ermie <[email protected]> Co-authored-by: Warren Uniewski <[email protected]> Co-authored-by: Pilar Solares <[email protected]> * Trigger Build * Removed filter for PRs, added link path oddity * Fixed other broken link path * Updated workflow names * Updated README with local prereqs --------- Co-authored-by: Shea Phillips <[email protected]> Co-authored-by: Abibat Adesina <[email protected]> Co-authored-by: Warren Uniewski <[email protected]> Co-authored-by: Adin Ermie <[email protected]> Co-authored-by: Pilar Solares <[email protected]> * plugin for date and content management updates (#60) * updated local runtime instructions (#61) * Updated git ignore (#62) Co-authored-by: Adin Ermie <[email protected]> * Updated all 'Last Updated' lines to use git-revision-date-localized plugin to auto-populate date (#63) Co-authored-by: Adin Ermie <[email protected]> * Fixed README PowerShell command (#64) Co-authored-by: Adin Ermie <[email protected]> * Updated markdown template file * Added Call-Outs (#66) * Added call-out examples * Added markdown linting * Added markdown lint control file * Increased line length rule * Removed Markdown linting --------- Co-authored-by: Adin Ermie <[email protected]> * Update mkdocs configuration and move security guardrails document (#68) * Update mkdocs configuration and move security guardrails document - Added a new navigation entry for "Security guardrails" in the AWS section of mkdocs.yml. - Removed the obsolete security guardrails document from the AWS design-build-and-deploy section. - Cleaned up mkdocs.yml by removing unnecessary trailing spaces. This update enhances the documentation structure by including relevant security guidelines while eliminating outdated content. * Fix links on aws security guardrails section - Updated bullet points to use asterisks for better readability. - Clarified restrictions on encryption, security services, logging, and account management. - Improved links to related documentation for IAM user management and user management documentation. These changes enhance the overall structure and accessibility of the security guidelines, ensuring users can easily understand and navigate the content. * Fix link to AWS Security & Compliance Guardrails document for improved navigation in the AWS landing zone overview. * Update mkdocs.yml to clarify AWS Security guardrails section - Renamed navigation entry from "Security guardrails" to "AWS Security and compliance guardrails" for improved clarity and consistency in the documentation structure. * Added guidance on license plates (#69) Co-authored-by: Adin Ermie <[email protected]> * TechDoc updates related to CAF v6.2.0 changes (especially around new policies) (#71) Co-authored-by: Adin Ermie <[email protected]> * Self-Hosted CICD Runners Guidance (#70) * Modified publish workflow path * Added section on self-hosted runners guidance --------- Co-authored-by: Adin Ermie <[email protected]> * Added section on OpenAI monitoring (#72) Co-authored-by: Adin Ermie <[email protected]> * Update docs/welcome/support.md Co-authored-by: Pilar Solares <[email protected]> * Update docs/azure/best-practices/azure-ai.md Co-authored-by: Pilar Solares <[email protected]> --------- Co-authored-by: Adin Ermie <[email protected]> Co-authored-by: Warren Uniewski <[email protected]> Co-authored-by: Pilar Solares <[email protected]> Co-authored-by: Shea Phillips <[email protected]> Co-authored-by: Abibat Adesina <[email protected]> Co-authored-by: Copilot <[email protected]> Co-authored-by: Max Wardle <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull request includes several updates to the GitHub Actions workflows and the Azure CI/CD best practices documentation. The most important changes include expanding the file path patterns in the workflow triggers and reorganizing and enhancing the best practices documentation for better clarity and completeness.
Workflow Trigger Updates:
.github/workflows/publish-dev.yaml: Updated the file path pattern from"docs/*"to"docs/**"to include all nested files and directories..github/workflows/publish-prod.yaml: Updated the file path pattern from"docs/*"to"docs/**"to include all nested files and directories.Documentation Enhancements:
docs/azure/best-practices/ci-cd.md: Reorganized the best practices section for using GitHub Actions with Azure, including moving the self-hosted runners recommendation to a more appropriate location.docs/azure/best-practices/ci-cd.md: Capitalized "Application" and "Service Principal" for consistency in the setup instructions.docs/azure/best-practices/ci-cd.md: Added a detailed section on self-hosted runners on Azure, including information on the Azure Verified Module, sample Terraform code, and pre-requisites.