summaryrefslogtreecommitdiffstatshomepage
path: root/doc/generate.go
diff options
context:
space:
mode:
Diffstat (limited to 'doc/generate.go')
-rw-r--r--doc/generate.go110
1 files changed, 110 insertions, 0 deletions
diff --git a/doc/generate.go b/doc/generate.go
new file mode 100644
index 00000000..0001f1a7
--- /dev/null
+++ b/doc/generate.go
@@ -0,0 +1,110 @@
+package main
+
+import (
+ "fmt"
+ "os"
+ "path/filepath"
+ "strings"
+ "sync"
+ "time"
+
+ "github.com/spf13/cobra"
+ "github.com/spf13/cobra/doc"
+
+ "github.com/git-bug/git-bug/commands"
+)
+
+// TaskError holds a given task name and the error it returned (if any)
+type TaskError struct {
+ name string
+ err error
+}
+
+func main() {
+ fmt.Println("Generating documentation...")
+
+ tasks := map[string]func(*cobra.Command) error{
+ "ManPage": genManPage,
+ "Markdown": genMarkdown,
+ }
+
+ var wg sync.WaitGroup
+ errs := make(chan TaskError, len(tasks))
+ for name, f := range tasks {
+ wg.Add(1)
+ go func(name string, f func(*cobra.Command) error) {
+ defer wg.Done()
+ root := commands.NewRootCommand()
+ err := f(root)
+ if err != nil {
+ fmt.Printf(" - %s: FATAL\n", name)
+ errs <- TaskError{name: name, err: err}
+ return
+ }
+ fmt.Printf(" - %s: ok\n", name)
+ }(name, f)
+ }
+
+ wg.Wait()
+ close(errs)
+
+ if len(errs) > 0 {
+ fmt.Println()
+ for e := range errs {
+ fmt.Printf(" Error generating %s:\n", strings.ToLower(e.name))
+ for _, line := range strings.Split(e.err.Error(), "\n") {
+ fmt.Printf(" %s\n", line)
+ }
+ fmt.Println()
+ }
+ os.Exit(1)
+ }
+}
+
+func genManPage(root *cobra.Command) error {
+ cwd, _ := os.Getwd()
+ dir := filepath.Join(cwd, "doc", "man")
+
+ // fixed date to avoid having to commit each month
+ date := time.Date(2019, 4, 1, 12, 0, 0, 0, time.UTC)
+
+ header := &doc.GenManHeader{
+ Title: "GIT-BUG",
+ Section: "1",
+ Date: &date,
+ Source: "Generated from git-bug's source code",
+ }
+
+ files, err := filepath.Glob(dir + "/*.1")
+ if err != nil {
+ return err
+ }
+ for _, f := range files {
+ if err := os.Remove(f); err != nil {
+ return err
+ }
+ }
+
+ return doc.GenManTree(root, header, dir)
+}
+
+func genMarkdown(root *cobra.Command) error {
+ cwd, _ := os.Getwd()
+ dir := filepath.Join(cwd, "doc", "md")
+
+ files, err := filepath.Glob(dir + "/*.md")
+ if err != nil {
+ return err
+ }
+ for _, f := range files {
+ if err := os.Remove(f); err != nil {
+ return err
+ }
+ }
+
+ if err := doc.GenMarkdownTree(root, dir); err != nil {
+ return err
+ }
+
+ return nil
+}