{"id":15580920,"url":"https://github.com/nbulaj/capistrano-chewy","last_synced_at":"2025-04-24T02:48:30.557Z","repository":{"id":62554963,"uuid":"71146989","full_name":"nbulaj/capistrano-chewy","owner":"nbulaj","description":"Chewy tasks and Elasticsearch indexes management with Capistrano","archived":false,"fork":false,"pushed_at":"2019-02-01T15:17:50.000Z","size":35,"stargazers_count":14,"open_issues_count":1,"forks_count":2,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-24T02:48:20.588Z","etag":null,"topics":["capistrano","chewy","deployment","elasticsearch","ruby"],"latest_commit_sha":null,"homepage":"","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/nbulaj.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-10-17T14:28:08.000Z","updated_at":"2020-07-09T18:20:13.000Z","dependencies_parsed_at":"2022-11-03T05:30:29.599Z","dependency_job_id":null,"html_url":"https://github.com/nbulaj/capistrano-chewy","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nbulaj%2Fcapistrano-chewy","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nbulaj%2Fcapistrano-chewy/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nbulaj%2Fcapistrano-chewy/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nbulaj%2Fcapistrano-chewy/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nbulaj","download_url":"https://codeload.github.com/nbulaj/capistrano-chewy/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250552035,"owners_count":21449161,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["capistrano","chewy","deployment","elasticsearch","ruby"],"created_at":"2024-10-02T19:40:44.302Z","updated_at":"2025-04-24T02:48:30.527Z","avatar_url":"https://github.com/nbulaj.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Capistrano::Chewy\n[![Gem Version](https://badge.fury.io/rb/capistrano-chewy.svg)](http://badge.fury.io/rb/capistrano-chewy)\n[![Build Status](https://travis-ci.org/nbulaj/capistrano-chewy.svg?branch=master)](https://travis-ci.org/nbulaj/capistrano-chewy)\n[![Dependency Status](https://gemnasium.com/nbulaj/capistrano-chewy.svg)](https://gemnasium.com/nbulaj/capistrano-chewy)\n[![Code Climate](https://codeclimate.com/github/nbulaj/capistrano-chewy/badges/gpa.svg)](https://codeclimate.com/github/nbulaj/capistrano-chewy)\n\nManage and continuously rebuild your ElasticSearch indexes with [Chewy](https://github.com/toptal/chewy/) and [Capistrano](https://github.com/capistrano/capistrano) v3.\n\n`Capistrano::Chewy` gem adds automatic conditionally reset of only modified Chewy indexes and the removal of deleted index files to your deploy flow so you do not have to do it manually.\nMoreover, it adds the possibility of manual index management with the base Chewy tasks on the remote server.\n\n**DEPRECATED**: use [native Chewy rake tasks](https://github.com/toptal/chewy/#rake-tasks) for the same purposes.\n\n## Requirements\n\n* Ruby \u003e= 1.9.3\n* Capistrano \u003e= 3.0\n* Chewy \u003e= 0.4\n\n## Installation\n\nAdd this line to your application's Gemfile:\n\n```ruby\ngem 'capistrano-chewy', require: false\n```\n\nor:\n\n```ruby\ngem 'capistrano-chewy', require: false, group: :development\n```\n\nAnd then run bundler:\n\n```\n$ bundle\n```\n\nOr install it yourself as:\n\n```\n$ gem install capistrano-chewy\n```\n\nIf you want to use the latest version from the `master`, then add the following line to your Gemfile:\n\n```ruby\ngem 'capistrano-chewy', git: 'https://github.com/nbulaj/capistrano-chewy.git'\n```\n\n## Usage\n\nRequire it in your `Capfile`:\n\n```ruby\n# Capfile\n\n...\nrequire 'capistrano/chewy'\n...\n```\n\nthen you can use `cap -T` to list `Capistrano::Chewy` tasks:\n\n```ruby\ncap chewy:rebuild            # Reset modified and delete removed Chewy indexes\ncap chewy:reset              # Destroy, recreate and import data to all the indexes\ncap chewy:reset[indexes]     # Destroy, recreate and import data to the specified indexes\ncap chewy:update             # Updates data to all the indexes\ncap chewy:update[indexes]    # Updates data to the specified indexes\n```\n\nBy default `Capistrano::Chewy` adds `deploy:chewy:rebuild` task after `deploy:updated` and `deploy:reverted`.\nIf you want to change it, then you need to disable default gem hooks by setting `chewy_default_hooks` to `false` in your deployment config and manually define the order of the tasks.\n\n## Configuration\n\nYou can setup the following options:\n\n```ruby\n# deploy.rb\nset :chewy_conditionally_reset, false    # Reset only modified Chewy indexes, true by default\nset :chewy_path, 'app/my_indexes'        # Path to Chewy indexes, 'app/chewy' by default\nset :chewy_env, :chewy_production        # Environment variable for Chewy, equal to RAILS_ENV by default\nset :chewy_role, :web                    # Chewy role, :app by default  \nset :chewy_default_hooks, false          # Add default gem hooks to project deploy flow, true by default\nset :chewy_delete_removed_indexes, false # Delete indexes which files have been deleted, true by default\n```\n\n## Contributing\n\nYou are very welcome to help improve `Capistrano:Chewy` if you have suggestions for features that other people can use or some code improvements.\n\nTo contribute:\n\n1. Fork the project( http://github.com/nbulaj/capistrano-chewy/fork )\n2. Create your feature branch (`git checkout -b my-new-feature`)\n3. Commit your changes (`git commit -am 'Add some feature'`)\n4. Push to the branch (`git push origin my-new-feature`)\n5. Create new Pull Request\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnbulaj%2Fcapistrano-chewy","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnbulaj%2Fcapistrano-chewy","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnbulaj%2Fcapistrano-chewy/lists"}