The highest tagged major version is v3.

cmd

package

v1.7.4 Latest Latest Go to latest Published: Jan 22, 2023 License: Apache-2.0 Imports: 10 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/tj-actions/auto-doc

Links

Open Source Insights

Documentation ¶

Overview ¶

Package cmd provides a cli script that parses the github action.yml file and outputs a markdown table to a specified path.

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

http://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.

Index ¶

func Execute()
func RootCmdFlags(cmd *cobra.Command)
func RootCmdRunE(cmd *cobra.Command, args []string) error
type Action
type Input
type Output

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Execute ¶

func Execute()

Execute adds all child commands to the root command and sets flags appropriately. This is called by main.main(). It only needs to happen once to the rootCmd.

func RootCmdFlags ¶ added in v1.3.0

func RootCmdFlags(cmd *cobra.Command)

RootCmdFlags adds the flags to the root command.

func RootCmdRunE ¶ added in v1.3.0

func RootCmdRunE(cmd *cobra.Command, args []string) error

RootCmdRunE runs the root commands RunE function and handles invalid options and prints the help message if the command is called with no arguments.

Types ¶

type Action ¶

type Action struct {
	Inputs  map[string]Input  `yaml:"inputs,omitempty"`
	Outputs map[string]Output `yaml:"outputs,omitempty"`
}

Action represents the action.yml

type Input ¶

type Input struct {
	Description string `yaml:"description"`
	Required    bool   `yaml:"required"`
	Default     string `yaml:"default,omitempty"`
}

Input represents the input of the action.yml

type Output ¶

type Output struct {
	Description string `yaml:"description"`
	Value       string `yaml:"default,omitempty"`
}

Output represents the output of the action.yml

Source Files ¶

View all Source files

root.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL