Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/alouche/rodent

Manage Go Versions/Projects/Dependencies
https://github.com/alouche/rodent

Last synced: about 1 month ago
JSON representation

Manage Go Versions/Projects/Dependencies

Awesome Lists containing this project

README 

        
# rodent

[![Build Status](https://travis-ci.org/alouche/rodent.svg?branch=master)](https://travis-ci.org/alouche/rodent)



rodent is a shell (bash) application which:



* Manages multiple versions of Go.

* Allows you to test/build your projects against multiple Go releases at ease.

* Allows cross-compile builds for different platform targets (cgo/stdlib [workaround](https://groups.google.com/d/msg/golang-nuts/2XoGUvBalcw/ErSWiTlO17kJ)).

* Manages/tracks librairies dependencies by expanding the GOPATH

* Create separate workflows within a project per environment (i.e: build projectA with ENV="PRD" on go1.2.2 and ENV="DEV" on go1.3beta2)



This is achieved without getting in your way or hijacking your shell executables/builtins by making use of [shims](http://en.wikipedia.org/wiki/Shim_%28computing%29).



## In a nutshell



Screencasts



Manage multiple versions:



[![asciicast](https://asciinema.org/a/15316.png)](https://asciinema.org/a/15316)



rodentrc usage:



[![asciicast](https://asciinema.org/a/15315.png)](https://asciinema.org/a/15315)



```bash

$ rodent

Usage: rodent [command] [args]

       help        Display the help

       set         Set a version of Go

       init        Init current shell

       install     Install a version of Go

       versions    Display installed/in-use version(s)

       uninstall   Uninstall a version of Go



       system      Maintenance routines

```



For more information, checkout the [Wiki](https://github.com/alouche/rodent/wiki)



## Install

```bash

git clone http://github.com/alouche/rodent.git /my/path/to/rodent



# Add in your .bashrc, profile etc.



[[ -s "/my/path/to/rodent" ]] && source "/my/path/to/rodent"



# Restart your existing shell or open an new one and you are set. Type "rodent".

```



## Highlight Features



* Define a specific go version per project source/directory

```bash

echo "gover=go1.2.2" >> .rodentrc



# Build your project

go build



# Want to switch between multiple go versions in the same project (for testing new builds)

echo "gover_ATAG=go1.3beta2" >> .rodentrc



# Export your tag as variable

export RODENT_ENV=ATAG



# Build your project

go build

``` 

Any rodent variables when suffixed with "\_" are scopped as variables for the defined enviroment scope ; variables without these  suffixes are used as default variables



* Keep track of your project third party libraries

```bash

echo "godeps=/my/project/workspace" >> .rodentrc



# A dependency target per environment? easy...

echo "godeps_production=./local/prd/path" >> .rodentrc

echo "godeps_development=./local/dev/path" >> .rodentrc

  

# Fetch your dependencies

export RODENT_ENV=production

go get



# Alternatively

export RODENT_ENV=experimental

go build

```



You get the idea... for more information, please refer to the [rodentrc guide](https://github.com/alouche/rodent/wiki/rodentrc-file).



### Update rodent

```bash

rodent system -u

```



## Cross-compilation

Please refer to [cross-compilation environment](https://github.com/alouche/rodent/wiki/cross-compilation-setup)



## Why this project?



* I wanted something light/small which allowed all the above while being transparent and out of the way.

* Managing and tracking my third party libraries by maintaining a separate directory per project which I could simply "tar; cp and or even git submodule.." 

* I prefer using a custom GOPATH per project (or sometimes have a unique GOPATH for a subset of projects) and wanted to keep the "standard go workflow way of things" while maintaining that flexiblity/option.

* This is an experiment.



### Disclaimer



This project is relatively new and not perfect. It still requires a lot of work and does not pretend to be better than the numerous awesome tools the Golang community has created. It is just one way of tackling "Go version and dependency management", if you like it, use it and feel free to contribute.



## Contributing



rodent is not locked to a specific way of doing things, so if you have or found a better way to do things or tackle some of the challenges listed here, then I would love to hear of it, so "Go" forth - fork, patch, submit and inspire. The only dependency is that rodent should remain non-intrusive to the user's workflow and relatively light.



## Other tools in the same category

* [GVM](https://github.com/moovweb/gvm)



## License



(The MIT License)



Copyright (c) 2014 Ali Abbas



Permission is hereby granted, free of charge, to any person obtaining

a copy of this software and associated documentation files (the

'Software'), to deal in the Software without restriction, including

without limitation the rights to use, copy, modify, merge, publish,

distribute, sublicense, and/or sell copies of the Software, and to

permit persons to whom the Software is furnished to do so, subject to

the following conditions:



The above copyright notice and this permission notice shall be

included in all copies or substantial portions of the Software.



THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,

EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF

MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.

IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY

CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,

TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE

SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.