Documentation ¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
View Source
var ContributorsFilePath = "CONTRIBUTORS"
ContributorsFilePath identifies the contributors path in root dir.
View Source
var ErrNothingChanged = fmt.Errorf("nothing to commit")
ErrNothingChanged is used when git commit has nothing to commit.
Functions ¶
func GenContributorsList ¶
GenContributorsList generates the contributors list via git command.
func GetContributorsFileHeader ¶
func GetContributorsFileHeader() string
GetContributorsFileHeader will return a common header for file CONTRIBUTOR, and show how to get this file.
Types ¶
type Generator ¶
type Generator struct { // RootDir specifies repo's rootdir which is to generated docs. RootDir string // SwaggerPath specifies that which dir is the swagger.yml file in root dir. // this is a relative path to root dir. SwaggerPath string // APIDocPath specifies where to generate the swagger tool. // this is a relative path to root dir. APIDocPath string // GenerationHour represents doc generation time every day. GenerationHour int // CliDocGeneratorCmd represents the command users input to generate cli // related document. CliDocGeneratorCmd string // contains filtered or unexported fields }
Generator is a processor that periodically auto generated cli and api docs for github repo.
Click to show internal directories.
Click to hide internal directories.