Update samples for "vela show xxx --web" #1616

zzxwill · 2021-05-07T08:24:22Z

Also stop generating components/traits docs under
docs/en/end-user and remove the command from Makefile

codecov · 2021-05-07T08:42:10Z

Codecov Report

Merging #1616 (cce3e84) into master (1660930) will increase coverage by 0.15%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master    #1616      +/-   ##
==========================================
+ Coverage   62.00%   62.15%   +0.15%     
==========================================
  Files         120      120              
  Lines       11899    11900       +1     
==========================================
+ Hits         7378     7397      +19     
+ Misses       3761     3734      -27     
- Partials      760      769       +9

Flag	Coverage Δ
e2etests	`43.72% <ø> (+0.03%)`	⬆️
unittests	`58.02% <ø> (+0.10%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
pkg/dsl/model/instance.go	`75.67% <0.00%> (-5.41%)`	⬇️
pkg/appfile/appfile.go	`76.09% <0.00%> (-1.60%)`	⬇️
...dev/v1alpha2/application/application_controller.go	`79.13% <0.00%> (-1.44%)`	⬇️
...ev/v1alpha2/core/scopes/healthscope/healthscope.go	`90.40% <0.00%> (-1.02%)`	⬇️
pkg/dsl/definition/template.go	`48.38% <0.00%> (-0.93%)`	⬇️
...oam.dev/v1alpha2/applicationconfiguration/apply.go	`67.43% <0.00%> (-0.92%)`	⬇️
...troller/core.oam.dev/v1alpha2/application/apply.go	`72.86% <0.00%> (-0.49%)`	⬇️
...a2/applicationrollout/applicationrollout_helper.go	`65.44% <0.00%> (ø)`
...pplicationrollout/applicationrollout_controller.go	`81.18% <0.00%> (+1.07%)`	⬆️
...g/controller/core.oam.dev/v1alpha2/core/revison.go	`72.97% <0.00%> (+1.80%)`	⬆️
... and 8 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 1660930...cce3e84. Read the comment docs.

wonderflow · 2021-05-07T09:26:28Z

references/plugins/references.go

-		specification := fmt.Sprintf("\n\n## Specification\n\n%s\n\n%s", specificationIntro, specificationContent)
+		title := fmt.Sprintf(`---
+title:  %s
+---`, capNameInTitle)


why do we change the style?

To make it consistent with the reference doc in kubevela.io https://kubevela.io/docs/developers/references/component-types/webservice.

Will it still work in vela show --web？

This change should be reverted, the new title style is not good if I didn't upgrade the Markdown hosting server. Thanks.

references/plugins/references.go

wonderflow · 2021-05-07T09:34:56Z

please create a new issue about "generate the sample automatically （low priority）" if you want to close #1602

Also stop generating components/traits docs under docs/en/end-user and remove the command from Makefile Fix kubevela#1602

Co-authored-by: Jianbo Sun <wonderflow.sun@gmail.com>

- Find the capability in "vela-system" if notfound in the current ns - Don't depend on local capabilities

zzxwill · 2021-05-08T08:00:11Z

Fixed the issue of NotFound capability if the capability, like Terraform alibaba-oss, is not in "vela-system"

…/cluster.go

…s/references.go

zzxwill · 2021-05-08T10:02:54Z

In the first time, the coverage was dropped by 0.09%.
After adding one ut for a newly added function , it was dropped by 3.76%.
Now I added two more, watching the changing.

zzxwill · 2021-05-08T10:54:06Z

In the first time, the coverage was dropped by 0.09%.
After adding one ut for a newly added function , it was dropped by 3.76%.
Now I added two more, watching the changing.

Now it dropped more by 3.86%.

wonderflow · 2021-05-08T12:50:36Z

references/plugins/cluster.go

@@ -57,16 +57,46 @@ func GetCapabilitiesFromCluster(ctx context.Context, namespace string, c common.
 	return workloads, nil
 }

+// GetNamespacedCapabilitiesFromCluster will get capability from K8s cluster in the specified namespace and default namespace
+// If the definition could be found from `namespace`, try to find in namespace `types.DefaultKubeVelaNS`


good job！

wonderflow · 2021-05-08T12:57:08Z

references/plugins/cluster_test.go

-	"github.com/google/go-cmp/cmp"
+	"io/ioutil"
+	corev1 "k8s.io/api/core/v1"
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"


please format it.

// go inner packages // third party packages // project pakcages

Done. Thanks.

wonderflow

LGTM after nit

* Update samples for "vela show xxx --web" Also stop generating components/traits docs under docs/en/end-user and remove the command from Makefile Fix kubevela#1602 * fix doc build issue * Update references/plugins/references.go Co-authored-by: Jianbo Sun <wonderflow.sun@gmail.com> * Enhance --web feature for "vela show" - Find the capability in "vela-system" if notfound in the current ns - Don't depend on local capabilities * add ut for GetCapabilityByName in references/plugins/cluster.go * add ut for GetNamespacedCapabilitiesFromCluster in references/plugins/cluster.go * add ut for GenerateTerraformCapabilityProperties in references/plugins/references.go * fix import issue Co-authored-by: Jianbo Sun <wonderflow.sun@gmail.com>

wonderflow reviewed May 7, 2021

View reviewed changes

references/plugins/references.go Show resolved Hide resolved

zzxwill and others added 3 commits May 7, 2021 23:25

Update samples for "vela show xxx --web"

49eefa0

Also stop generating components/traits docs under docs/en/end-user and remove the command from Makefile Fix kubevela#1602

fix doc build issue

8e44355

Update references/plugins/references.go

96a1372

Co-authored-by: Jianbo Sun <wonderflow.sun@gmail.com>

zzxwill force-pushed the vela-show-web branch from 2da89e8 to 96a1372 Compare May 7, 2021 15:26

zzxwill changed the title ~~Update samples for "vela show xxx --web"~~ [WIP] Update samples for "vela show xxx --web" May 8, 2021

Enhance --web feature for "vela show"

4101600

- Find the capability in "vela-system" if notfound in the current ns - Don't depend on local capabilities

zzxwill changed the title ~~[WIP] Update samples for "vela show xxx --web"~~ Update samples for "vela show xxx --web" May 8, 2021

zzxwill added 3 commits May 8, 2021 17:41

add ut for GetCapabilityByName in references/plugins/cluster.go

9b7e63a

add ut for GetNamespacedCapabilitiesFromCluster in references/plugins…

fe98516

…/cluster.go

add ut for GenerateTerraformCapabilityProperties in references/plugin…

d4fd8f7

…s/references.go

wonderflow reviewed May 8, 2021

View reviewed changes

wonderflow approved these changes May 8, 2021

View reviewed changes

fix import issue

cce3e84

wonderflow merged commit f137a9a into kubevela:master May 9, 2021

zzxwill deleted the vela-show-web branch May 10, 2021 02:24

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update samples for "vela show xxx --web" #1616

Update samples for "vela show xxx --web" #1616

zzxwill commented May 7, 2021

codecov bot commented May 7, 2021 •

edited

Loading

wonderflow May 7, 2021

zzxwill May 7, 2021

wonderflow May 8, 2021

zzxwill May 8, 2021

wonderflow commented May 7, 2021

zzxwill commented May 8, 2021

zzxwill commented May 8, 2021 •

edited

Loading

zzxwill commented May 8, 2021

wonderflow May 8, 2021

wonderflow May 8, 2021

zzxwill May 8, 2021

wonderflow left a comment

Update samples for "vela show xxx --web" #1616

Update samples for "vela show xxx --web" #1616

Conversation

zzxwill commented May 7, 2021

codecov bot commented May 7, 2021 • edited Loading

Codecov Report

wonderflow May 7, 2021

Choose a reason for hiding this comment

zzxwill May 7, 2021

Choose a reason for hiding this comment

wonderflow May 8, 2021

Choose a reason for hiding this comment

zzxwill May 8, 2021

Choose a reason for hiding this comment

wonderflow commented May 7, 2021

zzxwill commented May 8, 2021

zzxwill commented May 8, 2021 • edited Loading

zzxwill commented May 8, 2021

wonderflow May 8, 2021

Choose a reason for hiding this comment

wonderflow May 8, 2021

Choose a reason for hiding this comment

zzxwill May 8, 2021

Choose a reason for hiding this comment

wonderflow left a comment

Choose a reason for hiding this comment

codecov bot commented May 7, 2021 •

edited

Loading

zzxwill commented May 8, 2021 •

edited

Loading