Feature implementation from commits 984acef..c91d1b4 #3
Conversation
Signed-off-by: zhzhuang-zju <m17799853869@163.com>
add gen-resourcesdocs to generate API docs
Signed-off-by: RainbowMango <qdurenhongcai@gmail.com>
…en_cluster_modes Explain the difference between Push and Pull mode in details
Signed-off-by: Arhell <arhell333@gmail.com>
update semi-ui
Signed-off-by: zhzhuang-zju <m17799853869@163.com>
improve document-releasing process
Signed-off-by: zhzhuang-zju <m17799853869@163.com>
Signed-off-by: 宋阳 <songyang2@xiaohongshu.com>
Add rednote to adopters
update install-binary.md to adjust the installation order
Signed-off-by: changzhen <changzhen5@huawei.com>
…or-components Add binding address configuration for security considerations
Signed-off-by: changzhen <changzhen5@huawei.com>
Signed-off-by: Arhell <arhell333@gmail.com>
update semi-ui to 2.77.1
Signed-off-by: Arhell <arhell333@gmail.com>
update semi-ui to 2.78.0
Signed-off-by: zhzhuang-zju <m17799853869@163.com>
add karmadactl operation scope docs
Signed-off-by: changzhen <changzhen5@huawei.com>
add more description for op/cop resourceSelectors
…cations Add secure coding specifications
Signed-off-by: wei-chenglai <qazwsx0939059006@gmail.com>
Fix syntax for referencing POD_IP
Signed-off-by: yibing <yibing@dewu.com>
Add dewu to adopters
Signed-off-by: chaosi-zju <chaosi@zju.edu.cn>
add new supporters
![codeowlai[bot]](https://avatars.githubusercontent.com/in/1259765?s=60&v=4){kind=small}
|
|
||
| configDir := cmd.Flag(configDirOption).Value.String() | ||
| toc, err := config.LoadTOC(path.Join(configDir, "toc.yaml")) | ||
| err = toc.PopulateAssociates(spec) |
There was a problem hiding this comment.
🐛 Correctness Issue
Nil pointer dereference risk.
The code doesn't check the error from LoadTOC before using the toc object, which would cause a runtime panic if toc is nil.
Current Code (Diff):
- err = toc.PopulateAssociates(spec)
+ if err != nil {
+ return nil, err
+ }
+ err = toc.PopulateAssociates(spec)📝 Committable suggestion
‼️ IMPORTANT
Trust, but verify! 🕵️ Please review this suggestion with the care of a code archaeologist - check that it perfectly replaces the highlighted code, preserves all lines, maintains proper indentation, and won't break anything in production. Your future self will thank you! 🚀
| err = toc.PopulateAssociates(spec) | |
| if err != nil { | |
| return nil, err | |
| } | |
| err = toc.PopulateAssociates(spec) |
| RunE: func(cmd *cobra.Command, args []string) error { | ||
| toc, err := prepareTOC(cmd) | ||
| if err != nil { | ||
| return fmt.Errorf("Unable to load specs and/or toc config: %v", err) |
There was a problem hiding this comment.
🐛 Correctness Issue
Error Chain Breaking.
The error is not properly wrapped with %w which breaks the error chain and loses context information for debugging.
Current Code (Diff):
- return fmt.Errorf("Unable to load specs and/or toc config: %v", err)
+ return fmt.Errorf("Unable to load specs and/or toc config: %w", err)📝 Committable suggestion
‼️ IMPORTANT
Trust, but verify! 🕵️ Please review this suggestion with the care of a code archaeologist - check that it perfectly replaces the highlighted code, preserves all lines, maintains proper indentation, and won't break anything in production. Your future self will thank you! 🚀
| return fmt.Errorf("Unable to load specs and/or toc config: %v", err) | |
| return fmt.Errorf("Unable to load specs and/or toc config: %w", err) |
| newSection = NewSection(o.Name, main, o.Group, o.Version) | ||
| } else { | ||
| if main = thespec.GetDefinition(o.Key); main == nil { | ||
| return fmt.Errorf("Resource %s/%s/%s not found in spec", o.Group, o.Version.String(), kubernetes.APIKind(o.Name)) |
There was a problem hiding this comment.
🐛 Correctness Issue
Incorrect error message format for definition lookup.
The error message incorrectly references Group/Version/Kind format when o.Key is used, which will produce misleading error messages during troubleshooting.
Current Code (Diff):
- return fmt.Errorf("Resource %s/%s/%s not found in spec", o.Group, o.Version.String(), kubernetes.APIKind(o.Name))
+ return fmt.Errorf("Definition %s not found in spec", o.Key)📝 Committable suggestion
‼️ IMPORTANT
Trust, but verify! 🕵️ Please review this suggestion with the care of a code archaeologist - check that it perfectly replaces the highlighted code, preserves all lines, maintains proper indentation, and won't break anything in production. Your future self will thank you! 🚀
| return fmt.Errorf("Resource %s/%s/%s not found in spec", o.Group, o.Version.String(), kubernetes.APIKind(o.Name)) | |
| return fmt.Errorf("Definition %s not found in spec", o.Key) |
| o.addDefinition(definition, resourceKey, part, toc, thespec) | ||
| } | ||
| // Mark the resource as documented | ||
| thespec.GetResource(*o.Group, *o.Version, kubernetes.APIKind(definition), true) |
There was a problem hiding this comment.
🐛 Correctness Issue
Ignored return value from GetResource call.
The call to GetResource ignores both return values (key and resource), which could mask errors when marking resources as documented.
Current Code (Diff):
- thespec.GetResource(*o.Group, *o.Version, kubernetes.APIKind(definition), true)
+ key, resource := thespec.GetResource(*o.Group, *o.Version, kubernetes.APIKind(definition), true)
+ if resource == nil {
+ return
+ }📝 Committable suggestion
‼️ IMPORTANT
Trust, but verify! 🕵️ Please review this suggestion with the care of a code archaeologist - check that it perfectly replaces the highlighted code, preserves all lines, maintains proper indentation, and won't break anything in production. Your future self will thank you! 🚀
| thespec.GetResource(*o.Group, *o.Version, kubernetes.APIKind(definition), true) | |
| key, resource := thespec.GetResource(*o.Group, *o.Version, kubernetes.APIKind(definition), true) | |
| if resource == nil { | |
| return | |
| } |
| func (o *Chapter) searchDefinitionsFromDefinition(suffixes []string, part *Part, toc *TOC, thespec *kubernetes.Spec) { | ||
| for _, suffix := range suffixes { | ||
| resourceName := o.Name + suffix | ||
| resourceKey := kubernetes.Key(o.Key.String() + suffix) |
There was a problem hiding this comment.
🐛 Correctness Issue
Missing separator in key concatenation.
Direct string concatenation for resourceKey may produce invalid keys since o.Key.String() + suffix doesn't include a separator.
Current Code (Diff):
- resourceKey := kubernetes.Key(o.Key.String() + suffix)
+ resourceKey := kubernetes.Key(o.Key.String() + "." + suffix)📝 Committable suggestion
‼️ IMPORTANT
Trust, but verify! 🕵️ Please review this suggestion with the care of a code archaeologist - check that it perfectly replaces the highlighted code, preserves all lines, maintains proper indentation, and won't break anything in production. Your future self will thank you! 🚀
| resourceKey := kubernetes.Key(o.Key.String() + suffix) | |
| resourceKey := kubernetes.Key(o.Key.String() + "." + suffix) |
| return err | ||
| } | ||
|
|
||
| outputChapter, err := outputPart.AddChapter(i, "Common Parameters", "", nil, "", "") |
There was a problem hiding this comment.
🐛 Correctness Issue
Missing error check after AddChapter call.
The code doesn't check the error from AddChapter before using outputChapter, which could cause a nil pointer dereference and application crash.
Current Code (Diff):
- outputChapter, err := outputPart.AddChapter(i, "Common Parameters", "", nil, "", "")
+ outputChapter, err := outputPart.AddChapter(i, "Common Parameters", "", nil, "", "")
+ if err != nil {
+ return err
+ }📝 Committable suggestion
‼️ IMPORTANT
Trust, but verify! 🕵️ Please review this suggestion with the care of a code archaeologist - check that it perfectly replaces the highlighted code, preserves all lines, maintains proper indentation, and won't break anything in production. Your future self will thank you! 🚀
| outputChapter, err := outputPart.AddChapter(i, "Common Parameters", "", nil, "", "") | |
| outputChapter, err := outputPart.AddChapter(i, "Common Parameters", "", nil, "", "") | |
| if err != nil { | |
| return err | |
| } |
| if err != nil { | ||
| return err | ||
| } | ||
| err = outputSection.AddContent(kubernetes.ResourcesDescriptions[param][0].Description) |
There was a problem hiding this comment.
🐛 Correctness Issue
Unchecked error from AddContent.
The error returned by outputSection.AddContent is not checked, which could lead to undetected failures and unexpected behavior.
Current Code (Diff):
- err = outputSection.AddContent(kubernetes.ResourcesDescriptions[param][0].Description)
+ err = outputSection.AddContent(kubernetes.ResourcesDescriptions[param][0].Description)
+ if err != nil {
+ return err
+ }📝 Committable suggestion
‼️ IMPORTANT
Trust, but verify! 🕵️ Please review this suggestion with the care of a code archaeologist - check that it perfectly replaces the highlighted code, preserves all lines, maintains proper indentation, and won't break anything in production. Your future self will thank you! 🚀
| err = outputSection.AddContent(kubernetes.ResourcesDescriptions[param][0].Description) | |
| err = outputSection.AddContent(kubernetes.ResourcesDescriptions[param][0].Description) | |
| if err != nil { | |
| return err | |
| } |
|
|
||
| // Equals returns true if 'o' and 'p' represent the same version | ||
| func (o *APIVersion) Equals(p *APIVersion) bool { | ||
| return o.String() == p.String() |
There was a problem hiding this comment.
🐛 Correctness Issue
Nil pointer dereference in Equals method.
The Equals method doesn't check if parameter 'p' is nil before using it, which could cause a panic at runtime.
Current Code (Diff):
- return o.String() == p.String()
+ if p == nil {
+ return false
+ }
+ return o.String() == p.String()📝 Committable suggestion
‼️ IMPORTANT
Trust, but verify! 🕵️ Please review this suggestion with the care of a code archaeologist - check that it perfectly replaces the highlighted code, preserves all lines, maintains proper indentation, and won't break anything in production. Your future self will thank you! 🚀
| return o.String() == p.String() | |
| if p == nil { | |
| return false | |
| } | |
| return o.String() == p.String() |
|
|
||
| // Replaces returns true if 'o' version replaces 'p' version | ||
| func (o *APIVersion) Replaces(p *APIVersion) bool { | ||
| return o.Version == p.Version && p.LessThan(o) |
There was a problem hiding this comment.
🐛 Correctness Issue
Nil pointer dereference in Replaces method.
The Replaces method doesn't check if parameter 'p' is nil before using it, which could cause a panic at runtime.
Current Code (Diff):
- return o.Version == p.Version && p.LessThan(o)
+ if p == nil {
+ return false
+ }
+ return o.Version == p.Version && p.LessThan(o)📝 Committable suggestion
‼️ IMPORTANT
Trust, but verify! 🕵️ Please review this suggestion with the care of a code archaeologist - check that it perfectly replaces the highlighted code, preserves all lines, maintains proper indentation, and won't break anything in production. Your future self will thank you! 🚀
| return o.Version == p.Version && p.LessThan(o) | |
| if p == nil { | |
| return false | |
| } | |
| return o.Version == p.Version && p.LessThan(o) |
| if o.Stage != p.Stage { | ||
| return o.Stage < p.Stage | ||
| } | ||
| return *o.StageVersion < *p.StageVersion |
There was a problem hiding this comment.
🐛 Correctness Issue
Potential nil pointer dereference when comparing StageVersion.
The code doesn't check if StageVersion pointers are nil before dereferencing them, which could cause a panic if comparing different stage types.
Current Code (Diff):
- return *o.StageVersion < *p.StageVersion
+ if o.StageVersion == nil || p.StageVersion == nil {
+ return o.StageVersion == nil && p.StageVersion != nil
+ }
+ return *o.StageVersion < *p.StageVersion📝 Committable suggestion
‼️ IMPORTANT
Trust, but verify! 🕵️ Please review this suggestion with the care of a code archaeologist - check that it perfectly replaces the highlighted code, preserves all lines, maintains proper indentation, and won't break anything in production. Your future self will thank you! 🚀
| return *o.StageVersion < *p.StageVersion | |
| if o.StageVersion == nil || p.StageVersion == nil { | |
| return o.StageVersion == nil && p.StageVersion != nil | |
| } | |
| return *o.StageVersion < *p.StageVersion |
|
|
||
| // AddContent adds content to a section | ||
| func (o Section) AddContent(s string) error { | ||
| i := len(o.chapter.data.Sections) |
There was a problem hiding this comment.
🐛 Correctness Issue
Potential Index Out-of-Bounds Access.
The code accesses o.chapter.data.Sections[i-1] without checking if i > 0, which could cause a panic if Sections is empty.
Current Code (Diff):
- i := len(o.chapter.data.Sections)
- o.chapter.data.Sections[i-1].Description = s
+ if len(o.chapter.data.Sections) > 0 {
+ o.chapter.data.Sections[len(o.chapter.data.Sections)-1].Description = s
+ }📝 Committable suggestion
‼️ IMPORTANT
Trust, but verify! 🕵️ Please review this suggestion with the care of a code archaeologist - check that it perfectly replaces the highlighted code, preserves all lines, maintains proper indentation, and won't break anything in production. Your future self will thank you! 🚀
| i := len(o.chapter.data.Sections) | |
| if len(o.chapter.data.Sections) > 0 { | |
| o.chapter.data.Sections[len(o.chapter.data.Sections)-1].Description = s | |
| } |
| } else { | ||
| fields = &cats[len(cats)-1].Fields | ||
| } | ||
| j := len(*fields) |
There was a problem hiding this comment.
🐛 Correctness Issue
Potential Index Out-of-Bounds Access.
The code accesses (*fields)[j-1] without checking if j > 0, which could cause a panic if fields is empty.
Current Code (Diff):
- j := len(*fields)
- (*fields)[j-1].Type = typ
- (*fields)[j-1].TypeDefinition = "*" + description + "*"
+ if len(*fields) > 0 {
+ (*fields)[len(*fields)-1].Type = typ
+ (*fields)[len(*fields)-1].TypeDefinition = "*" + description + "*"
+ }📝 Committable suggestion
‼️ IMPORTANT
Trust, but verify! 🕵️ Please review this suggestion with the care of a code archaeologist - check that it perfectly replaces the highlighted code, preserves all lines, maintains proper indentation, and won't break anything in production. Your future self will thank you! 🚀
| j := len(*fields) | |
| if len(*fields) > 0 { | |
| (*fields)[len(*fields)-1].Type = typ | |
| (*fields)[len(*fields)-1].TypeDefinition = "*" + description + "*" | |
| } |
| } | ||
|
|
||
| i = len(o.chapter.data.Sections) | ||
| ops := &o.chapter.data.Sections[i-1].Operations |
There was a problem hiding this comment.
🐛 Correctness Issue
Potential Nil Pointer Dereference.
The code dereferences ops without checking if it's nil, which could cause a panic if o.chapter.data.Sections[i-1].Operations is nil.
Current Code (Diff):
- *ops = append(*ops, OperationData{
+ if ops == nil {
+ o.chapter.data.Sections[i-1].Operations = []OperationData{}
+ ops = &o.chapter.data.Sections[i-1].Operations
+ }
+ *ops = append(*ops, OperationData{📝 Committable suggestion
‼️ IMPORTANT
Trust, but verify! 🕵️ Please review this suggestion with the care of a code archaeologist - check that it perfectly replaces the highlighted code, preserves all lines, maintains proper indentation, and won't break anything in production. Your future self will thank you! 🚀
| ops := &o.chapter.data.Sections[i-1].Operations | |
| if ops == nil { | |
| o.chapter.data.Sections[i-1].Operations = []OperationData{} | |
| ops = &o.chapter.data.Sections[i-1].Operations | |
| } | |
| *ops = append(*ops, OperationData{ |
PR Summary
Add Kubernetes Website Documentation Generator
Overview
This PR introduces a new documentation generation system for Kubernetes resources. It adds functionality to convert Kubernetes API specifications into website-ready documentation for the Karmada project.
Change Types
Affected Modules
gen-resourcesdocs/cmd/cli/helpers.gogen-resourcesdocs/cmd/cli/kwebsite.gogen-resourcesdocs/pkg/config/gen-resourcesdocs/pkg/kubernetes/gen-resourcesdocs/pkg/outputs/kwebsite//app/repositories/.../sidebars.jsNotes for Reviewers