Skip to content

Commit

Permalink
Add a README to the skeleton project
Browse files Browse the repository at this point in the history
  • Loading branch information
rjosephwright committed Dec 30, 2018
1 parent f8068ca commit fada882
Show file tree
Hide file tree
Showing 3 changed files with 29 additions and 2 deletions.
4 changes: 2 additions & 2 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -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 \
Expand Down
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`.
Expand Down
23 changes: 23 additions & 0 deletions ofcourse/bindata.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit fada882

Please sign in to comment.