mirror of
https://github.com/helm/chart-releaser.git
synced 2026-02-05 09:45:23 +01:00
2d923ecd8a
* add command docs Signed-off-by: cpanato <ctadeu@gmail.com> * add job to check command doc Signed-off-by: cpanato <ctadeu@gmail.com> * avoid dynamic docs and expand the path later Signed-off-by: cpanato <ctadeu@gmail.com> Signed-off-by: cpanato <ctadeu@gmail.com>
52 lines
1.2 KiB
Go
52 lines
1.2 KiB
Go
// Copyright The Helm Authors
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
//
|
|
// https://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
|
|
package cmd
|
|
|
|
import (
|
|
"fmt"
|
|
|
|
"github.com/MakeNowJust/heredoc"
|
|
"github.com/spf13/cobra"
|
|
"github.com/spf13/cobra/doc"
|
|
)
|
|
|
|
var generateDocsCmd = &cobra.Command{
|
|
Use: "doc-gen",
|
|
Short: "Generate documentation",
|
|
Long: heredoc.Doc(`
|
|
Generate documentation for all commands
|
|
to the 'docs' directory.`),
|
|
Hidden: true,
|
|
RunE: generateDocs,
|
|
}
|
|
|
|
func generateDocs(cmd *cobra.Command, args []string) error {
|
|
fmt.Println("Generating docs...")
|
|
|
|
err := doc.GenMarkdownTree(rootCmd.Root(), "doc")
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
fmt.Println("Done.")
|
|
return nil
|
|
}
|
|
|
|
func init() {
|
|
rootCmd.AddCommand(generateDocsCmd)
|
|
|
|
rootCmd.DisableAutoGenTag = true
|
|
}
|