Skip to content
This repository has been archived by the owner on May 8, 2022. It is now read-only.
/ cartage-s3 Public archive

Build packages in Ruby and upload them to AWS S3.

License

Notifications You must be signed in to change notification settings

KineticCafe/cartage-s3

Repository files navigation

cartage-s3 by Kinetic Cafe

code

github.com/KineticCafe/cartage-s3/

issues

github.com/KineticCafe/cartage-s3/issues

continuous integration

<img src=“https://travis-ci.org/KineticCafe/cartage-s3.svg?branch=master” alt=“Build Status” />

Description

cartage-s3 is a plug-in for cartage to upload the built package to Amazon’s S3 or a service with a similar interface.

Cartage provides a repeatable means to create a package for a Rails application that can be used in deployment with a configuration tool like Ansible, Chef, Puppet, or Salt.

Synopsis & Configuration

cartage-s3 provides a new command to Cartage.

# Uploads a previously built package to S3 at the `default` location.
cartage --timestamp=20160322144532 s3 put

# Lists packages in S3.
cartage s3 ls

# Removes a previously built package from S3.
cartage --timestamp=20160321123418 s3 rm

# Gets a previously built package from S3.
cartage --timestamp=20160322144532 s3 get

Access keys can be configured in the plugins.s3 section of the Cartage configuration file.

---
plugins:
  s3:
    destination: default # The name of the target destination to use.
    destinations:
      default:
        path: bucket # The name of the bucket to use.
        credentials:
          provider: AWS
            aws_access_key_id: <%= ENV['AWS_ACCESS_KEY_ID'] %>
            aws_secret_access_key: <%= ENV['AWS_SECRET_ACCESS_KEY'] %>
            region: us-west-2
            path_style: true

Install

Add cartage-s3 to your Gemfile:

gem 'cartage-s3', '~> 2.0', groups: [ :development, :test ]

Or manually install:

% gem install cartage-s3

This plug-in should not be part of your production environment; its purposes is to manage remotely stored production-ready packages.

cartage-s3 Semantic Versioning

cartage-s3 uses a Semantic Versioning scheme with one change:

  • When PATCH is zero (0), it will be omitted from version references.

cartage-s3 will generally track cartage for major versions to ensure plugin API compatibility.

Community and Contributing

cartage-s3 welcomes your contributions as described in Contributing.md. This project, like all Kinetic Cafe open source projects, is under the Kinetic Cafe Open Source Code of Conduct.

About

Build packages in Ruby and upload them to AWS S3.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages