types

Documentation

Overview

Package types contains all defined types

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.

Package types contains all defined types

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.

Package types contains all defined types

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.

Package types contains all defined types

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

• type Action
  • func (a *Action) GetData() error
  • func (a *Action) RenderOutput() error
  • func (a *Action) WriteDocumentation(inputTable, outputTable, description *strings.Builder) error
• type ActionInput
• type ActionOutput
• type CodeBlock
  • func (c *CodeBlock) GetData() error
  • func (c *CodeBlock) RenderOutput() error
• type Documentation
• type Reusable
  • func (r *Reusable) GetData() error
  • func (r *Reusable) RenderOutput() error
  • func (r *Reusable) WriteDocumentation(inputTable, outputTable, secretsTable *strings.Builder) error
• type ReusableInput
• type ReusableOutput
• type ReusableSecret

Types

type Action

type Action struct {
	InputFileName      string
	OutputFileName     string
	ColMaxWidth        string
	ColMaxWords        string
	InputColumns       []string
	OutputColumns      []string
	Inputs             map[string]ActionInput  `yaml:"inputs,omitempty"`
	Outputs            map[string]ActionOutput `yaml:"outputs,omitempty"`
	Description        string                  `yaml:"description,omitempty"`
	InputMarkdownLinks bool
}

Action represents the action.yml

func (*Action) GetData

func (a *Action) GetData() error

GetData parses the source yaml file

func (*Action) RenderOutput

func (a *Action) RenderOutput() error

RenderOutput renders the output and writes it to the given output

func (*Action) WriteDocumentation

func (a *Action) WriteDocumentation(inputTable, outputTable, description *strings.Builder) error

WriteDocumentation write the table to the output file

type ActionInput

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

ActionInput represents the input of the action.yml

type ActionOutput

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

ActionOutput represents the output of the action.yml

type CodeBlock

type CodeBlock struct {
	Repository         string
	Token              string
	UseMajorVersion    bool
	OutputColumns      []string
	InputMarkdownLinks bool
	ColMaxWidth        string
	ColMaxWords        string
	InputFileName      string
	OutputFileName     string
	Inputs             map[string]ActionInput  `yaml:"inputs,omitempty"`
	Outputs            map[string]ActionOutput `yaml:"outputs,omitempty"`
}

CodeBlock represents the action.yml outputted as a code block

func (*CodeBlock) GetData

func (c *CodeBlock) GetData() error

GetData parses the source yaml file

func (*CodeBlock) RenderOutput

func (c *CodeBlock) RenderOutput() error

RenderOutput renders the output and writes it to the given output

type Documentation

type Documentation interface {
	GetData() error
	RenderOutput() error
}

Documentation is the interface for Action, Reusable and CodeBlock

type Reusable

type Reusable struct {
	InputFileName  string
	OutputFileName string
	ColMaxWidth    string
	ColMaxWords    string
	InputColumns   []string
	OutputColumns  []string
	SecretColumns  []string
	On             struct {
		WorkflowCall struct {
			Inputs  map[string]ReusableInput  `yaml:"inputs,omitempty"`
			Secrets map[string]ReusableSecret `yaml:"secrets,omitempty"`
			Outputs map[string]ReusableOutput `yaml:"outputs,omitempty"`
		} `yaml:"workflow_call"`
	}
	InputMarkdownLinks bool
}

Reusable represents a reusable workflow

func (*Reusable) GetData

func (r *Reusable) GetData() error

GetData parses the source yaml file

func (*Reusable) RenderOutput

func (r *Reusable) RenderOutput() error

RenderOutput renders the output and writes it to the given output

func (*Reusable) WriteDocumentation

func (r *Reusable) WriteDocumentation(inputTable, outputTable, secretsTable *strings.Builder) error

WriteDocumentation write the table to the output file

type ReusableInput

type ReusableInput struct {
	Description        string `yaml:"description"`
	Required           bool   `yaml:"required"`
	Default            string `yaml:"default,omitempty"`
	Type               string `yaml:"type"`
	DeprecationMessage string `yaml:"deprecationMessage,omitempty"`
}

ReusableInput represents the input of the reusable workflow

type ReusableOutput

type ReusableOutput struct {
	Description string `yaml:"description"`
	Value       string `yaml:"value"`
}

ReusableOutput represents the output of the reusable workflow

type ReusableSecret

type ReusableSecret struct {
	Required    bool   `yaml:"required"`
	Description string `yaml:"description"`
}

ReusableSecret represents the secret of reusable workflows