kompat

Documentation

Overview

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

• Variables
• func IsCompatible(filePath string, appVersion string, k8sVersion string) error
• type Compatibility
• type Kompat
  • func (k Kompat) JSON() string
  • func (k Kompat) Markdown(_ ...Options) string
  • func (k Kompat) Validate() error
  • func (k Kompat) YAML() string
• type List
  • func Parse(filePaths ...string) (List, error)
  • func (k List) JSON() string
  • func (k List) Markdown(opts ...Options) string
  • func (k List) YAML() string
• type Options

Variables

var (
	DefaultFileName     = "k8s-compatibility.yaml"
	DefaultGithubBranch = "main"
)

Functions

func IsCompatible

func IsCompatible(filePath string, appVersion string, k8sVersion string) error

Types

type Compatibility

type Compatibility struct {
	AppVersion    string `yaml:"appVersion" json:"appVersion"`
	MinK8sVersion string `yaml:"minK8sVersion" json:"minK8sVersion"`
	MaxK8sVersion string `yaml:"maxK8sVersion" json:"maxK8sVersion"`
}

type Kompat

type Kompat struct {
	Name          string          `yaml:"name" json:"name"`
	Compatibility []Compatibility `yaml:"compatibility" json:"compatibility"`
}

func (Kompat) JSON

func (k Kompat) JSON() string

func (Kompat) Markdown

func (k Kompat) Markdown(_ ...Options) string

func (Kompat) Validate

func (k Kompat) Validate() error

func (Kompat) YAML

func (k Kompat) YAML() string

type List

type List []Kompat

func Parse

func Parse(filePaths ...string) (List, error)

func (List) JSON

func (k List) JSON() string

func (List) Markdown

func (k List) Markdown(opts ...Options) string

func (List) YAML

func (k List) YAML() string

type Options

type Options struct {
	LastN   int
	Version string
}