(MAINT) Define build data per-project #1185
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
michaeltlombardi
force-pushed
the
maint/main/per-project-data
branch
2 times, most recently
from
0d6f9f1 to
13e2f5b
Compare
Prior to this change, any updates to project build configuration needed to land in the root `build.data.psd1` file. This made it relatively easy to forget to update the configuration when working on a specific project. This change: 1. Defines the configuration on a per-project basis in newly defined `.project.data.json` files. These files contain the build metadata for each project _except_ for the `RelativePath` field. 1. Replaces the root `build.data.psd1` file with `build.data.json` containing the same data. 1. Defines JSON Schemas to validate and provide in-editor help for modifying and creating new project data files and modifying the root build data file. 1. Updates the build helpers to work with JSON data files instead of the PSD1. 1. Provides a model to retrieve updated project data for use in the build script, even when the root build data file hasn't been updated yet. 1. Defines the helper function `Update-DscBuildData` to pull changes from the per-project data files into the root build data file. Except for using the JSON files, this change doesn't modify the build behavior. This change doesn't remove the `copy_files.txt` files, though they are now redundant with the project data files. Once we remove the old build script, the `copy_files.txt` files should also be removed.
michaeltlombardi
force-pushed
the
maint/main/per-project-data
branch
from
13e2f5b to
1b810fc
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
PR Summary
This change:
.project.data.jsonfiles. These files contain the build metadata for each project except for theRelativePathfield.build.data.psd1file withbuild.data.jsoncontaining the same data.Update-DscBuildDatato pull changes from the per-project data files into the root build data file.Except for using the JSON files, this change doesn't modify the build behavior. This change doesn't remove the
copy_files.txtfiles, though they are now redundant with the project data files. Once we remove the old build script, thecopy_files.txtfiles should also be removed.PR Context
Prior to this change, any updates to project build configuration needed to land in the root
build.data.psd1file. This made it relatively easy to forget to update the configuration when working on a specific project.