Merge pull request #9 from inteon/rename

Rename helm-docgen to helm-tool

Author: jetstack-bot

README.md

@@ -4,10 +4,10 @@ Helm Docgen generates documentation for Helm charts by reading the values.yaml f
 
 ## Usage
 
-There are two commands that can be used to generate documentation, `helm-docgen render` and `helm-docgen inject`.
+There are two commands that can be used to generate documentation, `helm-tool render` and `helm-tool inject`.
 
-- `helm-docgen render` - The render command will simply render the markdown to the stdout
-- `helm-docgen inject` - The inject command will inject the generated documentation into an existing markdown file, it will look for the `## Properties` header and inject the documentation between it and the next header. This can be useful for keeping a chart README up to date.
+- `helm-tool render` - The render command will simply render the markdown to the stdout
+- `helm-tool inject` - The inject command will inject the generated documentation into an existing markdown file, it will look for the `## Properties` header and inject the documentation between it and the next header. This can be useful for keeping a chart README up to date.
 
 ## Customising the output
 

go.mod

@@ -1,4 +1,4 @@
-module github.com/cert-manager/helm-docgen
+module github.com/cert-manager/helm-tool
 
 go 1.21
 

linter/linter.go

@@ -22,8 +22,8 @@ import (
 	"slices"
 	"strings"
 
-	"github.com/cert-manager/helm-docgen/linter/parsetemplates"
-	"github.com/cert-manager/helm-docgen/parser"
+	"github.com/cert-manager/helm-tool/linter/parsetemplates"
+	"github.com/cert-manager/helm-tool/parser"
 )
 
 func Lint(

linter/parsetemplates/templates.go

@@ -25,7 +25,7 @@ import (
 	"text/template"
 	"text/template/parse"
 
-	"github.com/cert-manager/helm-docgen/linter/parsetemplates/funcs_serdes"
+	"github.com/cert-manager/helm-tool/linter/parsetemplates/funcs_serdes"
 )
 
 func ListTemplatePaths(templatesPath string) ([]string, error) {

linter/parsetemplates/templates_test.go

@@ -22,8 +22,8 @@ import (
 	"testing"
 	"text/template"
 
-	"github.com/cert-manager/helm-docgen/linter/parsetemplates"
-	"github.com/cert-manager/helm-docgen/linter/parsetemplates/funcs_serdes"
+	"github.com/cert-manager/helm-tool/linter/parsetemplates"
+	"github.com/cert-manager/helm-tool/linter/parsetemplates/funcs_serdes"
 	"github.com/stretchr/testify/require"
 )
 

main.go

@@ -21,10 +21,10 @@ import (
 	"os"
 	"regexp"
 
-	"github.com/cert-manager/helm-docgen/linter"
-	"github.com/cert-manager/helm-docgen/parser"
-	"github.com/cert-manager/helm-docgen/render"
-	"github.com/cert-manager/helm-docgen/schema"
+	"github.com/cert-manager/helm-tool/linter"
+	"github.com/cert-manager/helm-tool/parser"
+	"github.com/cert-manager/helm-tool/render"
+	"github.com/cert-manager/helm-tool/schema"
 	"github.com/spf13/cobra"
 )
 
@@ -39,7 +39,7 @@ var (
 )
 
 var Cmd = cobra.Command{
-	Use: "helm-docgen",
+	Use: "helm-tool",
 }
 
 var Render = cobra.Command{

make/00_mod.mk

@@ -12,14 +12,14 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-repo_name := github.com/cert-manager/helm-docgen
+repo_name := github.com/cert-manager/helm-tool
 
-build_names := helm-docgen
+build_names := helm-tool
 
-go_helm-docgen_source_path := main.go
-go_helm-docgen_ldflags := -X $(repo_name)/internal/version.AppVersion=$(VERSION) -X $(repo_name)/internal/version.GitCommit=$(GITCOMMIT)
+go_helm-tool_source_path := main.go
+go_helm-tool_ldflags := -X $(repo_name)/internal/version.AppVersion=$(VERSION) -X $(repo_name)/internal/version.GitCommit=$(GITCOMMIT)
 
-oci_helm-docgen_base_image_flavor := static
-oci_helm-docgen_image_name := quay.io/jetstack/helm-docgen
-oci_helm-docgen_image_tag := $(VERSION)
-oci_helm-docgen_image_name_development := cert-manager.local/helm-docgen
+oci_helm-tool_base_image_flavor := static
+oci_helm-tool_image_name := quay.io/jetstack/helm-tool
+oci_helm-tool_image_tag := $(VERSION)
+oci_helm-tool_image_name_development := cert-manager.local/helm-tool

make/test-unit.mk

@@ -17,9 +17,11 @@
 ## @category Testing
 test-unit: | $(NEEDS_GO) $(NEEDS_GOTESTSUM) $(ARTIFACTS)
 	$(GOTESTSUM) \
+		--junitfile=$(ARTIFACTS)/junit-go-e2e.xml \
+		-- \
+		-coverprofile=$(ARTIFACTS)/filtered.cov \
 		./... \
 		-- \
-		-ldflags $(go_manager_ldflags) \
-		-coverprofile cover.out
+		-ldflags $(go_manager_ldflags)
 
 	$(GO) tool cover -html=$(ARTIFACTS)/filtered.cov -o=$(ARTIFACTS)/filtered.html

parser/comment.go

@@ -16,7 +16,7 @@ limitations under the License.
 
 package parser
 
-import "github.com/cert-manager/helm-docgen/heuristics"
+import "github.com/cert-manager/helm-tool/heuristics"
 
 type Comment struct {
 	heuristics.CommentBlock

parser/document.go

@@ -21,8 +21,8 @@ import (
 	"os"
 	"strings"
 
-	"github.com/cert-manager/helm-docgen/heuristics"
-	"github.com/cert-manager/helm-docgen/paths"
+	"github.com/cert-manager/helm-tool/heuristics"
+	"github.com/cert-manager/helm-tool/paths"
 	"gopkg.in/yaml.v3"
 )