DYN-9702: Add definition folder and dyf by Chloepeg · Pull Request #17201 · DynamoDS/Dynamo

Chloepeg · 2026-06-30T16:59:07Z

Purpose

This PR addresses DYN-9702.

This update adds the .dyf file used by the custom node template introduced in DYN-9927(#16861). The code changes ensure that Curve_Validate.dyf ships with Dynamo as a proper custom node definition, making it available from the Add-ons section of the Dynamo library when starting.

changes :

Added a new shipped definitions source folder at doc/distrib/Definitions.
Added Curve_Validate.dyf as a shipped custom node definition.
Updated DynamoCore.csproj to copy shipped definitions into the runtime definitions folder during build.
Updated PathManager.DefinitionDirectories to include the shipped runtime definitions folder when it exists.
Updated the related path manager test to account for the optional shipped definitions path.
Cleared user-specific File Path values in doc/distrib/Templates/en-US/Import & Export Workflow.dyn, and set the associated files note to N/A.
-Removed unused sample files from doc/distrib/Templates/Data/.

Declarations

Check these if you believe they are true

Is documented according to the standards
The level of testing this PR includes is appropriate
Changes to the API follow Semantic Versioning and are documented in the API Changes document.

Release Notes

Curve_Validate.dyf is now shipped as a custom node definition, appears in the Dynamo library under Add-ons, and is available for Make a Custom Node.dyn template introduced in DYN-9927
The Import & Export template- Us no longer includes hardcoded file paths or sample data files.

Reviewers

@zeusongit
@DynamoDS/eidos

FYIs

@dnenov
@johnpierson
@jnealb
@jasonstratton

github-actions

See the ticket for this pull request: https://jira.autodesk.com/browse/DYN-9702

Copilot

Pull request overview

This PR adds support for shipping a custom node definition (Curve_Validate.dyf) with Dynamo by introducing a new doc/distrib/Definitions source folder, copying those assets into the build output, and extending PathManager.DefinitionDirectories to include the shipped runtime definitions folder when present.

Changes:

Adds a new shipped definitions source folder and includes Curve_Validate.dyf.
Updates DynamoCore.csproj to copy shipped definitions into the build output under definitions/.
Updates PathManager.DefinitionDirectories (and its related test) to include the shipped runtime definitions folder when it exists.

Reviewed changes

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

File	Description
test/Libraries/PackageManagerTests/PackageLoaderTests.cs	Updates a PathManager-related test to account for an additional optional definitions directory.
src/DynamoCore/DynamoCore.csproj	Adds `DefinitionFiles` items and copies them to `$(OutputPath)definitions\...` during build.
src/DynamoCore/Configuration/PathManager.cs	Extends `DefinitionDirectories` to append a common/runtime definitions directory when present.
doc/distrib/Definitions/Curve_Validate.dyf	Adds the shipped custom node definition to be included in runtime definitions.

jasonstratton · 2026-06-30T23:17:41Z

+            var commonDefinitions = Path.Combine(pathManager.CommonDataDirectory, PathManager.DefinitionsDirectoryName);
+            var expectedDefinitionDirectoryCount = Directory.Exists(commonDefinitions) ? 3 : 2;


I think I was going to make a similar comment. But maybe my analysis is wrong. When this test runs in the CI pipeline, the directory is created by the CI process and should always return 3, right? ... When does it return 2? When testing locally?

And if the CI fails to create the dir, won't the assert still pass with a value of 2?

What happens if we ever add another directory or want to remove one? Does the test suddenly start failing? Probably an easy fix though.

I've updated it to always expect the shipped folder to exist and be included in DefinitionDirectories, with a fixed count of 3. CI should always meet that after the DynamoCore build copies doc/distrib/Definitions into the output.

jasonstratton · 2026-06-30T23:24:55Z

+        "TypeName": "bool",
+        "TypeRank": 0,
+        "DefaultValue": "false",
+        "Description": "Closed rule\ntrue = closed curves allowed\nfalse = open curves allowed"


Good catch by copilot here. The description should indicate only closed curved accepted. It reads like if the parameter is true, both closed and open curves are accepted

I updated the description so true means curves must be closed, which matches the node logic and the group note.

Chloepeg · 2026-07-07T16:11:56Z

+      },
+      {
+        "Id": "a4e7bab50f804226a58b34748879b6eb",
+        "Title": "ADDITIONAL COMMENTS\n_____________________________________________________ \n\nCustom nodes are typically found in the Add-ons section of the Library.\r\nThis custom node is located under:\r\nAdd-ons → Standards → Curve → Curve_Validate\r\n\r\nIf it does not appear:\r\n\r\nCheck that the .dyf file is in your custom nodes folder\r\n\r\nGo to:\r\nPackages → Package Manager → Package Settings → Package/Lirary Search Paths\r\nVerify the folder path is listed or add a new path\r\nRestart Dynamo after adding new custom nodes\n",


jasonstratton

Just address the Copilot comments and it is good.

jasonstratton · 2026-06-30T23:17:41Z

+            var commonDefinitions = Path.Combine(pathManager.CommonDataDirectory, PathManager.DefinitionsDirectoryName);
+            var expectedDefinitionDirectoryCount = Directory.Exists(commonDefinitions) ? 3 : 2;


I think I was going to make a similar comment. But maybe my analysis is wrong. When this test runs in the CI pipeline, the directory is created by the CI process and should always return 3, right? ... When does it return 2? When testing locally?

And if the CI fails to create the dir, won't the assert still pass with a value of 2?

What happens if we ever add another directory or want to remove one? Does the test suddenly start failing? Probably an easy fix though.

jasonstratton · 2026-06-30T23:24:55Z

+        "TypeName": "bool",
+        "TypeRank": 0,
+        "DefaultValue": "false",
+        "Description": "Closed rule\ntrue = closed curves allowed\nfalse = open curves allowed"


Good catch by copilot here. The description should indicate only closed curved accepted. It reads like if the parameter is true, both closed and open curves are accepted

add a Definitions folder for custom node .dyf files, similar to how templates are already shipped from doc/distrib/Templates. The new Curve_Validate.dyf file is copied into the build output definitions folder, and Dynamo now includes that shipped folder when scanning for custom node definitions at startup. DynamoCore.csproj now treats doc/distrib/Definitions as a source folder for shipped custom node definitions and copies it to the runtime definitions folder. PathManager.DefinitionDirectories now includes the shipped definitions folder if it exists, while keeping the existing user/package definition paths unchanged. The related test now allows the extra shipped definitions path when that folder is present.

- Make definition directories test assert shipped definitions folder exists - Clarify requireClosed description in Curve_Validate.dyf - Fix Package/Library Search Paths typo in Curve_Validate note

Remove user-specific File Path values, set associated files note to N/A, and delete unused Templates/Data sample files.

sonarqubecloud · 2026-07-13T16:52:24Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

jasonstratton

LGTM. Thank you for the changes Chloe

github-actions Bot changed the title ~~Add definition folder and dyf~~ DYN-9702: Add definition folder and dyf Jun 30, 2026

github-actions Bot reviewed Jun 30, 2026

View reviewed changes

jasonstratton requested a review from Copilot June 30, 2026 23:05

Copilot started reviewing on behalf of jasonstratton June 30, 2026 23:06 View session

jasonstratton self-requested a review June 30, 2026 23:06

Copilot AI reviewed Jun 30, 2026

View reviewed changes

jasonstratton requested changes Jun 30, 2026

View reviewed changes

Chloepeg added 3 commits July 13, 2026 10:43

Address Pr comments

499b317

- Make definition directories test assert shipped definitions folder exists - Clarify requireClosed description in Curve_Validate.dyf - Fix Package/Library Search Paths typo in Curve_Validate note

Clear en-US Import & Export template file paths and sample data

9fe0aee

Remove user-specific File Path values, set associated files note to N/A, and delete unused Templates/Data sample files.

johnpierson force-pushed the DYN-9702-Add-Definitions-folder-and-Dyf branch from ede75b8 to 9fe0aee Compare July 13, 2026 16:43

jasonstratton approved these changes Jul 13, 2026

View reviewed changes

jasonstratton merged commit ef828fb into DynamoDS:master Jul 13, 2026
28 of 30 checks passed

jasonstratton mentioned this pull request Jul 15, 2026

DYN-9702: Log when shared definitions folder is missing #17221

Closed

3 tasks

RobertGlobant20 mentioned this pull request Jul 15, 2026

DYN-9702: Fix flaky PackageLoaderTests broken by shipped definitions folder #17222

Merged

3 tasks

		var commonDefinitions = Path.Combine(pathManager.CommonDataDirectory, PathManager.DefinitionsDirectoryName);
		var expectedDefinitionDirectoryCount = Directory.Exists(commonDefinitions) ? 3 : 2;

Uh oh!

Conversation

Chloepeg commented Jun 30, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Purpose

Declarations

Release Notes

Reviewers

FYIs

Uh oh!

github-actions Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

jasonstratton Jun 30, 2026

Choose a reason for hiding this comment

Uh oh!

Chloepeg Jul 7, 2026

Choose a reason for hiding this comment

Uh oh!

jasonstratton Jun 30, 2026

Choose a reason for hiding this comment

Uh oh!

Chloepeg Jul 7, 2026

Choose a reason for hiding this comment

Uh oh!

Chloepeg Jul 7, 2026

Choose a reason for hiding this comment

Uh oh!

jasonstratton left a comment

Choose a reason for hiding this comment

Uh oh!

jasonstratton Jun 30, 2026

Choose a reason for hiding this comment

Uh oh!

jasonstratton Jun 30, 2026

Choose a reason for hiding this comment

Uh oh!

sonarqubecloud Bot commented Jul 13, 2026

Quality Gate passed

Uh oh!

jasonstratton left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Chloepeg commented Jun 30, 2026 •

edited

Loading