Update Darc.md documentation for Version.Details.props and SkipProperty attribute changes by Copilot · Pull Request #5346 · dotnet/arcade-services

Copilot · 2025-10-07T15:02:55Z

Review PR Split Version.props into Version.props and Version.Details.props #5067 and Don't generate a Version Details Props header for repos with only SkipProperty dependencies #5209 changes to understand what was implemented
Add section on Version.Details.props file
Document the SkipProperty attribute in Version.Details.xml
Document header generation behavior for repos with only SkipProperty dependencies
Add examples showing proper configuration
Update index and references throughout the document
Build and test to ensure no syntax errors in documentation
Address review feedback: Remove "When to use SkipProperty" section
Address review feedback: Simplify migration steps

Original prompt

This section details on the original issue you should resolve

<issue_title>Update Darc.md documentation for Version.Details.props and SkipProperty attribute changes</issue_title>
<issue_description>Update the Darc.md documentation to reflect changes implemented in the following PRs:

Split Version.props into Version.props and Version.Details.props #5067

Don't generate a Version Details Props header for repos with only SkipProperty dependencies #5209

Key points to address:

Version.Details.props File

Describe the addition of the new Version.Details.props file.

Document that if Version.Details.props exists, it will be used.

Explain when and how this file is generated or consumed.

SkipProperty Attribute in Version.Details.xml

Introduce and document the SkipProperty attribute that can be added in Version.Details.xml.

Describe its purpose and how it affects dependency management.

Other Relevant Changes

Summarize any additional relevant changes from the referenced PRs, such as header generation behavior for repos with only SkipProperty dependencies.

Ensure examples and configuration/process details are clear for users maintaining or integrating with Darc-managed repositories.</issue_description>

Comments on the Issue (you are @copilot in this section)

Fixes #5345

💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

…ty attribute Co-authored-by: dkurepa <91743470+dkurepa@users.noreply.github.com>

dkurepa · 2025-10-07T19:48:39Z

docs/Darc.md

+- If ALL dependencies from a repository have `SkipProperty="true"`, no repository header
+  comment will be generated in `Version.Details.props`
+
+**When to use SkipProperty:**


@copilot remove this part

Done in a2a0881

Co-authored-by: dkurepa <91743470+dkurepa@users.noreply.github.com>

dkurepa · 2025-10-07T19:59:18Z

docs/Darc.md

+   ```xml
+   <Import Project="Version.Details.props" Condition="Exists('Version.Details.props')" />
+   ```
+3. Run `darc update-dependencies` to regenerate version properties


@copilot you can also remove the steps 2. 3. 4. 5. Instead say that the file will be populated during the next dependency update, and that a merge policy will provide further instructions

Done in 9c199d8. Simplified the migration steps to just creating an empty file, with a note that it will be populated automatically and the merge policy will provide further instructions.

Co-authored-by: dkurepa <91743470+dkurepa@users.noreply.github.com>

Copilot

Pull Request Overview

Updates Darc documentation to describe the new Version.Details.props file workflow and the SkipProperty attribute, and adjusts related command descriptions.

Adds TOC entry and a dedicated section detailing Version.Details.props and SkipProperty.
Updates add-dependency command description to reflect new property generation logic.
Provides migration guidance from legacy Versions.props usage.

Copilot · 2025-10-07T20:00:57Z

docs/Darc.md


 When adding a new dependency, only name and type are required.  For a detailed
