cmd

Documentation

Overview

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

Copyright © 2021 Tonye Jack <jtonye@ymail.com>

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

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

func RootCmdFlags(cmd *cobra.Command)

RootCmdFlags adds the flags to the root command.

func RootCmdRunE

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