diff --git a/content/library/overview/release-notes.md b/content/library/overview/release-notes.md deleted file mode 100644 index d6e59ca..0000000 --- a/content/library/overview/release-notes.md +++ /dev/null @@ -1,56 +0,0 @@ ---- -# SPDX-FileCopyrightText: GitHub and The Project Authors -# SPDX-License-Identifier: MIT -title: Release notes -weight: 4 -prev: library/overview/getting-started-checklist -next: library/scenarios ---- - -Find general updates here on new content, feature enhancements, and improvements that help teams architect and optimize deployments of the tools that support their development communities. - -## 2025 Q4 - -- **New Content: Actions Runner Controller (ARC) best practices** - Published an opinionated guidance for operating ARC on Kubernetes, including recommendations for runner images, configuration, observability, and security trade-offs -- **New Content: Securing developer workspace** - Published an design guidance for hardening developer workspaces, including identity and authorization, workspace isolation, and signed commit practices -- **Update: Securing GitHub Actions workflows** - Added opinionated guidance for OIDC, repository rulesets, and safer workflow patterns, with specific recommendations for public repository security - -## 2025 Q3 - -- **Update: Repository Management Enhancement** - Updated the "Managing repositories at scale" article with opinionated guidance on adopting rulesets and custom properties to meet business objectives, including actionable strategies for governance at scale -- **Update: GitHub Actions Policy Updates** - Updated the GitHub Actions recommendations with new policy capabilities and more prescriptive governance and security guidance for managing workflows at scale -- **New Content: GitHub Copilot Enterprise Administration** - Published an enterprise playbook for managing GitHub Copilot Premium Request Units (PRUs), including budget configuration, KPI targets, monitoring, and cost control strategies -- **New Content: Security Alert Management** - Published a scenario for prioritizing security alert remediation using GitHub's built-in metadata and organizational context, including practical guidance on implementing GitHub's security campaigns and vulnerability triage workflows -- **New Content: Champion Program** - Published a recommendation for champion programs that empower engaged employees to guide peers through AI-driven change. - -## 2025 Q2 - -- **New Content: Azure DevOps Migration Guide** - Published migration scenarios and playbooks for transitioning from Azure DevOps to GitHub, including phased approaches, feature comparisons, and practical guidance for translating Azure DevOps settings to GitHub equivalents -- **New Content: Engineering System Success Framework** - Published the Engineering System Success Framework to help organizations evaluate Copilot business value, including design principles, checklists, metrics, implementation phases, anti-patterns, and intervention strategies -- **Site Improvements** - Introduced a new Copilot Chat Widget that provides interactive assistance for users - -## 2025 Q1 - -- **New Content: GitHub Actions Scalability** - Published guidance for scaling GitHub Actions reusability in enterprise environments, including best practices for workflow optimization, action management, and enterprise-wide deployment -- **New Content: Repository Migration Essentials** - Introduced a generalized repository migration checklist covering pre-planning, testing, execution, and post-migration, designed to serve as a single source of truth across migration approaches -- **Design Principle Updates** - Expanded real-world examples across pillars, including clearer guidance on pull request best practices, early vulnerability scanning, and multi-region deployment considerations -- **Checklists 2.0** - Overhauled the assessment checklists to align with recent GitHub product updates and introduced tiers to help teams prioritize actions based on maturity -- **Fixes & Refinements** - Improved clarity and usability with refinements to pillar content, navigation, homepage layout, and the hosting template for simpler ongoing maintenance - -## 2024 Q4 - -- **General Availability (GA) and Well-Architected MVP Launch** - Transitioned from beta to GA with a fully published structure around the five pillars, including curated examples and illustrations that demonstrate practical implementations -- **Initial Tooling & Assessment Checklists** - Provided downloadable checklists for customers to self-assess alignment with the framework and gathered early adoption feedback to inform Checklists 2.0 -- **Design Principles and Content Highlights** - Published an in-depth overview of the five pillars (Productivity, Collaboration, Application Security, Governance, and Architecture), co-authored an initial set of design principles with KPMG and our Partner Community, and added a high-level scenario for teams starting with GitHub Enterprise -- **Early Feedback Incorporations** - Streamlined site layouts and navigation based on beta feedback, and expanded scenario guidance including scaling Git repositories and enforcing GHAS at scale - -## Future Plans & Roadmap - -- **Partner & Ecosystem Growth**: Ongoing partner showcases, workshops, and contributions will introduce new specialized assessment offerings -- **Deeper AI Integration**: Expanding GitHub Copilot insights and AI-based recommendations to cover governance, security, and productivity checks -- **Advanced Scenarios & Recommendations**: Adding guides on large-scale workflows, compliance-first deployments, and hybrid architectures -- **Continuous Feedback**: Regularly soliciting community input through partner channels and real-world customer engagements to shape new content - -We're committed to continuous improvement of GitHub Well-Architected. If you have questions or feedback, please reach out to your Partner or our GitHub Support and Services teams. - -Thank you for your interest in building resilient, scalable development practices! diff --git a/content/library/overview/release-notes/2024-q4.md b/content/library/overview/release-notes/2024-q4.md new file mode 100644 index 0000000..4802a1e --- /dev/null +++ b/content/library/overview/release-notes/2024-q4.md @@ -0,0 +1,8 @@ + + +## 2024 Q4 + +- **General Availability (GA) and Well-Architected MVP Launch** - Transitioned from beta to GA with a fully published structure around the five pillars, including curated examples and illustrations that demonstrate practical implementations +- **Initial Tooling & Assessment Checklists** - Provided downloadable checklists for customers to self-assess alignment with the framework and gathered early adoption feedback to inform Checklists 2.0 +- **Design Principles and Content Highlights** - Published an in-depth overview of the five pillars (Productivity, Collaboration, Application Security, Governance, and Architecture), co-authored an initial set of design principles with KPMG and our Partner Community, and added a high-level scenario for teams starting with GitHub Enterprise +- **Early Feedback Incorporations** - Streamlined site layouts and navigation based on beta feedback, and expanded scenario guidance including scaling Git repositories and enforcing GHAS at scale diff --git a/content/library/overview/release-notes/2025-q1.md b/content/library/overview/release-notes/2025-q1.md new file mode 100644 index 0000000..ad67b5e --- /dev/null +++ b/content/library/overview/release-notes/2025-q1.md @@ -0,0 +1,9 @@ + + +## 2025 Q1 + +- **New Content: GitHub Actions Scalability** - Published guidance for scaling GitHub Actions reusability in enterprise environments, including best practices for workflow optimization, action management, and enterprise-wide deployment +- **New Content: Repository Migration Essentials** - Introduced a generalized repository migration checklist covering pre-planning, testing, execution, and post-migration, designed to serve as a single source of truth across migration approaches +- **Design Principle Updates** - Expanded real-world examples across pillars, including clearer guidance on pull request best practices, early vulnerability scanning, and multi-region deployment considerations +- **Checklists 2.0** - Overhauled the assessment checklists to align with recent GitHub product updates and introduced tiers to help teams prioritize actions based on maturity +- **Fixes & Refinements** - Improved clarity and usability with refinements to pillar content, navigation, homepage layout, and the hosting template for simpler ongoing maintenance diff --git a/content/library/overview/release-notes/2025-q2.md b/content/library/overview/release-notes/2025-q2.md new file mode 100644 index 0000000..b17e84f --- /dev/null +++ b/content/library/overview/release-notes/2025-q2.md @@ -0,0 +1,7 @@ + + +## 2025 Q2 + +- **New Content: Azure DevOps Migration Guide** - Published migration scenarios and playbooks for transitioning from Azure DevOps to GitHub, including phased approaches, feature comparisons, and practical guidance for translating Azure DevOps settings to GitHub equivalents +- **New Content: Engineering System Success Framework** - Published the Engineering System Success Framework to help organizations evaluate Copilot business value, including design principles, checklists, metrics, implementation phases, anti-patterns, and intervention strategies +- **Site Improvements** - Introduced a new Copilot Chat Widget that provides interactive assistance for users diff --git a/content/library/overview/release-notes/2025-q3.md b/content/library/overview/release-notes/2025-q3.md new file mode 100644 index 0000000..f4841ca --- /dev/null +++ b/content/library/overview/release-notes/2025-q3.md @@ -0,0 +1,9 @@ + + +## 2025 Q3 + +- **Update: Repository Management Enhancement** - Updated the "Managing repositories at scale" article with opinionated guidance on adopting rulesets and custom properties to meet business objectives, including actionable strategies for governance at scale +- **Update: GitHub Actions Policy Updates** - Updated the GitHub Actions recommendations with new policy capabilities and more prescriptive governance and security guidance for managing workflows at scale +- **New Content: GitHub Copilot Enterprise Administration** - Published an enterprise playbook for managing GitHub Copilot Premium Request Units (PRUs), including budget configuration, KPI targets, monitoring, and cost control strategies +- **New Content: Security Alert Management** - Published a scenario for prioritizing security alert remediation using GitHub's built-in metadata and organizational context, including practical guidance on implementing GitHub's security campaigns and vulnerability triage workflows +- **New Content: Champion Program** - Published a recommendation for champion programs that empower engaged employees to guide peers through AI-driven change. diff --git a/content/library/overview/release-notes/2025-q4.md b/content/library/overview/release-notes/2025-q4.md new file mode 100644 index 0000000..0dff637 --- /dev/null +++ b/content/library/overview/release-notes/2025-q4.md @@ -0,0 +1,7 @@ + + +## 2025 Q4 + +- **New Content: Actions Runner Controller (ARC) best practices** - Published an opinionated guidance for operating ARC on Kubernetes, including recommendations for runner images, configuration, observability, and security trade-offs +- **New Content: Securing developer workspace** - Published an design guidance for hardening developer workspaces, including identity and authorization, workspace isolation, and signed commit practices +- **Update: Securing GitHub Actions workflows** - Added opinionated guidance for OIDC, repository rulesets, and safer workflow patterns, with specific recommendations for public repository security diff --git a/content/library/overview/release-notes/index.md b/content/library/overview/release-notes/index.md new file mode 100644 index 0000000..5e7864e --- /dev/null +++ b/content/library/overview/release-notes/index.md @@ -0,0 +1,23 @@ +--- +# SPDX-FileCopyrightText: GitHub and The Project Authors +# SPDX-License-Identifier: MIT +title: Release notes +weight: 4 +prev: library/overview/getting-started-checklist +next: library/scenarios +--- + +Find general updates here on new content, feature enhancements, and improvements that help teams architect and optimize deployments of the tools that support their development communities. + +{{% quarterly-updates %}} + +## Future Plans & Roadmap + +- **Partner & Ecosystem Growth**: Ongoing partner showcases, workshops, and contributions will introduce new specialized assessment offerings +- **Deeper AI Integration**: Expanding GitHub Copilot insights and AI-based recommendations to cover governance, security, and productivity checks +- **Advanced Scenarios & Recommendations**: Adding guides on large-scale workflows, compliance-first deployments, and hybrid architectures +- **Continuous Feedback**: Regularly soliciting community input through partner channels and real-world customer engagements to shape new content + +We're committed to continuous improvement of GitHub Well-Architected. If you have questions or feedback, please reach out to your Partner or our GitHub Support and Services teams. + +Thank you for your interest in building resilient, scalable development practices! diff --git a/layouts/shortcodes/quarterly-updates.html b/layouts/shortcodes/quarterly-updates.html new file mode 100644 index 0000000..6748163 --- /dev/null +++ b/layouts/shortcodes/quarterly-updates.html @@ -0,0 +1,24 @@ +{{- /* +Shortcode: quarterly-updates + +Auto-renders quarterly release notes section files from the current page bundle. + +Convention: + - Quarterly section resources are named like "YYYY-qN.md" (for example, "2025-q4.md"). + - Sorting is based on filename (descending). + - Files must use markdown headings (##) for TOC compatibility. + +Usage: + {{% quarterly-updates %}} + +Note: Use percent delimiters (%) instead of angle brackets (<) so headings appear in TOC. +*/ -}} + +{{- $sections := .Page.Resources.Match "20*-q*.md" -}} +{{- if not $sections -}} + {{- errorf "quarterly-updates: no matching section files found for %q" .Page.File.Path -}} +{{- end -}} + +{{- range (sort $sections "Name" "desc") -}} + {{- .RenderShortcodes -}} +{{- end -}}