Skip to content

[docs] Add comprehensive release process documentation from net10.0 branch #30582

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

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

Copilot
Copy link
Contributor

@Copilot Copilot AI commented Jul 11, 2025

Note

Are you waiting for the changes in this PR to be merged?
It would be very helpful if you could test the resulting artifacts from this PR and let us know in a comment if this change resolves your issue. Thank you!

This PR moves the comprehensive release process documentation from the net10.0 branch to main and enhances it with additional information about service releases using the arcade/mirror infrastructure.

Changes Made

1. Created docs/ReleaseProcess.md (243 lines)

  • Complete Arcade-based release process: Detailed documentation of the two-phase release process using azure-pipelines-internal.yml and maui-release-internal.yml
  • Build and pack pipeline details: Comprehensive coverage of the build, pack, sign, and BAR publishing process
  • Release pipeline workflow: Step-by-step guide for publishing to workload sets and NuGet.org
  • Arcade, Darc, and Maestro integration: Detailed explanation of how these tools work together

2. Added Service Release Information

  • Default channel creation: Added section explaining how to create default channels when branching releases, including the exact darc add-default-channel command format:
    darc add-default-channel --channel ".NET 9.0.1xx SDK" --branch "release/9.0.1xx-sr9" --repo https://github.com/dotnet/maui
  • Workload set integration: New section covering the integration with dotnet/workload-versions repository and automatic Visual Studio insertions
  • Channel naming conventions: Guidelines for naming channels consistently across different release types

3. Enhanced Documentation Discoverability

  • Updated docs/README.md: Added ReleaseProcess.md to the documentation index table with proper description for contributors and maintainers
  • Enhanced eng/README.md: Added cross-reference to the comprehensive release process documentation while maintaining existing dependency management information

Key Features Addressed

Moved release info from net10.0 branch: All content from docs/ReleaseProcess.md on the net10.0 branch has been successfully moved to main

Default channel creation: Added comprehensive guidance on creating default channels when branching releases, including required darc commands

Workload set integration: Documented the new service release process using arcade/mirror infrastructure with automatic Visual Studio insertions via the dotnet/workload-versions repository

Cross-referenced documentation: Updated existing documentation to reference the new comprehensive release process guide

The documentation now provides complete guidance for both regular releases and service releases, ensuring maintainers have all the information needed to manage the .NET MAUI release process effectively.

Fixes #30581.


💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.

Copilot AI and others added 2 commits July 11, 2025 16:14
Co-authored-by: rmarinho <1235097+rmarinho@users.noreply.github.com>
Co-authored-by: rmarinho <1235097+rmarinho@users.noreply.github.com>
@Copilot Copilot AI changed the title [WIP] [docs] Update the docs with release info that lives on net10.0 branch [docs] Add comprehensive release process documentation from net10.0 branch Jul 11, 2025
Copilot finished work on behalf of rmarinho July 11, 2025 16:17
@Copilot Copilot AI requested a review from rmarinho July 11, 2025 16:17
@rmarinho rmarinho requested a review from Copilot July 11, 2025 16:34
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR adds a comprehensive release process guide and updates documentation indexes to reference it:

  • Introduces docs/ReleaseProcess.md with end-to-end instructions for building, packing, and publishing .NET MAUI releases, including service releases.
  • Updates docs/README.md and eng/README.md to link to the new release process documentation.

Reviewed Changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.

File Description
eng/README.md Added callout linking to the new Release Process documentation
docs/ReleaseProcess.md New, detailed guide covering Arcade-based build, pack, and release pipelines, branching, channels, and workload integration
docs/README.md Inserted a table entry for the new Release Process guide
Comments suppressed due to low confidence (2)

docs/ReleaseProcess.md:142

3. **Automatic Insertion**: The CI system in the `dotnet/workload-versions` repository automatically detects new workload sets and creates pull requests to update Visual Studio release branches.

docs/ReleaseProcess.md:92

  • [nitpick] These steps overlap with the earlier 'Release Flow' description. Consider clarifying or merging repeated steps to improve readability.
5. The release pipeline will then:

@rmarinho rmarinho requested a review from PureWeen July 11, 2025 17:40
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.

[docs] Update the docs with release info that lives on net10.0 branch
2 participants