From fada88250479378ec1407aaf2dbea11238a94cd3 Mon Sep 17 00:00:00 2001 From: Joseph Wright Date: Sat, 29 Dec 2018 22:06:06 -0500 Subject: [PATCH] Add a README to the skeleton project --- Makefile | 4 ++-- README.md | 4 ++++ ofcourse/bindata.go | 23 +++++++++++++++++++++++ 3 files changed, 29 insertions(+), 2 deletions(-) diff --git a/Makefile b/Makefile index 1796e3d..859b642 100644 --- a/Makefile +++ b/Makefile @@ -7,8 +7,8 @@ _output/go/bin/go-bindata: ofcourse/bindata.go: _output/go/bin/go-bindata templates/resource/resource.go \ templates/resource/resource_test.go templates/Dockerfile templates/Makefile \ - templates/pipeline.yml templates/go.mod templates/cmd/check/main.go \ - templates/cmd/out/main.go templates/cmd/in/main.go + templates/README.md templates/pipeline.yml templates/go.mod \ + templates/cmd/check/main.go templates/cmd/out/main.go templates/cmd/in/main.go ./_output/go/bin/go-bindata \ -o ofcourse/bindata.go \ -pkg ofcourse \ diff --git a/README.md b/README.md index 6a6b43b..3444d12 100644 --- a/README.md +++ b/README.md @@ -107,6 +107,10 @@ For the `docker` and `publish` targets, if `VERSION` is passed to `make`, then t > make publish VERSION=1.2.3 ``` +# Project README + +A skeleton `README.md` file is generated for the project, which should be filled in with valid descriptions, and should document the source config and parameters required to make the resource function properly. The format follows the ones used by builtin Concourse resources, for example the [git resource](https://github.com/concourse/git-resource) or the [s3 resource](https://github.com/concourse/s3-resource). + # Logging Since Concourse resources communicate back to Concourse over standard output, they cannot print information to standard output. For this reason, each of the `Check`, `In`, and `Out` methods receive a `logger` argument that will print to standard error, using colored log levels. The log level may be configured in the `source` of every resource that uses the `ofcourse` library. The available levels are `debug`, `info`, `warn`, `error`, and `silent`. diff --git a/ofcourse/bindata.go b/ofcourse/bindata.go index 12ec571..bc4416a 100644 --- a/ofcourse/bindata.go +++ b/ofcourse/bindata.go @@ -2,6 +2,7 @@ // sources: // templates/Dockerfile // templates/Makefile +// templates/README.md // templates/cmd/check/main.go // templates/cmd/in/main.go // templates/cmd/out/main.go @@ -114,6 +115,26 @@ func makefile() (*asset, error) { return a, nil } +var _readmeMd = []byte("\x1f\x8b\x08\x00\x00\x00\x00\x00\x00\xff\xb4\x55\x4d\x6f\x1b\x37\x14\xbc\xf3\x57\x0c\xa0\x9b\x10\x6d\xaa\xb6\x41\x81\x05\x7a\x49\xec\x16\x3d\x34\x31\x94\xb4\x3d\x9a\xd4\xee\x13\xc9\x8a\x4b\x6e\xf9\x21\xc5\x08\xf2\xdf\x8b\xc7\xd5\xc6\x56\x5c\xb9\xee\xa1\x27\x49\xe4\xcc\x9b\x79\xc3\x47\x6a\x81\x4f\x9f\xd0\x6c\x28\x85\x12\x3b\xc2\xe7\xcf\x42\xfc\x11\x6d\x26\x28\xf4\x94\xba\x68\xc7\x6c\x83\x47\xd8\x21\x1b\x42\x9c\x71\x86\x22\x35\x42\x2c\x16\x78\x3f\x2d\xbc\x09\x7e\x67\x75\x89\x8a\xe1\x42\x2c\x21\x95\x6c\xb1\xdc\xd0\x5f\xc5\x46\xea\x9b\x25\x3e\x18\x9b\x60\x13\x14\xe2\x69\x11\x89\x72\xb6\x5e\x37\x15\xbf\x65\xfc\xbb\x2a\xa7\xdc\x43\xbc\x47\x38\xad\x9e\x13\xba\x33\x02\xae\x68\xa7\x8a\xcb\x90\x39\x16\x92\x4f\xf2\x71\xb4\xd9\xd4\x0e\x27\xca\x41\xb9\x32\xb5\xb3\xc0\xf5\x47\x35\x8c\x8e\x84\x90\x52\xde\xa9\xc1\x89\xb9\xe7\xdb\x7c\x37\x52\x6a\xc5\x0a\x5e\x0d\xd4\x3e\xca\x0d\x60\x40\x8b\x3e\x74\x7b\x8a\x2b\x3b\x28\x4d\x02\x98\x00\xad\x00\x80\x48\x63\x48\x36\x87\x78\x37\xd1\xaf\x2a\x74\x43\xda\xa6\x1c\xef\x6a\xf8\xb3\xda\x33\x84\x1e\xaf\x77\x86\xba\xfd\x2d\x1d\x88\x05\x5e\x0d\x5f\xa9\xbb\xa0\x6f\x1d\x1d\xc8\xb5\xe8\x69\x5b\xb4\x10\x7f\x86\xed\x03\x9d\x3e\xac\x6c\x16\xc0\xe8\x94\x67\xc6\x0a\x9a\xf2\x3f\xc9\x00\x39\x5a\xad\x29\xb6\xe0\xac\x2b\x74\x2c\x17\xa0\xa3\x8a\x6a\x48\x93\x03\xe0\x40\x31\xd9\xe0\x6f\x47\x95\xcd\x23\xfc\xcb\xd3\x2e\x47\x5f\x67\xeb\x35\x19\x75\xb0\x21\x4e\x27\x23\x6b\x7b\xb2\xc5\x1b\xfe\xc4\x2e\x44\xa4\x30\x50\x36\xd6\xeb\x8b\x53\x7b\x34\x2a\xf3\x14\x54\x2e\xf5\xf7\x83\xbb\x80\xb4\x5e\xb6\xf8\x89\x72\x67\xfe\x43\xa1\x1d\xe3\xcf\x0a\x2d\x70\xc3\x3d\x52\xa6\x98\x9e\x3b\xf9\xe3\xcc\x78\xfe\xec\x3f\xa4\x54\xfb\xa1\x64\xd9\xe2\xa6\xe4\x7b\xf7\xf5\xdb\x91\xad\xfd\x6b\x1f\x5b\x62\xfc\x78\x62\x1f\xff\xc7\x76\x9e\x75\x33\xbf\x54\xb8\x7c\x37\x71\xc5\xc3\x1b\xc6\x81\x7c\x9e\x22\xb8\x89\x54\x2d\x24\x9b\xa9\x7a\xd5\xc1\x29\xaf\xb9\xf6\x72\xf6\xb6\xc4\x6a\x9e\x3a\xac\x9b\xf5\xba\xf9\x88\x10\x61\xac\x36\x14\x19\x38\xe3\x1a\xb1\x3c\x5d\xdd\xcb\xf4\x1f\x9a\x6f\x5e\x3d\xc5\x1f\xd4\x9e\x2e\xb2\xbf\x6f\xd6\x9c\xff\xcf\x6f\x7f\xfb\x82\xcb\x94\x32\x33\x6b\x33\x9b\xe2\x3d\x1f\x09\xbf\xb3\xbc\x91\x84\xf8\x60\x08\xbf\xaa\x3d\xed\xac\x23\x58\xdf\xb9\xd2\x13\xe7\x2e\x79\x5f\x22\xab\xa8\x29\xbf\x80\xf2\xfd\xc4\x80\x8a\x04\xe5\x52\x40\x2c\x1e\xd6\x27\xdb\x53\xad\x37\x3d\x34\xd8\x16\xeb\x58\x6e\x53\xfc\xbd\xcc\x14\x38\xff\xdc\x05\xe7\xc2\x91\x3d\x74\x61\x18\x94\xef\xdb\xfa\x0a\x26\x23\xaa\x61\x46\xcf\x57\x73\x81\xd7\x5c\x8b\xb1\xac\x3e\x96\xad\xb3\xc9\xcc\xf6\xa7\xb7\xef\x82\xfd\xc9\x75\xaa\xf7\x77\xfb\x44\x91\xf9\x30\xb8\x56\x83\x6b\xd5\x99\xd3\xbf\x50\x22\x91\xd5\x9e\xce\xe7\x47\xfe\x7e\xbd\x79\xff\xcb\xbb\xb7\x12\x2a\xea\xc2\x23\xf2\x02\x47\x63\x3b\x83\xa3\x75\x0e\x59\x55\x8d\x97\x21\x62\x2c\xc9\x3c\x12\xa8\x21\x08\x5e\xd5\xf6\x40\x7e\x3e\xb4\xe6\x2c\x80\x93\xc4\x8f\xeb\xe6\xdb\xe6\xbb\x69\xe9\xe4\xf9\xab\x2d\x0e\xe9\xef\x00\x00\x00\xff\xff\x1b\x38\x83\x44\x59\x07\x00\x00") + +func readmeMdBytes() ([]byte, error) { + return bindataRead( + _readmeMd, + "README.md", + ) +} + +func readmeMd() (*asset, error) { + bytes, err := readmeMdBytes() + if err != nil { + return nil, err + } + + info := bindataFileInfo{name: "README.md", size: 1881, mode: os.FileMode(436), modTime: time.Unix(1546138167, 0)} + a := &asset{bytes: bytes, info: info} + return a, nil +} + var _cmdCheckMainGo = []byte("\x1f\x8b\x08\x00\x00\x00\x00\x00\x00\xff\x3c\xcc\xbd\x0a\xc3\x20\x14\xc5\xf1\x39\xe7\x29\xc4\xa1\xe8\xa2\x0f\xd1\xa9\x5b\xe9\x1b\x98\x5b\x13\x25\x35\x37\xf8\x31\x89\xef\x5e\x08\x4d\xb7\xff\xe1\xc0\xef\x70\xb4\xb9\xd5\x8b\xe4\xe2\x0e\xc4\x74\x70\xae\x42\x61\x92\xbd\x0b\xf3\x38\xe7\xd3\xd5\x20\xc6\xb0\xd9\x17\x6e\x99\xbc\xc4\x24\xd7\x58\x43\x9b\x0d\x71\xb2\xf4\xe1\xf6\x9e\xb9\x14\xcb\x0b\x71\xcb\xc5\xff\x43\x42\x03\x4b\xdb\xe9\xe4\x95\x16\x1d\xd3\xf5\x99\x7b\xf0\xb4\xa9\xdb\xa5\x9a\xd7\x2f\xfa\xd0\x18\xf8\x06\x00\x00\xff\xff\x7d\x4e\xa3\xf9\x98\x00\x00\x00") func cmdCheckMainGoBytes() ([]byte, error) { @@ -308,6 +329,7 @@ func AssetNames() []string { var _bindata = map[string]func() (*asset, error){ "Dockerfile": dockerfile, "Makefile": makefile, + "README.md": readmeMd, "cmd/check/main.go": cmdCheckMainGo, "cmd/in/main.go": cmdInMainGo, "cmd/out/main.go": cmdOutMainGo, @@ -359,6 +381,7 @@ type bintree struct { var _bintree = &bintree{nil, map[string]*bintree{ "Dockerfile": &bintree{dockerfile, map[string]*bintree{}}, "Makefile": &bintree{makefile, map[string]*bintree{}}, + "README.md": &bintree{readmeMd, map[string]*bintree{}}, "cmd": &bintree{nil, map[string]*bintree{ "check": &bintree{nil, map[string]*bintree{ "main.go": &bintree{cmdCheckMainGo, map[string]*bintree{}},