No description

Find a file

ctro 679e8d1e3a Revert "Update docs for Docker install, Development use, and Tests" This reverts commit `6068e23756`. Commit was placed on wrong branch.		2016-03-18 08:31:09 -06:00
assets	Revert "Update docs for Docker install, Development use, and Tests"	2016-03-18 08:31:09 -06:00
test	Revert "Update docs for Docker install, Development use, and Tests"	2016-03-18 08:31:09 -06:00
.gitignore	pass the AWS credentials through the Concourse source data	2016-03-10 10:57:12 -05:00
config.example.json	pass the AWS credentials through the Concourse source data	2016-03-10 10:57:12 -05:00
CONTRIBUTING.md	add boilerplate 18F files	2016-03-10 00:45:03 -05:00
Dockerfile	finish up the `out` script	2016-03-10 03:01:02 -05:00
LICENSE.md	add boilerplate 18F files	2016-03-10 00:45:03 -05:00
README.md	Revert "Update docs for Docker install, Development use, and Tests"	2016-03-18 08:31:09 -06:00

README.md

Simple S3 Resource for Concourse CI

Resource to upload files to S3. Unlike the the official S3 Resource, this Resource doesn't care about files being versioned.

Usage

Include the following in your Pipeline YAML file, replacing the values in the angle brackets (< >):

resource_types:
- name: <resource type name>
  type: docker-image
  source:
    repository: 18fgsa/s3-resource-simple
resources:
- name: <resource name>
  type: <resource type name>
  source:
    access_key_id: {{aws-access-key}}
    secret_access_key: {{aws-secret-key}}
    bucket: {{aws-bucket}}
jobs:
- name: <job name>
  plan:
  - <some Resource or Task that outputs files>
  - put: <resource name>

See the instructions for getting your AWS credentials, then pass them and the bucket name in as parameters.

Development

Requires Docker.

Run cp config.example.json config.json.
Modify config.json.
- See the instructions for getting your AWS credentials.
- Exclude the s3:// prefix/protocol for the bucket.
Run ./test/out </full/path/to/dir/or/file>.