https://github.com/sul-dlss/capistrano-shared_configs
A capistrano extension that provides tasks to manage DLSS Shared Configs.
https://github.com/sul-dlss/capistrano-shared_configs
access deployment gem infrastructure
Last synced: 9 months ago
JSON representation
A capistrano extension that provides tasks to manage DLSS Shared Configs.
- Host: GitHub
- URL: https://github.com/sul-dlss/capistrano-shared_configs
- Owner: sul-dlss
- License: other
- Created: 2016-09-21T21:00:37.000Z (almost 10 years ago)
- Default Branch: main
- Last Pushed: 2022-07-26T18:04:08.000Z (almost 4 years ago)
- Last Synced: 2025-01-21T23:13:31.325Z (over 1 year ago)
- Topics: access, deployment, gem, infrastructure
- Language: Ruby
- Homepage:
- Size: 13.7 KB
- Stars: 0
- Watchers: 18
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Capistrano::SharedConfigs
This gem provides capistrano tasks to pull the latest configs from the shared configs branch and update the symlinks in the shared directory.
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'capistrano-shared_configs'
```
And then execute:
$ bundle
Or install it yourself as:
$ gem install capistrano-shared_configs
## Usage
It depends on another agent (i.e. puppet) to get the shared_configs branch onto the server.
The tasks can be made available to your capistrano deploy environments by requiring `capistrano/shared_configs` in your `Capfile`.
The three tasks made available to you are
```
cap shared_configs:check
cap shared_configs:pull
cap shared_configs:symlink
cap shared_configs:update
```
`shared_configs:update` simply calls `pull` and then `symlink` and is intended to provide a simple single command.
This can be added into your deployment workflow to automatically pull and symlink shared configs into your capistrano shared directories, or alternatively just run manually from the command line.
## Development
After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/sul-dlss/capistrano-shared_configs.
## License
The gem is available as open source under the terms of the [Apache 2.0 License](https://opensource.org/licenses/apache-2.0).