ffa

package

v0.0.0-...-36bbef9 Latest Latest Go to latest Published: Mar 25, 2022 License: Apache-2.0 Imports: 20 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/rodneyxr/ffatoolkit

Links

Open Source Insights

Documentation ¶

Index ¶

func CreateClient(ctx context.Context, accessToken string) *github.Client
func ExtractAllCommandsFromDockerfile(data string) ([]dockerfile.Command, error)
func ExtractRunCommandsFromDockerfile(data string) ([]dockerfile.Command, error)
func GetRepoList(jsonFilePath string) ([]string, error)
func LoadDockerfiles(ctx context.Context, client *github.Client, repoInfo *Repo)
func LoadLanguages(ctx context.Context, client *github.Client, repoInfo *Repo) error
func TranslateDockerfile(data string) ([]string, error)
func TranslateShellScript(data string) ([]string, error)
type Language
type Repo
- func LoadRepoCache(filePath string) ([]Repo, error)
- func NewRepo(ctx context.Context, client *github.Client, url string) Repo

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func CreateClient ¶

func CreateClient(ctx context.Context, accessToken string) *github.Client

CreateClient authenticates and creates a client to use

func ExtractAllCommandsFromDockerfile ¶

func ExtractAllCommandsFromDockerfile(data string) ([]dockerfile.Command, error)

ExtractAllCommandsFromDockerfile

func ExtractRunCommandsFromDockerfile ¶

func ExtractRunCommandsFromDockerfile(data string) ([]dockerfile.Command, error)

ExtractRunCommandsFromDockerfile

func GetRepoList ¶

func GetRepoList(jsonFilePath string) ([]string, error)

GetRepoList creates a list of repos from a json array file

func LoadDockerfiles ¶

func LoadDockerfiles(ctx context.Context, client *github.Client, repoInfo *Repo)

LoadDockerfiles loads all files matching dockerfile in their path

func LoadLanguages ¶

func LoadLanguages(ctx context.Context, client *github.Client, repoInfo *Repo) error

LoadLanguages loads all the languages in the repository

func TranslateDockerfile ¶

func TranslateDockerfile(data string) ([]string, error)

func TranslateShellScript ¶

func TranslateShellScript(data string) ([]string, error)

Types ¶

type Language ¶

type Language struct {
	Name       string  `json:"name"`
	Percentage float32 `json:"percentage"`
}

Language holds information about a language used by a GitHub repository

type Repo ¶

type Repo struct {
	URL         string     `json:"url"`
	Owner       string     `json:"owner"`
	Repo        string     `json:"repo"`
	Languages   []Language `json:"languages"`
	Dockerfiles []string   `json:"dockerfiles"`
	Images      []string   `json:"images"`
}

Repos holds information about a GitHub repository

func LoadRepoCache ¶

func LoadRepoCache(filePath string) ([]Repo, error)

LoadRepoCache will load a list of Repo objects from a json file.

func NewRepo ¶

func NewRepo(ctx context.Context, client *github.Client, url string) Repo

NewRepo creates the repo object given a URL

Source Files ¶

View all Source files

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