Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lucachr/nitrogen
A simple dependency manager for Go.
https://github.com/lucachr/nitrogen
Last synced: 3 months ago
JSON representation
A simple dependency manager for Go.
- Host: GitHub
- URL: https://github.com/lucachr/nitrogen
- Owner: lucachr
- License: mit
- Archived: true
- Created: 2015-02-02T19:56:12.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2015-12-25T20:20:26.000Z (almost 9 years ago)
- Last Synced: 2024-07-27T19:44:35.789Z (4 months ago)
- Language: Shell
- Homepage:
- Size: 18.6 KB
- Stars: 43
- Watchers: 4
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
nitrogen
=========
DEPRECATION NOTICE
-------------------
nitrogen has fulfilled its purpose, as a mean to provide a temporary solution
to the lack of ways to manage dependencies of programs written in Go, until the
release of a tool on which the community would find agreement.
With the release of Go 1.6, [vendoring](https://tip.golang.org/cmd/go/#hdr-Vendor_Directories)
support is no longer considered experimental and it's the default way to handle
dependencies, so the use of a dependency manager outside the Go standard tools is
not necessary anymore.
nitrogen will be deprecated with the release of Go 1.6. Support for bug fixes
will be provided till the release of Go 1.7, then nitrogen will be no
longer maintained and this repository will be kept only for reference.
Thanks to everyone who took part, used or sent corrections to the project.
_______________________________________________________________________________
nitrogen is a simple dependency manager for Go.
It is a bash script that you should distribute with your Go package. Nitrogen
leverages on the git, hg, and bzr versioning systems, so you don't need to distribute
the full dependecy tree with your package, the standard gopath mechanism just
works well.
Set up dependencies
--------------------
Dependencies are listed in a file called 'deps' that is located in the
same directory of nitrogen (i.e. your package root directory). Dependencies
are formatted as "package version", where "package" is the name of the Go
package that you need to install (e.g "golang.org/x/crypto/blowfish") and
"version" is every suitable option for `git checkout`, `hg update` or
`bzr revert -r`.
e.g.
```
code.google.com/p/go-uuid -c 35bc42037350
golang.org/x/crypto 4ed45ec682102c643324fae5dff8dab085b6c300
```
### Hey, I just want to freeze dependecies at the current version!
That's why nitrogen has a '-f' (--freeze) option.
```
nitrogen -f
```
You should find your dependencies listed in the generated 'deps' file.
Install dependencies
---------------------
To install a package with the required dependencies, download it with
```
go get -d PACKAGE
```
Then, from the package root, start nitrogen with '-i' (--install).
```
nitrogen -i
```
Nitrogen downloads the required dependencies and installs the package with
dependencies at the specified versions, then it restores the dependencies back
to the default (master branch or latest version) versions.
If you want to mantain the dependencies at the version required by your
package, instead launch it with '-i --no-clean'
```
nitrogen -i --no-clean
```
After you have done with the work on your package, restore the depencencies
at the default versions with the '-c' (--clean) option.
```
nitrogen -c
```
License
--------
nitrogen is released under [the MIT License](http://opensource.org/licenses/MIT).