b458f63713
Manul works great, but using git submodules creates some problems (like https://github.com/travis-ci/travis-ci/issues/5806), switch to govendor to have reproducible builds
1.7 KiB
Contributing to unsee
Getting Started
To get started follow Building from source section of the README
file.
Testing changes
To run included tests and check code style with golint run:
make test
Vendoring dependencies
If you use any new dependency or remove any existing one, please run:
make vendor
This will install and run govendor, which will detect all used package and fetch them into the vendor directory.
To update all vendor package run:
make vendor-update
To update specific vendor package run govendor manually:
govendor update <import-path-filter>
See govendor documentation for details.
Running
To build and start unsee from local branch see Running section of the
README file.
When working with assets (templates, stylesheets and javascript files) DEBUG
make variable can be set, which will recompile binary assets in debug mode,
meaning that files from disk will be read instead of compiled in assets.
See go-bindata docs
for details. Example:
make DEBUG=true run
make DEBUG=true run-docker
Note that this is not the same as enabling debug mode for
the gin web framework which is used
internally, but enabling DEBUG via this make variable will also enable gin
debug mode.
When running docker image via make run-docker with DEBUG make variable set
to true volume mapping will be added (in read-only mode), so that unsee
instance running inside the docker can read asset files from the sources
directory.