-discussion on adding new dependencies to a repository, see [Adding dependencies to a repository](#adding-dependencies-to-a-repository)
+discussion on adding new dependencies to a repository, see [Adding dependencies to a repository](#adding-dependencies-to-a-repository).


The file name is incorrect; it should be Version.Details.xml (plural 'Details').

Suggested change

discussion on adding new dependencies to a repository, see [Adding dependencies to a repository](#adding-dependencies-to-a-repository).

Add a new tracked dependency to the Version.Details.xml file in your local repo.

Copilot · 2025-10-07T20:00:58Z

docs/Darc.md

+
+See also [Version.Details.props and the SkipProperty attribute](#versiondetailsprops-and-the-skipproperty-attribute) 
+for information on how dependency properties are generated.



Capitalize GitHub properly.

Suggested change

into the remote GitHub or AzDO repository, the dependency can be updated by Maestro++

Copilot · 2025-10-07T20:00:58Z

docs/Darc.md

+
+**Key characteristics:**
+- **Auto-generated**: This file is created and maintained automatically by Maestro dependency flow.
+- **Do not manually edit**: Changes will be overwritten by automation during dependency updates.


[nitpick] Consider adding an explicit note that Version.Details.props must be checked into source control (not gitignored) so automation can update it via PRs.

Suggested change

- **Do not manually edit**: Changes will be overwritten by automation during dependency updates.

- **Do not manually edit**: Changes will be overwritten by automation during dependency updates.

- **Must be checked into source control**: This file **must not** be gitignored. It should be committed to your repository so that automation can update it via pull requests.

docs/Darc.md

Co-authored-by: Přemek Vysoký <premek.vysoky@microsoft.com>

Initial plan

5c9a9fe

Copilot AI assigned Copilot and dkurepa Oct 7, 2025

Copilot started work on behalf of dkurepa October 7, 2025 15:03 View session

Update Darc.md documentation for Version.Details.props and SkipProper…

9ec06af

…ty attribute Co-authored-by: dkurepa <91743470+dkurepa@users.noreply.github.com>

Copilot AI changed the title ~~[WIP] Update Darc.md documentation for version details changes~~ Update Darc.md documentation for Version.Details.props and SkipProperty attribute changes Oct 7, 2025

Copilot AI requested a review from dkurepa October 7, 2025 15:14

Copilot finished work on behalf of dkurepa October 7, 2025 15:14

dkurepa reviewed Oct 7, 2025

View reviewed changes

Copilot started work on behalf of dkurepa October 7, 2025 19:50 View session

Remove 'When to use SkipProperty' section per review feedback

a2a0881

Co-authored-by: dkurepa <91743470+dkurepa@users.noreply.github.com>

Copilot AI requested a review from dkurepa October 7, 2025 19:52

Copilot finished work on behalf of dkurepa October 7, 2025 19:52

dkurepa reviewed Oct 7, 2025

View reviewed changes

dkurepa marked this pull request as ready for review October 7, 2025 19:59

Copilot AI review requested due to automatic review settings October 7, 2025 19:59

Copilot started work on behalf of dkurepa October 7, 2025 19:59 View session

Simplify migration steps per review feedback

9c199d8

Co-authored-by: dkurepa <91743470+dkurepa@users.noreply.github.com>

Copilot AI reviewed Oct 7, 2025

View reviewed changes

Copilot AI requested a review from dkurepa October 7, 2025 20:01

Copilot finished work on behalf of dkurepa October 7, 2025 20:01

premun reviewed Oct 8, 2025

View reviewed changes

docs/Darc.md Outdated Show resolved Hide resolved

docs/Darc.md Outdated Show resolved Hide resolved

docs/Darc.md Outdated Show resolved Hide resolved

docs/Darc.md Outdated Show resolved Hide resolved

dkurepa and others added 4 commits October 8, 2025 09:52

Update docs/Darc.md

85c4fd0

Co-authored-by: Přemek Vysoký <premek.vysoky@microsoft.com>

Update docs/Darc.md

2f2c770

Co-authored-by: Přemek Vysoký <premek.vysoky@microsoft.com>

Update docs/Darc.md

94cac8e

Co-authored-by: Přemek Vysoký <premek.vysoky@microsoft.com>

Update docs/Darc.md

8f93d6a

Co-authored-by: Přemek Vysoký <premek.vysoky@microsoft.com>

premun approved these changes Oct 8, 2025

View reviewed changes

dkurepa merged commit a026082 into main Oct 8, 2025
2 of 6 checks passed

dkurepa deleted the copilot/update-darc-docs-for-version-details branch October 8, 2025 09:32

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update Darc.md documentation for Version.Details.props and SkipProperty attribute changes#5346

Update Darc.md documentation for Version.Details.props and SkipProperty attribute changes#5346
dkurepa merged 8 commits intomainfrom
copilot/update-darc-docs-for-version-details

Copilot AI commented Oct 7, 2025 •

edited

Loading

Uh oh!

dkurepa Oct 7, 2025

Uh oh!

Copilot AI Oct 7, 2025

Uh oh!

dkurepa Oct 7, 2025

Uh oh!

Copilot AI Oct 7, 2025

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Oct 7, 2025

Uh oh!

Copilot AI Oct 7, 2025

Uh oh!

Copilot AI Oct 7, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

	discussion on adding new dependencies to a repository, see [Adding dependencies to a repository](#adding-dependencies-to-a-repository).
	Add a new tracked dependency to the Version.Details.xml file in your local repo.


		See also [Version.Details.props and the SkipProperty attribute](#versiondetailsprops-and-the-skipproperty-attribute)
		for information on how dependency properties are generated.


	into the remote GitHub or AzDO repository, the dependency can be updated by Maestro++

	- Do not manually edit: Changes will be overwritten by automation during dependency updates.
	- Do not manually edit: Changes will be overwritten by automation during dependency updates.
	- Must be checked into source control: This file must not be gitignored. It should be committed to your repository so that automation can update it via pull requests.

Conversation

Copilot AI commented Oct 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Comments on the Issue (you are @copilot in this section)

Uh oh!

dkurepa Oct 7, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 7, 2025

Choose a reason for hiding this comment

Uh oh!

dkurepa Oct 7, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 7, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Copilot AI Oct 7, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 7, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 7, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Copilot AI commented Oct 7, 2025 •

edited

Loading