Marcos A. Lucas
5ca5c774ae
Some checks failed
Integration tests for the release process / release-simulation (push) Has been cancelled
**[PT-BR]** - Atualiza o Makefile para alterar mensagens de requisitos de Go, Git LFS e Node.js, substituindo "Forgejo" por "DATAWARE Forge". - Modifica scripts e comandos (ex.: merge de locales, ações, certificados, documentação e CLI) para refletir a nova identidade, mudando nomes e descrições de "Forgejo" para "DATAWARE Forge". - Altera mensagens de log, headers, textos de erro e avisos em vários módulos (actions, hooks, keys, doctor, web, etc.) para garantir consistência com a marca DATAWARE. - Atualiza templates e arquivos de configuração (ex.: app.example.ini, init scripts, etc.) para usar "DATAWARE Forge" em textos, placeholders e URLs. - Ajusta testes e mensagens em módulos de autenticação, webhook, indexador, banco de dados e outros, substituindo referências a "Forgejo" por "DATAWARE Forge". Estas alterações consolidam o rebranding white-label para DATAWARE Forge, mantendo a integridade do código original e preparando o sistema para uso interno e posterior distribuição. **[EN]** - Updated the Makefile to change messages regarding Go, Git LFS, and Node.js requirements, replacing "Forgejo" with "DATAWARE Forge". - Modified scripts and commands (e.g., locale merge, actions, certificate generation, documentation, and CLI) to reflect the new identity by renaming and updating descriptions from "Forgejo" to "DATAWARE Forge". - Changed log messages, headers, error texts, and warnings in various modules (actions, hooks, keys, doctor, web, etc.) to ensure consistency with the DATAWARE brand. - Updated templates and configuration files (e.g., app.example.ini, init scripts, etc.) to use "DATAWARE Forge" in texts, placeholders, and URLs. - Adjusted tests and messages in modules for authentication, webhooks, indexing, database, and others, replacing references from "Forgejo" to "DATAWARE Forge". These changes consolidate the white-label rebranding for DATAWARE Forge, preserving the original code integrity while preparing the system for internal use and future distribution. Marcos A. Lucas <mlucas@dataware.com.br>
65 lines
1.4 KiB
Go
65 lines
1.4 KiB
Go
// Copyright 2020 The Gitea Authors. All rights reserved.
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
package cmd
|
|
|
|
import (
|
|
"fmt"
|
|
"os"
|
|
"strings"
|
|
|
|
"github.com/urfave/cli/v2"
|
|
)
|
|
|
|
// CmdDocs represents the available docs sub-command.
|
|
var CmdDocs = &cli.Command{
|
|
Name: "docs",
|
|
Usage: "Output CLI documentation",
|
|
Description: "A command to output DATAWARE Forge's CLI documentation, optionally to a file.",
|
|
Action: runDocs,
|
|
Flags: []cli.Flag{
|
|
&cli.BoolFlag{
|
|
Name: "man",
|
|
Usage: "Output man pages instead",
|
|
},
|
|
&cli.StringFlag{
|
|
Name: "output",
|
|
Aliases: []string{"o"},
|
|
Usage: "Path to output to instead of stdout (will overwrite if exists)",
|
|
},
|
|
},
|
|
}
|
|
|
|
func runDocs(ctx *cli.Context) error {
|
|
docs, err := ctx.App.ToMarkdown()
|
|
if ctx.Bool("man") {
|
|
docs, err = ctx.App.ToMan()
|
|
}
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
if !ctx.Bool("man") {
|
|
// Clean up markdown. The following bug was fixed in v2, but is present in v1.
|
|
// It affects markdown output (even though the issue is referring to man pages)
|
|
// https://github.com/urfave/cli/issues/1040
|
|
firstHashtagIndex := strings.Index(docs, "#")
|
|
|
|
if firstHashtagIndex > 0 {
|
|
docs = docs[firstHashtagIndex:]
|
|
}
|
|
}
|
|
|
|
out := os.Stdout
|
|
if ctx.String("output") != "" {
|
|
fi, err := os.Create(ctx.String("output"))
|
|
if err != nil {
|
|
return err
|
|
}
|
|
defer fi.Close()
|
|
out = fi
|
|
}
|
|
|
|
_, err = fmt.Fprintln(out, docs)
|
|
return err
|
|
}
|