Remove augmentationProperties from Config type
#3075
Conversation
mbg
force-pushed
the
mbg/refactor/augmentation-properties
branch
from
fe428a8 to
e9fb72d
Compare
mbg
force-pushed
the
mbg/remove-augmentation-properties
branch
from
1ef359a to
87c5b58
Compare
There was a problem hiding this comment.
Pull Request Overview
This PR removes the augmentationProperties field from the Config type by updating sendCompletedStatusReport to use computed packs from computedConfig instead of calculating them from UserConfig and AugmentationProperties. The change simplifies the configuration interface while maintaining the same functionality.
Key changes:
- Removed
augmentationPropertiesfrom theConfigtype definition - Updated
getDefaultConfigreturn type to temporarily includeaugmentationPropertiesfor internal use - Simplified pack calculation logic in
sendCompletedStatusReportto usecomputedConfig.packsdirectly
Reviewed Changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| src/config-utils.ts | Removes augmentationProperties from Config type and updates getDefaultConfig return type |
| src/init-action.ts | Simplifies pack calculation logic to use config.computedConfig.packs directly |
| src/testing-utils.ts | Removes augmentationProperties import and removes the field from test config creation |
| src/config-utils.test.ts | Updates test to destructure augmentationProperties from getDefaultConfig result |
| src/codeql.test.ts | Updates test to pass augmentationProperties directly to generateCodeScanningConfig |
| lib/init-action.js | Generated JavaScript file (not reviewed per guidelines) |
src/config-utils.ts
Outdated
| } | ||
|
|
||
| const config = await getDefaultConfig(inputs); | ||
| const { augmentationProperties, ...config } = await getDefaultConfig(inputs); |
There was a problem hiding this comment.
Given that we only use getDefaultConfig in this function, consider having getDefaultConfig populate computedConfig directly to simplify the flow.
There was a problem hiding this comment.
I have made the UserConfig (from the inputs) an argument to getDefaultConfig (now initActionState), set it there, and generate computedConfig there. That avoids having to return augmentationProperties as well.
|
@henrymercer I refactored creating the |
This PR updates
sendCompletedStatusReportto use the computed packs fromcomputedConfigrather than computing the packs from the inputUserConfigandAugmentationPropertieslocally.As a result,
AugmentationPropertiesis no longer needed inConfigand is removed.Risk assessment
For internal use only. Please select the risk level of this change:
Merge / deployment checklist