ci

Documentation

Index

• Variables
• func NewLinter() api.Linter
• type CILinter
  • func (l *CILinter) LintProject(project api.Project) (api.Report, error)
  • func (l *CILinter) Name() string
  • func (l *CILinter) Rules() []*api.Rule

Variables

var RuleUseCI = api.Rule{
	Slug: "ci/use",
	Name: "Project uses Continuous Integration (CI)",
	Details: fmt.Sprintf(`This rule checks if your project is using Continuous Integration (CI).
To learn more about what CI is, does and entails, see the description of category %s

Implementing CI requires picking a CI provider that will run the automated builds and tests. 
There are many CI providers available and you will have to make your own decision on which fits you best,
but %s currently recognises four CI providers, namely:
- [Azure DevOps Pipelines](https://docs.microsoft.com/en-us/azure/devops/pipelines/?view=azure-devops)
- [GitHub Actions](https://docs.github.com/en/actions)
- [Gitlab CI](https://docs.gitlab.com/ee/ci/)
- [Travis CI](https://docs.travis-ci.com/)

Follow your CI provider's respective 'Getting Started' guide and set your project up with a pipeline to build, test and lint your project.`,
		"`ci`", "`mllint`"),
	Weight: 1,
}

Functions

func NewLinter

func NewLinter() api.Linter

Types

type CILinter

type CILinter struct{}

func (*CILinter) LintProject

func (l *CILinter) LintProject(project api.Project) (api.Report, error)

func (*CILinter) Name

func (l *CILinter) Name() string

func (*CILinter) Rules

func (l *CILinter) Rules() []*api.Rule