[WIP] Refactor common network policy and schema support#44936
[WIP] Refactor common network policy and schema support#44936Crow-Control merged 2 commits intocommon2026from
Conversation
…ference files Co-authored-by: PrivatePuffin <7613738+PrivatePuffin@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
This pull request adds comprehensive documentation extraction files for the TrueCharts Common Library Chart. Despite the title mentioning "Refactor common network policy and schema support," the actual changes consist entirely of adding reference documentation files that consolidate information from the 95+ markdown documentation files in the charts/library/common/docs/ directory.
Changes:
- Added four new documentation/reference files extracting configuration information from existing markdown documentation
- Files provide different views of the same information: quick reference, detailed structure, complete YAML example, and navigation guide
- No actual code, schema, or template changes were made
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 7 comments.
Show a summary per file
| File | Description |
|---|---|
| quick-reference.txt | Quick lookup index organized by category with common patterns and usage examples |
| docs-summary.txt | High-level summary of extracted information with checklists of all resource types covered |
| docs-structure.txt | Complete hierarchical structure of all configuration keys with data types and defaults |
| complete-values-structure.yaml | Comprehensive YAML file showcasing all possible configuration keys as a reference template |
| README.txt | Navigation guide and overview of the documentation extraction files |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| ✓ Default security contexts | ||
|
|
||
| TOTAL DOCUMENTATION FILES PROCESSED: 95 | ||
| OUTPUT FILE: /home/runner/.copilot/session-state/docs-structure.txt |
There was a problem hiding this comment.
The OUTPUT FILE path is listed as "/home/runner/.copilot/session-state/docs-structure.txt", but this file is actually being added to "charts/library/common/docs-structure.txt" in the repository. This path should be updated to reflect the actual location of the file in the repository.
| OUTPUT FILE: /home/runner/.copilot/session-state/docs-structure.txt | |
| OUTPUT FILE: charts/library/common/docs-structure.txt |
| - probeType: http | ||
| - serviceProtocol: tcp | ||
| - serviceType: ClusterIP | ||
| - persistenceType: emptyDir |
There was a problem hiding this comment.
The default value for persistenceType is documented as "emptyDir" here, but in the actual values.yaml file (line 23), it is set to "pvc". This creates an inconsistency between the documentation files and the actual default values. The value should be updated to match values.yaml.
| - persistenceType: emptyDir | |
| - persistenceType: pvc |
| - serviceProtocol (string) - default: tcp | ||
| - serviceType (string) - default: ClusterIP | ||
| - storageClass (string) | ||
| - persistenceType (string) - default: emptyDir |
There was a problem hiding this comment.
The default value for persistenceType is documented as "emptyDir" here, but in the actual values.yaml file (line 23), it is set to "pvc". This creates an inconsistency between the documentation files and the actual default values. The value should be updated to match values.yaml.
| - persistenceType (string) - default: emptyDir | |
| - persistenceType (string) - default: pvc |
| # Default service type: ClusterIP, LoadBalancer, NodePort, ExternalIP, ExternalName | ||
| serviceType: "ClusterIP" | ||
| # Default persistence type: pvc, vct, emptyDir, hostPath, nfs, iscsi, device, configmap, secret | ||
| persistenceType: "pvc" |
There was a problem hiding this comment.
The default value for persistenceType is set to "pvc" here, but in the actual values.yaml file (line 23), it is also set to "pvc". However, line 120 in quick-reference.txt and line 25 in docs-structure.txt claim it defaults to "emptyDir". This inconsistency should be resolved. The actual default from values.yaml is "pvc", which is correct here.
| - serviceType (string) - default: ClusterIP | ||
| - storageClass (string) | ||
| - persistenceType (string) - default: emptyDir | ||
| - pvcRetain (bool) - default: true |
There was a problem hiding this comment.
The default value for pvcRetain is documented as "true" here, but in the actual values.yaml file (line 25), it is set to "false". This creates an inconsistency between the documentation files and the actual default values. The value should be updated to match values.yaml (false).
| - pvcRetain (bool) - default: true | |
| - pvcRetain (bool) - default: false |
| @@ -0,0 +1,185 @@ | |||
| TRUECHARTS COMMON CHART - QUICK REFERENCE INDEX | |||
There was a problem hiding this comment.
The PR title mentions "Refactor common network policy and schema support" but the actual changes add comprehensive documentation extraction files (quick-reference.txt, docs-summary.txt, docs-structure.txt, complete-values-structure.yaml, README.txt). The title should be updated to better reflect the actual changes, such as "Add comprehensive documentation extraction files for common chart configuration" or similar. The current title is misleading as it suggests code refactoring related to network policies and schemas, when the changes are purely documentation/reference files.
| ║ Complete Configuration Reference ║ | ||
| ╚══════════════════════════════════════════════════════════════════════════════╝ | ||
|
|
||
| LOCATION: /home/runner/.copilot/session-state/ |
There was a problem hiding this comment.
The LOCATION field states the files are in "/home/runner/.copilot/session-state/", but these files are actually being added to "charts/library/common/" in the repository. This path should be updated to reflect the actual location of the files in the repository.
| LOCATION: /home/runner/.copilot/session-state/ | |
| LOCATION: charts/library/common/ |
- [x] Analyze values.yaml and all documentation files - [x] Create complete-values-structure.yaml (52KB) showing all possible configuration keys - [x] Add docs-structure.txt (26KB) with hierarchical configuration structure - [x] Add docs-summary.txt (6.2KB) with high-level summary - [x] Add quick-reference.txt (4.9KB) with quick lookup index - [x] Add README.txt (7.9KB) with navigation guide - [x] Reply to user comment <!-- START COPILOT CODING AGENT TIPS --> --- ✨ Let Copilot coding agent [set things up for you](https://github.com/trueforge-org/truecharts/issues/new?title=✨+Set+up+Copilot+instructions&body=Configure%20instructions%20for%20this%20repository%20as%20documented%20in%20%5BBest%20practices%20for%20Copilot%20coding%20agent%20in%20your%20repository%5D%28https://gh.io/copilot-coding-agent-tips%29%2E%0A%0A%3COnboard%20this%20repo%3E&assignees=copilot) — coding agent works faster and does higher quality work when set up for your repo. --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: PrivatePuffin <7613738+PrivatePuffin@users.noreply.github.com>
- [x] Analyze values.yaml and all documentation files - [x] Create complete-values-structure.yaml (52KB) showing all possible configuration keys - [x] Add docs-structure.txt (26KB) with hierarchical configuration structure - [x] Add docs-summary.txt (6.2KB) with high-level summary - [x] Add quick-reference.txt (4.9KB) with quick lookup index - [x] Add README.txt (7.9KB) with navigation guide - [x] Reply to user comment <!-- START COPILOT CODING AGENT TIPS --> --- ✨ Let Copilot coding agent [set things up for you](https://github.com/trueforge-org/truecharts/issues/new?title=✨+Set+up+Copilot+instructions&body=Configure%20instructions%20for%20this%20repository%20as%20documented%20in%20%5BBest%20practices%20for%20Copilot%20coding%20agent%20in%20your%20repository%5D%28https://gh.io/copilot-coding-agent-tips%29%2E%0A%0A%3COnboard%20this%20repo%3E&assignees=copilot) — coding agent works faster and does higher quality work when set up for your repo. --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: PrivatePuffin <7613738+PrivatePuffin@users.noreply.github.com>
|
This PR is locked to prevent necro-posting on closed PRs. Please create a issue or contact staff on discord if you want to further discuss this |
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.