gobouncer

command module
v0.1.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 11, 2023 License: Apache-2.0 Imports: 1 Imported by: 0

README

bouncer

app-pipeline Go Report Card

A go dependency license checker.

This is thin a wrapper around google's license classifier forked from go-license with a few extra options.

Installation

# install the latest version to ./bin
curl -sSfL https://raw.githubusercontent.com/sulaiman-coder/gobouncer/master/bouncer.sh | sh 

# install a specific version to another directory
curl -sSfL https://raw.githubusercontent.com/sulaiman-coder/gobouncer/master/bouncer.sh | sh -s -- -b ./path/to/bin v1.26.0

Usage

# list the licenses of all of your dependencies...
bouncer list                        # ... from ./go.mod
bouncer list ~/some/path            # ... from ~/some/path/go.mod
bouncer list github.com/some/repo   # ... from a remote repo

# pass/fail of user-specified license restrictions (by .bouncer.yaml)
bouncer check
bouncer check ~/some/path
bouncer check github.com/some/repo

The .bouncer.yaml can specify a simple allow-list or deny-list license name regex patterns (by SPDX name):

permit:
  - BSD.*
  - MIT.*
  - Apache.*
  - MPL.*
forbid:
  - GPL.*
ignore-packages:
  - github.com/some/repo
forbid:
  - GPL.*

Note: either allow or deny lists can be specified, not both.

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
third_party/pkgsite/derrors
Package derrors defines internal error values to categorize the different types error semantics we support.
Package derrors defines internal error values to categorize the different types error semantics we support.
third_party/pkgsite/source
Package source constructs public URLs that link to the source files in a module.
Package source constructs public URLs that link to the source files in a module.
third_party/pkgsite/stdlib
Package stdlib supports special handling of the Go standard library.
Package stdlib supports special handling of the Go standard library.
third_party/pkgsite/version
Package version handles version types.
Package version handles version types.

Jump to

Keyboard shortcuts

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