https://github.com/piotrmurach/static_deploy

Automate deployment of static websites
https://github.com/piotrmurach/static_deploy

deployment ruby rubygem static-site-building

Last synced: 3 days ago
JSON representation

Automate deployment of static websites

• Host: GitHub
• URL: https://github.com/piotrmurach/static_deploy
• Owner: piotrmurach
• License: mit
• Created: 2013-05-27T19:06:47.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2022-08-07T21:34:48.000Z (over 2 years ago)
• Last Synced: 2025-01-20T04:44:05.440Z (12 days ago)
• Topics: deployment, ruby, rubygem, static-site-building
• Language: Ruby
• Size: 20.5 KB
• Stars: 6
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.txt
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# StaticDeploy

[![Gem Version](https://badge.fury.io/rb/static_deploy.svg)][gem]

[![Build Status](https://secure.travis-ci.org/piotrmurach/static_deploy.svg?branch=master)][travis]

[gem]: http://badge.fury.io/rb/static_deploy

[travis]: http://travis-ci.org/piotrmurach/static_deploy

> Rake tasks to ease publishing a static website via git to a remote repository (e.g. GitHub pages).

## Installation

Add this line to your application's Gemfile:

    gem 'static_deploy'

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install static_deploy

## Usage

In `Rakefile` add the following:

```ruby

require 'static_deploy'

ENV['GENERATOR'] = 'jekyll'  # => static website generator executable

ENV['COMMAND']   = 'build'   # => command for building a project, defaults to 'build'

```

When deploying inside the current repository, git defaults are used to get username and repository name:

```ruby

bundle exec rake site:publish

```

Otherwise, to publish to remote branch in the different repository do:

```ruby

bundle exec rake site:publish["username/repository"]

```

As a convenience you may want to add the following rake task to your `Rakefile`:

```ruby

desc 'publish this site'

task :publish do

  Rake::Task['site:publish'].invoke("username/repository")

end

```

## Contributing

1. Fork it

2. Create your feature branch (`git checkout -b my-new-feature`)

3. Commit your changes (`git commit -am 'Add some feature'`)

4. Push to the branch (`git push origin my-new-feature`)

5. Create new Pull Request

## Code of Conduct

Everyone interacting in the StaticDeploy project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/piotrmurach/static_deploy/blob/master/CODE_OF_CONDUCT.md).

## Copyright

Copyright (c) 2013 Piotr Murach. See LICENSE for further details.