README
¶
Frizbee
Frizbee is a tool you may throw a tag at and it comes back with a checksum.
It's a command-line tool designed to provide checksums for GitHub Actions and container images based on tags.
It also includes a set of libraries for working with tags and checksums.
Table of Contents
Installation
To install Frizbee, you can use the following methods:
# Using Go
go get -u github.com/stacklok/frizbee
go install github.com/stacklok/frizbee
# Using Homebrew
brew install stacklok/tap/frizbee
# Using winget
winget install stacklok.frizbee
Usage
GitHub Actions
Frizbee can be used to generate checksums for GitHub Actions. This is useful for verifying that the contents of a GitHub Action have not changed.
To quickly replace the GitHub Action references for your project, you can use
the ghactions command:
frizbee ghactions -d path/to/your/repo/.github/workflows/
This will write all the replacements to the files in the directory provided.
Note that this command will only replace the uses field of the GitHub Action
references.
Note that this command supports dry-run mode, which will print the replacements to stdout instead of writing them to the files.
It also supports exiting with a non-zero exit code if any replacements are found. This is handy for CI/CD pipelines.
If you want to generate the replacement for a single GitHub Action, you can use
the ghactions one command:
frizbee ghactions one metal-toolbox/container-push/.github/workflows/container-push.yml@main
This is useful if you're developing and want to quickly test the replacement.
Container Images
Frizbee can be used to generate checksums for container images. This is useful for verifying that the contents of a container image have not changed.
To get the digest for a single image tag, you can use the containerimage one command:
frizbee containerimage one quay.io/stacklok/frizbee:latest
This will print the image refrence with the digest for the image tag provided.
Contributing
We welcome contributions to Frizbee. Please see our Contributing guide for more information.
License
Frizbee is licensed under the Apache 2.0 License.
Documentation
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package cmd provides the frizbee command line interface.
|
Package cmd provides the frizbee command line interface. |
|
containerimage
Package containerimage provides command-line utilities to work with container images.
|
Package containerimage provides command-line utilities to work with container images. |
|
dockercompose
Package dockercompose provides command-line utilities to work with container images.
|
Package dockercompose provides command-line utilities to work with container images. |
|
ghactions
Package ghactions provides command-line utilities to work with GitHub Actions.
|
Package ghactions provides command-line utilities to work with GitHub Actions. |
|
kubernetes
Package kubernetes provides command-line utilities to work with kubernetes manifests.
|
Package kubernetes provides command-line utilities to work with kubernetes manifests. |
|
internal
|
|
|
cmd
Package cmd provide common implementations for commands
|
Package cmd provide common implementations for commands |
|
ghrest
Package ghrest provides a wrapper around the go-github client that implements the internal REST API
|
Package ghrest provides a wrapper around the go-github client that implements the internal REST API |
|
pkg
|
|
|
config
Package config provides the frizbee configuration.
|
Package config provides the frizbee configuration. |
|
constants
Package constants provides constants for the frizbee utilities.
|
Package constants provides constants for the frizbee utilities. |
|
containers
Package containers provides functions to replace tags for checksums
|
Package containers provides functions to replace tags for checksums |
|
ghactions
Package ghactions provides functions to locate action references and replace tags for checksums in GitHub Actions workflows.
|
Package ghactions provides functions to locate action references and replace tags for checksums in GitHub Actions workflows. |
|
interfaces
Package interfaces provides generic interfaces for communicating with remotes like github
|
Package interfaces provides generic interfaces for communicating with remotes like github |
|
utils
Package utils provides utilities for frizbee
|
Package utils provides utilities for frizbee |
|
utils/cli
Package cli provides utilities for frizbee's CLI.
|
Package cli provides utilities for frizbee's CLI. |