Manage dependencies and build Go projects outside GOPATH
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Lunny Xiao 65bfc5da7d
drop go1.9 support
4 days ago
.circleci fix circleci config and README 2 years ago
cmd update example 4 days ago
examples update example 4 days ago
vendor update example 4 days ago
.drone.yml drop go1.9 support 4 days ago
.gitignore update example 4 days ago
LICENSE add LICENSE file 2 years ago
README.md use go mod 3 months ago
README_ZH.md use go mod 3 months ago
doc.go use go mod 3 months ago
go.mod update example 4 days ago
go.sum update example 4 days ago
main.go fix vet 1 week ago

README.md

GOP

简体中文

Build Status

GOP is a project manangement tool for building your golang applications out of global GOPATH. In fact gop will keep both global GOPATH and every project GOPATH. But that means your project will not go-getable. Of course, GOP itself is go-getable. GOP copy all denpendencies from global GOPATH to your project’s src/vendor directory and all application’s sources are also in src directory.

A normal process using gop is below:

git clone xxx@mydata.com:bac/aaa.git
cd aaa
gop ensure -g
gop build
gop test

Features

  • GOPATH compitable
  • Multiple build targets support
  • Put your projects out of global GOPATH

Installation

Please ensure you have installed the go command, GOP will invoke it on building or testing

go get gitea.com/lunny/gop

Directory structure

Every project should have a GOPATH directory structure and put a gop.yml int the root directory. This is an example project’s directory tree.

<project root>
├── gop.yml
├── bin
├── doc
└── src
    ├── main
    │   └── main.go
    ├── models
    │   └── models.go
    ├── routes
    │   └── routes.go
    └── vendor
        └── github.com
            ├── go-xorm
            │   ├── builder
            │   ├── core
            │   └── xorm
            └── lunny
                ├── log
                └── tango

Gop.yml

Gop will recognize a gop project which has gop.yml. The file is also a project configuration file. Below is an example. If you didn’t define any target, the default target is src/main and the target name is the project name.

targets:
- name: myproject1
  dir: main
  assets:
  - templates
  - public
  - config.ini
  - key.pem
  - cert.pem
- name: myproject2
  dir: web
  assets:
  - templates
  - public
  - config.ini
  monitors:
  - config.ini

Command

init

Create the default directory structure tree.

mkdir newproject
cd newproject
gop init

and you can also create config file for vscode

gop init -e=vscode

ensure

Automatically copy dependencies from $GOPATH to local project directory. -g will let you automatically call go get <package> when the package is missing on GOPATH. -u will always go get <package> on all the dependencies and copy them to vendor.

gop ensure [-g|-u] [target_name]

status

List all dependencies of this project and show the status.

gop status [target_name]

add

Add one or more packages to this project.

gop add <package1> <package2>

update

Update one or more packages to this project. All missing dependent packages will also be added. -f will update exists dependent packages.

gop update [-f] <package1> <package2>

rm

Remove one or more packages from this project.

gop rm <package1> <package2>

build

Run go build on the src directory. If you want to execute ensure before build, you can use -e flag.

gop build [-e] [target_name]

run

Run go run on the src directory. -w will monitor the go source code changes and automatically build and run again. -e will automatically execute ensure before every time build.

gop run [-w] [target_name]

test

Run go test on the src directory. If you want to execute ensure before build, you can use -e flag.

gop test [-e] [target_name]

release

Run go release on the src directory.

gop release [target_name]

TODO

  • Versions support, specify a dependency package verison
  • Support run gop in GOPATH