Categorygithub.com/sigma/dep
modulepackage
0.4.1
Repository: https://github.com/sigma/dep.git
Documentation: pkg.go.dev
Overview
Versions
1
Dependencies
19
Dependents
0
Files
1.7k SLOC

# README

Build Status Windows Build Status

Dep

dep is a prototype dependency management tool for Go. It requires Go 1.8 or newer to compile. dep is safe for production use.

dep is the official experiment, but not yet the official tool. Check out the Roadmap for more on what this means!

For guides and reference materials about dep, see the documentation.

Installation

It is strongly recommended that you use a released version. Release binaries are available on the releases page.

On MacOS you can install or upgrade to the latest released version with Homebrew:

$ brew install dep
$ brew upgrade dep

If you're interested in hacking on dep, you can install via go get:

go get -u github.com/golang/dep/cmd/dep

Feedback

Feedback is greatly appreciated. At this stage, the maintainers are most interested in feedback centered on the user experience (UX) of the tool. Do you have workflows that the tool supports well, or doesn't support at all? Do any of the commands have surprising effects, output, or results? If not, please file an issue, describing what you did or wanted to do, what you expected to happen, and what actually happened.

Contributing

Contributions are greatly appreciated. The maintainers actively manage the issues list, and try to highlight issues suitable for newcomers. The project follows the typical GitHub pull request model. See CONTRIBUTING.md for more details. Before starting any work, please either comment on an existing issue, or file a new one.

# Packages

No description provided by the author
No description provided by the author
No description provided by the author

# Functions

BackupVendor looks for existing vendor directory and if it's not empty, creates a backup of it to a new directory with the provided suffix.
LockFromSolution converts a gps.Solution to dep's representation of a lock.
NewManifest instantites a new manifest.
NewSafeWriter sets up a SafeWriter to write a set of manifest, lock, and vendor tree.
ValidateProjectRoots validates the project roots present in manifest.

# Constants

LockName is the lock file name used by dep.
ManifestName is the manifest file name used by dep.
VendorAlways forces the vendor directory to always be written.
VendorNever indicates the vendor directory should never be written.
VendorOnChanged indicates that the vendor directory should be written when the lock is new or changed.

# Structs

Analyzer implements gps.ProjectAnalyzer.
Ctx defines the supporting context of dep.
Lock holds lock file data and implements gps.Lock.
Manifest holds manifest file data and implements gps.RootManifest.
A Project holds a Manifest and optional Lock for a project.
SafeWriter transactionalizes writes of manifest, lock, and vendor dir, both individually and in any combination, into a pseudo-atomic action with transactional rollback.
SolveMeta holds solver meta data.

# Type aliases

VendorBehavior defines when the vendor directory should be written.