🚧Change how release note paths work

[CalvinWilkinson]

Complete The Item Below

• I have updated the title without removing the 🚧 emoji.

Description

Currently, the location of release notes is located in the Documentation folder. There is also a hard-coded release notes dir name field named ReleaseNotesDirName. The field is used to construct the dir path of where the release notes are located. This path construction depends on the documentation dir path to get access to the release notes for some of the NUKE targets.

There is also a static property of type AbsolutePath that is the directory path of where the release notes are located. Convert this property to a NUKE parameter. This is going to mean that the path could possibly not be set up in the ~.nuke/parameters.json file which means that it will be null or empty when the target is executed. So the targets that use this new NUKE param property will have to check if it is null or empty.

Create a Requires() method that can be used to check that the release notes dir path is not null or empty. This is just in case something went wrong in the path construction. Find all of the targets that use the release notes pathing and setup a requires that use the new method to check.

Convert the static prop ReleaseNotesBaseDirPath to a NUKE parameter. This will be the base path of where the preview and production releases will live.

Acceptance Criteria

• New NUKE param prop named PreviewReleaseNotesDirName created
• New NUKE param prop named ProductionReleaseNotesDirName created
• The static prop ReleaseNotesBaseDirPath is converted to a NUKE param
  • This is the location where the preview and production release note directories will reside
• PreviewReleaseNotesDirPath prop refactored to not be static and to use the ReleaseNotesBaseDirPath and PreviewReleaseNotesDirName properties to construct the path.
  • This will use the new PreviewReleaseDirName to construct the path
• ProductionReleaseNotesDirPath prop refactored to not be static and to use the ReleaseNotesBaseDirPath and ProductionReleaseNotesDirName properties to construct the path.
• Targets that require the release notes using the new Requires() methods to check for null or empty.

ToDo Items

• Change type labels added to this issue. Refer to the Change Type Labels section below.
• Priority label added to this issue. Refer to the Priority Type Labels section below.
• Issue linked to the correct project (if applicable).
• Issue linked to the correct milestone (if applicable).
• Draft pull request created and linked to this issue (only required with code changes).

Issue Dependencies

No response

Related Work

No response

Additional Information:

Change Type Labels

Change Type	Label
Bug Fixes	🐛bug
Breaking Changes	🧨breaking changes
New Feature	✨new feature
Workflow Changes	workflow
Code Doc Changes	🗒️documentation/code
Product Doc Changes	📝documentation/product

Priority Type Labels

Priority Type	Label
Low Priority	low priority
Medium Priority	medium priority
High Priority	high priority

Code of Conduct

• I agree to follow this project's Code of Conduct.

[CalvinWilkinson]

Did not implement the AC item below.

• Targets that require the release notes using the new Requires() methods to check for null or empty.

Reason: After implementing the functionality for the release notes paths, the default values will never have these NUKE params as empty or null. They all have default values so checking if they are null or empty is not necessary.