-
Notifications
You must be signed in to change notification settings - Fork 0
Implement platform-product config and governance tagging defaults #7
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
tukue
merged 5 commits into
main
from
codex/implement-best-practices-for-platform-as-product
Apr 13, 2026
Merged
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
0eea53b
Implement platform-product config and governance tagging defaults
tukue 5f1c4dc
Fail fast when platform environment is not explicitly set
tukue ddcc9a8
Set explicit default platformEnv context for synth
tukue 7c926c9
Require explicit platformEnv by removing implicit default
tukue 18c681f
Make npm synth provide explicit default platformEnv
tukue File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,57 @@ | ||
| export type PlatformEnvironment = 'dev' | 'stage' | 'prod'; | ||
|
|
||
| export interface PlatformConfig { | ||
| readonly environment: PlatformEnvironment; | ||
| readonly owner: string; | ||
| readonly costCenter: string; | ||
| readonly dataClassification: 'public' | 'internal' | 'confidential' | 'restricted'; | ||
| readonly project: string; | ||
| } | ||
|
|
||
| const CONFIG_BY_ENV: Record<PlatformEnvironment, Omit<PlatformConfig, 'environment'>> = { | ||
| dev: { | ||
| owner: 'platform-engineering', | ||
| costCenter: 'ENG-PLATFORM', | ||
| dataClassification: 'internal', | ||
| project: 'DemoAPI', | ||
| }, | ||
| stage: { | ||
| owner: 'platform-engineering', | ||
| costCenter: 'ENG-PLATFORM', | ||
| dataClassification: 'confidential', | ||
| project: 'DemoAPI', | ||
| }, | ||
| prod: { | ||
| owner: 'platform-engineering', | ||
| costCenter: 'ENG-PLATFORM', | ||
| dataClassification: 'confidential', | ||
| project: 'DemoAPI', | ||
| }, | ||
| }; | ||
|
|
||
| export const resolvePlatformEnvironment = (value?: string): PlatformEnvironment => { | ||
| const normalized = value?.trim().toLowerCase(); | ||
|
|
||
| if (!normalized) { | ||
| throw new Error( | ||
| 'Platform environment must be explicitly specified via platformEnv context or PLATFORM_ENV. Allowed values: dev, stage, prod.', | ||
| ); | ||
| } | ||
|
|
||
| if (normalized === 'dev' || normalized === 'stage' || normalized === 'prod') { | ||
| return normalized; | ||
| } | ||
|
|
||
| throw new Error( | ||
| `Invalid platform environment \"${value}\". Allowed values: dev, stage, prod.`, | ||
| ); | ||
| }; | ||
|
|
||
| export const loadPlatformConfig = (environmentValue?: string): PlatformConfig => { | ||
| const environment = resolvePlatformEnvironment(environmentValue); | ||
|
|
||
| return { | ||
| environment, | ||
| ...CONFIG_BY_ENV[environment], | ||
| }; | ||
| }; | ||
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
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🛑 Logic Error: Silently defaulting to 'dev' when no environment is specified creates a critical risk where production deployments could accidentally use development configuration if
PLATFORM_ENVorplatformEnvcontext are not set. This violates the principle of failing safely and could lead to incorrect infrastructure provisioning. Throw an error instead to force explicit environment selection.