Skip to content

fix: remove porch references from kpt docs (#4288)#4453

Open
NETIZEN-11 wants to merge 14 commits intokptdev:mainfrom
NETIZEN-11:fix/remove-porch-refs-4288
Open

fix: remove porch references from kpt docs (#4288)#4453
NETIZEN-11 wants to merge 14 commits intokptdev:mainfrom
NETIZEN-11:fix/remove-porch-refs-4288

Conversation

@NETIZEN-11
Copy link
Copy Markdown

Fixes #4288

Summary

This PR removes outdated references to "porch" from the kpt documentation and aligns the content with the expected behavior of keeping only a minimal high-level reference.

Changes

  • docs/ROADMAP.md

    • Replaced detailed description ("Porch is the recommended approach") with a concise high-level reference.
    • Redirected users to Nephio documentation for porch-related details.
  • documentation/content/en/faq.md

    • Fixed broken [package orchestration] link that pointed to a non-existent file.
    • Updated link to point to Nephio documentation: https://docs.nephio.org/docs/porch/
    • Removed unused reference definition block.
  • documentation/static/images/package-orchestration.svg

    • Removed unused/orphaned porch-related image asset.

Testing

  • No functional/code changes.
  • Verified documentation builds and links manually.

Notes

All detailed porch-related explanations have been removed as per the issue requirement.
A minimal reference is retained where necessary, directing users to Nephio documentation.

Nitesh and others added 13 commits March 18, 2026 00:44
…nctions

- Upgrade sigs.k8s.io/kustomize/api from v0.20.1 to v0.21.0
- Upgrade sigs.k8s.io/kustomize/kyaml from v0.20.1 to v0.21.0
- Upgrade k8s.io/api from v0.34.1 to v0.35.0
- Upgrade k8s.io/apimachinery from v0.34.1 to v0.35.0
- Upgrade k8s.io/kubectl from v0.34.1 to v0.35.0
- Upgrade github.com/kptdev/krm-functions-catalog/functions/go/apply-setters from v0.2.2 to v0.2.4
- Update catalog function registry to reference new apply-setters version
- Run go mod tidy to resolve transitive dependencies

Resolves GitHub Issue kptdev#4406

All catalog functions remain compatible with new APIs - zero breaking changes encountered.
Zero compilation errors and zero failing tests across repository.
…nctions

- Upgrade sigs.k8s.io/kustomize/api from v0.20.1 to v0.21.0
- Upgrade sigs.k8s.io/kustomize/kyaml from v0.20.1 to v0.21.0
- Upgrade k8s.io/api from v0.34.1 to v0.35.0
- Upgrade k8s.io/apimachinery from v0.34.1 to v0.35.0
- Upgrade k8s.io/kubectl from v0.34.1 to v0.35.0
- Upgrade github.com/kptdev/krm-functions-catalog/functions/go/apply-setters from v0.2.2 to v0.2.4
- Update catalog function registry to reference new apply-setters version
- Run go mod tidy to resolve transitive dependencies

Resolves GitHub Issue kptdev#4406

All catalog functions remain compatible with new APIs - zero breaking changes encountered.
Zero compilation errors and zero failing tests across repository.

Signed-off-by: NETIZEN-11 <nitesh@example.com>
- Add new RenderStatus and PipelineStepResult structs as per GitHub issue kptdev#4390
- Clearly separate mutation pipeline steps from validation steps
- Capture execution failures (network errors, missing images, command failures)
- Record stderr and exit codes for each pipeline step
- Extract and categorize error results from function results
- Aggregate all failures into comprehensive ErrorSummary
- Update pipeline execution logic to populate detailed step results
- Maintain backward compatibility with existing Rendered conditions
- Add comprehensive unit tests for new functionality
- Fix JSON tags and serialization issues

This addresses the problems with the current schema:
- Difficult troubleshooting → Clear step-by-step execution details
- Unclear error reporting → Structured error information with aggregation
- Inability to represent execution failures → Detailed execution error capture
- Confusing result structure → Clean separation of mutation/validation steps
…ng issues

- Add Windows build constraints to exclude wasmtime support
- Fix linting issues: spelling, unused parameters, unused functions
- Use errors.New for static error strings
- Remove unused setRenderCondition function

This resolves the failing CI checks for docker and podman builds.
- Update k8s.io/apiextensions-apiserver from v0.34.1 to v0.35.0
- Add yaml tags to RenderStatus, PipelineStepResult, and ResultItem structs
- Fix result classification logic to use severity instead of ExitCode
- Fix YAML test input to use proper multiline format
- Run go mod tidy to normalize dependencies

All changes maintain Go formatting and project coding style.
…subpackages

- Add isRootKptfile() helper function for robust root detection
- Enhance pkgContextResource() to generate package-context.yaml only for root packages
- Subpackages are now correctly suppressed to prevent duplicate ConfigMap creation
- Fix path normalization to handle relative paths like './Kptfile'
- Ensure only one ConfigMap 'kptfile.kpt.dev' exists in mutation pipeline

This resolves the 'ConfigMap already exists' error when rendering packages with subpackages.
- Remove 50+ lines of commented dead code
- Resolve TODO comment with proper printer implementation
- Replace hardcoded strings with constants (KptfileName, EmptyTempDirPrefix, RootPackagePath)
- Split monolithic function into 7 focused functions
- Add comprehensive input validation and error handling
- Improve resource cleanup with proper defer statements
- Update copyright to 2022-2026 for modifications

Fixes kptdev#4379

Signed-off-by: NETIZEN-11 <nitesh@example.com>
…subpackages

- Add isRootKptfile() helper function for robust root detection
- Enhance pkgContextResource() to generate package-context.yaml only for root packages
- Subpackages are now correctly suppressed to prevent duplicate ConfigMap creation
- Fix path normalization to handle relative paths like './Kptfile'
- Ensure only one ConfigMap 'kptfile.kpt.dev' exists in mutation pipeline

This resolves 'ConfigMap already exists' error when rendering packages with subpackages.

Signed-off-by: NETIZEN-11 <nitesh@example.com>
…ML serialization, result classification, and test YAML parsing

Fixes applied:
1. Kubernetes Dependency Alignment - Updated all k8s.io modules to v0.35.0
2. YAML Serialization Fix - Added yaml tags alongside json tags in RenderStatus, PipelineStepResult, ResultItem
3. Correct Result Classification Logic - Updated extractResultsFromFnResults to use severity instead of ExitCode
4. Test YAML Parsing Fix - Fixed yaml.MustParse test input with proper multiline YAML

Result: Eliminates dependency/API mismatch, ensures correct YAML output, fixes logic bug in result classification, makes tests valid and reliable

Closes: kptdev#4432

Signed-off-by: NETIZEN-11 <niteshkumar121411@gmail.com>
- Added Signed-off-by line to comply with Developer Certificate of Origin (DCO)
- Ensured commit author email matches GitHub account

Signed-off-by: NETIZEN-11 <niteshkumar121411@gmail.com>
…ML serialization, result classification, and test YAML parsing

Fixes applied:
1. Kubernetes Dependency Alignment - Updated all k8s.io modules to v0.35.0
2. YAML Serialization Fix - Added yaml tags alongside json tags in RenderStatus, PipelineStepResult, ResultItem
3. Correct Result Classification Logic - Updated extractResultsFromFnResults to use severity instead of ExitCode
4. Test YAML Parsing Fix - Fixed yaml.MustParse test input with proper multiline YAML

Result: Eliminates dependency/API mismatch, ensures correct YAML output, fixes logic bug in result classification, makes tests valid and reliable

Closes: kptdev#4432

Signed-off-by: NETIZEN-11 <niteshkumar121411@gmail.com>
- Update go.mod: k8s.io/apiextensions-apiserver already at v0.35.0
- Add YAML tags to RenderStatus, PipelineStepResult, ResultItem structs
- Fix result classification logic to use severity instead of ExitCode
- Fix test YAML parsing with proper multiline format
- Add strings import for severity normalization

Signed-off-by: NETIZEN-11 <niteshkumar121411@gmail.com>
Copilot AI review requested due to automatic review settings March 29, 2026 15:24
@netlify
Copy link
Copy Markdown

netlify bot commented Mar 29, 2026

Deploy Preview for kptdocs ready!

Name Link
🔨 Latest commit b410cb6
🔍 Latest deploy log https://app.netlify.com/projects/kptdocs/deploys/69c9453e02d5e700087d94f2
😎 Deploy Preview https://deploy-preview-4453--kptdocs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@dosubot dosubot bot added size:XL This PR changes 500-999 lines, ignoring generated files. documentation Improvements or additions to documentation go Pull requests that update Go code labels Mar 29, 2026
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

@NETIZEN-11 NETIZEN-11 force-pushed the fix/remove-porch-refs-4288 branch from d8eaa63 to b9024f6 Compare March 29, 2026 15:26
- Replace detailed porch description in ROADMAP.md with a single
  high-level reference pointing to Nephio documentation
- Fix broken link in faq.md that pointed to non-existent design doc
  docs/design-docs/07-package-orchestration.md; now points to Nephio
- Remove unused [package orchestration] reference definition from faq.md
- Delete orphaned package-orchestration.svg image asset

Signed-off-by: NETIZEN-11 <kumarnitesh121411@gmail.com>
@NETIZEN-11 NETIZEN-11 force-pushed the fix/remove-porch-refs-4288 branch from b9024f6 to b410cb6 Compare March 29, 2026 15:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation go Pull requests that update Go code size:XL This PR changes 500-999 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

BUG: documentation still refers to porch in a number of places

2 participants