ngtk / sail

Continuous application dependent libraries update

Sail

Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file lib/sail. To experiment with that code, run bin/console for an interactive prompt.

TODO: Delete this and the text above, and describe your gem

Installation

Add this line to your application's Gemfile:

gem 'sail'

And then execute:

$ bundle

Or install it yourself as:

$ gem install sail

Usage

TODO: Write usage instructions here

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. 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.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/ngtk/sail. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the Sail project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.

sail's Issues

Motivation and overview

WHY

• 継続的にアプリケーションが依存しているgemをアップデートしたい
• 既存のプロダクトとしてtachikomaがあるが、いくつか良くしたい点がある
  • 設定集中管理のため、アプリケーションエンジニアが編集しづらい
  • ドキュメントがわかりづらい

WHAT

• 設定は集中管理ではなくアプリケーション(リポジトリ)毎で管理sail.yml
• アップデーターにはリポジトリだけ登録
• Kubernetesのcron jobで定時実行できるようにする
  • 可能なようにするだけで、このプロダクト自体には含めなくても良いかも

Workflow

1. PRをつくるためのbotの設定
2. アプリケーションの設定
3. Cron jobでの定期実行
   a. bundle updateしてコミット
   b. 参考情報を含めてPRにする

1. PRをつくるためのbotの設定

• Personal access token (ENV)
• Commiter
  • name
  • email

config.yml

commiter:
  name: Update-Bot
  email: [email protected]

2. アプリケーションの設定

• GitHub repo URL
• PR
  • title
  • description
• 実行間隔・時間

sail.yml

repo_url: https://github.com/ngtk/sail
pull_request:
  title: %Y%m%d Update
frequency: daily
time: 09:00

3. Cron jobでの定期実行

• 実行間隔・時間からCron jobのmanifestファイルを自動生成
• ジョブの実行
  • リポジトリをクローン
  • bundle updateを実行
  • 設定したCommiterとしてcommit