-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #148 from s-urbaniak/vendor
Vendor dependencies, add hacking guide
- Loading branch information
Showing
67 changed files
with
11,683 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,124 @@ | ||
# Hacking Guide | ||
|
||
## Overview | ||
|
||
This guide contains instructions for building artifacts contained in this repository. | ||
|
||
### Go | ||
|
||
This spec includes several Go packages, and a command line tool considered to be a reference implementation of the OCI image specification. | ||
|
||
Prerequsites: | ||
* Go >=1.5 | ||
* make | ||
|
||
The following make targets are relevant for any work involving the Go packages. | ||
|
||
### Linting | ||
|
||
The included Go source code is being examined for any linting violations not included in the standard Go compiler. Linting is done using [gometalinter](https://github.com/alecthomas/gometalinter). | ||
|
||
Invocation: | ||
``` | ||
$ make lint | ||
``` | ||
|
||
### Tests | ||
|
||
This target executes all Go based tests. | ||
|
||
Invocation: | ||
``` | ||
$ make test | ||
$ make validate-examples | ||
``` | ||
|
||
### OCI image tool | ||
|
||
This target builds the `oci-image-tool` binary. | ||
|
||
Invocation: | ||
``` | ||
$ make oci-image-tool | ||
``` | ||
|
||
### Virtual schema http/FileSystem | ||
|
||
The `oci-image-tool` uses a virtual [http/FileSystem](https://golang.org/pkg/net/http/#FileSystem) to load the JSON schema files for validating OCI images and/or manifests. The virtual file system is generated using the `esc` tool and compiled into the `oci-image-tool` binary so the JSON schema files don't have to be distributed along with the binary. | ||
|
||
Whenever changes are being done in any of the `schema/*.json` files, one must refresh the generated virtual file system. Otherwise schema changes will not be visible inside the `oci-image-tool`. | ||
|
||
Prerequisites: | ||
* [esc](https://github.com/mjibson/esc) | ||
|
||
Invocation: | ||
``` | ||
$ make schema-fs | ||
``` | ||
|
||
### JSON schema formatting | ||
|
||
This target auto-formats all JSON files in the `schema` directory using the `jq` tool. | ||
|
||
Prerequisites: | ||
* [jq](https://stedolan.github.io/jq/) | ||
|
||
Invocation: | ||
``` | ||
$ make fmt | ||
``` | ||
|
||
### OCI image specification PDF/HTML documentation files | ||
|
||
This target generates a PDF/HTML version of the OCI image specification. | ||
|
||
Prerequisites: | ||
* [Docker](https://www.docker.com/) | ||
|
||
Invocation: | ||
``` | ||
$ make docs | ||
``` | ||
|
||
### License header check | ||
|
||
This target checks if the source code includes necessary headers. | ||
|
||
Invocation: | ||
``` | ||
$ make check-license | ||
``` | ||
|
||
### Update vendored dependencies | ||
|
||
This target updates all vendored depencies to their newest available versions. The `glide` tools is being used for the actual management and `glide-vc` tool is being used for stripping down the vendor directory size. | ||
|
||
Prerequisites: | ||
* [glide](https://github.com/Masterminds/glide) | ||
* [glide-vc](https://github.com/sgotti/glide-vc) | ||
|
||
Invocation: | ||
``` | ||
$ make update-deps | ||
``` | ||
|
||
### Clean build artifacts | ||
|
||
This target cleans all generated/compiled artifacts. | ||
|
||
Invocation: | ||
``` | ||
$ make clean | ||
``` | ||
|
||
### Create PNG images from dot files | ||
|
||
This target generates PNG image files from DOT source files in the `img` directory. | ||
|
||
Prerequisites: | ||
* [graphviz](http://www.graphviz.org/) | ||
|
||
Invocation: | ||
``` | ||
$ make img/media-types.png | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
package: github.com/opencontainers/image-spec | ||
import: | ||
- package: github.com/opencontainers/runtime-spec | ||
version: ^1.0.0-rc1 | ||
subpackages: | ||
- specs-go | ||
- package: github.com/pkg/errors | ||
version: ">=0.7.0" | ||
- package: github.com/spf13/cobra | ||
- package: github.com/xeipuuv/gojsonschema | ||
version: d5336c75940ef31c9ceeb0ae64cf92944bccb4ee |
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
15 changes: 15 additions & 0 deletions
15
vendor/github.com/inconshreveable/mousetrap/trap_others.go
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
98 changes: 98 additions & 0 deletions
98
vendor/github.com/inconshreveable/mousetrap/trap_windows.go
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
Oops, something went wrong.