tomo 1.3.1 → 1.4.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +42 -24
- data/lib/tomo/commands/init.rb +4 -0
- data/lib/tomo/plugin/rbenv/tasks.rb +16 -2
- data/lib/tomo/ssh/connection_validator.rb +4 -4
- data/lib/tomo/templates/config.rb.erb +2 -0
- data/lib/tomo/testing/docker_image.rb +3 -3
- data/lib/tomo/version.rb +1 -1
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 4e70a81efc32a7a80b37b26edc668de8daa510e7954884a3711d71ced6ef1bf8
|
4
|
+
data.tar.gz: eef6788e4b36c1cdad66170b6b616af8a08f890bc089a6c70e6a12132a061911
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 4425384a896b364775994859d7ea4307cac1abcbd507514d6f7289d6a684f6263cd7b17d250d280f6f2ccd596ed47f5d8f0871337dd5b69895aa74a0ea9c718e
|
7
|
+
data.tar.gz: 57a0929d3e1be161c7830449226327ee1c4f0e20f4949658ec02287c436c4fbb12e8a7f819a4525266beb29a8abd6381285aae27e21b6e753ac27028783dca1f
|
data/README.md
CHANGED
@@ -5,22 +5,22 @@
|
|
5
5
|
[![Circle](https://circleci.com/gh/mattbrictson/tomo/tree/main.svg?style=shield)](https://app.circleci.com/pipelines/github/mattbrictson/tomo?branch=main)
|
6
6
|
[![Code Climate](https://codeclimate.com/github/mattbrictson/tomo/badges/gpa.svg)](https://codeclimate.com/github/mattbrictson/tomo)
|
7
7
|
|
8
|
-
Tomo is a friendly command-line tool for deploying Rails apps.
|
8
|
+
Tomo is a friendly command-line tool for deploying Rails apps.
|
9
9
|
|
10
10
|
💻 Rich command-line interface with built-in bash completions<br/>
|
11
11
|
☁️ Multi-environment and role-based multi-host support<br/>
|
12
12
|
💎 Everything you need to deploy a basic Rails app out of the box<br/>
|
13
13
|
🔌 Easily extensible for polyglot projects (not just Rails!)<br/>
|
14
|
-
💡 Concise, helpful error messages<br/>
|
15
14
|
📚 Quality documentation<br/>
|
16
15
|
🔬 Minimal dependencies<br/>
|
17
16
|
|
18
|
-
See
|
17
|
+
[→ See how tomo compares to other Ruby deployment tools like Capistrano and Mina.](https://tomo-deploy.com/comparisons/)
|
19
18
|
|
20
19
|
---
|
21
20
|
|
22
21
|
- [Quick start](#quick-start)
|
23
22
|
- [Usage](#usage)
|
23
|
+
- [Extending tomo](#extending-tomo)
|
24
24
|
- [Tutorials](#tutorials)
|
25
25
|
- [Reference documentation](#reference-documentation)
|
26
26
|
- [FAQ](#faq)
|
@@ -31,21 +31,19 @@ See [how tomo compares](https://tomo-deploy.com/comparisons/) to other Ruby depl
|
|
31
31
|
|
32
32
|
## Quick start
|
33
33
|
|
34
|
+
#### Installation
|
35
|
+
|
34
36
|
Tomo is distributed as a ruby gem. To install:
|
35
37
|
|
36
38
|
```
|
37
39
|
$ gem install tomo
|
38
40
|
```
|
39
41
|
|
40
|
-
|
41
|
-
|
42
|
-
```
|
43
|
-
$ tomo completion-script
|
44
|
-
```
|
42
|
+
> 💡 **Protip:** run `tomo completion-script` for instructions on setting up bash completions.
|
45
43
|
|
46
44
|
#### Configuring a project
|
47
45
|
|
48
|
-
Tomo is configured via a `.tomo/config.rb` file in your project. To get started,
|
46
|
+
Tomo is configured via a `.tomo/config.rb` file in your project. To get started, run `tomo init` to generate a configuration that works for a basic Rails app.
|
49
47
|
|
50
48
|
![$ tomo init](./readme_images/tomo-init.png)
|
51
49
|
|
@@ -87,20 +85,25 @@ deploy do
|
|
87
85
|
end
|
88
86
|
```
|
89
87
|
|
90
|
-
|
88
|
+
#### Next steps
|
89
|
+
|
90
|
+
[→ The reference docs have a complete guide to tomo configuration.](https://tomo-deploy.com/configuration/)<br>
|
91
|
+
[→ Check out the **Deploying Rails From Scratch** tutorial for a step-by-step guide to using tomo with a real app.](https://tomo-deploy.com/tutorials/deploying-rails-from-scratch/)
|
91
92
|
|
92
93
|
## Usage
|
93
94
|
|
94
|
-
|
95
|
+
Once your project is configured, you can:
|
96
|
+
|
97
|
+
1. Run `tomo setup` to prepare the remote host for its first deploy.
|
98
|
+
2. Run `tomo deploy` to deploy your app.
|
99
|
+
3. Use `tomo run` to invoke one-off tasks, like launching a Rails console.
|
95
100
|
|
96
|
-
|
97
|
-
2. `tomo deploy` performs a deployment
|
98
|
-
3. `tomo run` lets you invoke one-off tasks
|
101
|
+
> 💡 **Protip:** add `-h` or `--help` when running any of these commands to see detailed docs and examples.
|
99
102
|
|
100
|
-
###
|
103
|
+
### `tomo setup`
|
101
104
|
|
102
105
|
`tomo setup` prepares the remote host for its first deploy by sequentially running the
|
103
|
-
|
106
|
+
`setup` list of tasks specified in `.tomo/config.rb`. These tasks typically create directories, initialize data stores, install prerequisite tools, and perform other one-time actions that are necessary before a deploy can take place.
|
104
107
|
|
105
108
|
Out of the box, tomo will:
|
106
109
|
|
@@ -109,9 +112,12 @@ Out of the box, tomo will:
|
|
109
112
|
- Create all necessary deployment directories
|
110
113
|
- Create the Rails database, load the schema, and insert seed data
|
111
114
|
|
112
|
-
|
115
|
+
[→ Here is the default list of tasks invoked by the setup command.](https://tomo-deploy.com/configuration#setupblock)<br>
|
116
|
+
[→ The `tomo setup` section of the reference docs explains supported command-line options.](https://tomo-deploy.com/commands/setup/)
|
113
117
|
|
114
|
-
|
118
|
+
### `tomo deploy`
|
119
|
+
|
120
|
+
Whereas `tomo setup` is typically run once, you can use `tomo deploy` every time you want to deploy a new version of your app. The deploy command will sequentially run the `deploy` list of tasks specified in `.tomo/config.rb`. You can customize this list to meet the needs of your app. By default, tomo runs these tasks:
|
115
121
|
|
116
122
|
1. Create a release (using the [git:create_release](https://tomo-deploy.com/plugins/git#gitcreate_release) task)
|
117
123
|
2. Build the project (e.g. [bundler:install](https://tomo-deploy.com/plugins/bundler#bundlerinstall), [rails:assets_precompile](https://tomo-deploy.com/plugins/rails#railsassets_precompile))
|
@@ -120,7 +126,13 @@ Whereas `tomo setup` is typically run once, you can use `tomo deploy` every time
|
|
120
126
|
5. Restart the app to use the new current release (e.g. [puma:restart](https://tomo-deploy.com/plugins/puma#pumarestart))
|
121
127
|
6. Perform any cleanup (e.g. [bundler:clean](https://tomo-deploy.com/plugins/bundler#bundlerclean))
|
122
128
|
|
123
|
-
|
129
|
+
> 💡 **Protip:** you can abbreviate tomo commands, like `tomo d` for `tomo deploy` or `tomo s` for `tomo setup`.
|
130
|
+
|
131
|
+
[→ Here is the default list of tasks invoked by the deploy command.](https://tomo-deploy.com/configuration#deployblock)<br>
|
132
|
+
[→ The `tomo deploy` section of the reference docs explains supported command-line options, like `--dry-run`.](https://tomo-deploy.com/commands/deploy/)
|
133
|
+
|
134
|
+
|
135
|
+
### `tomo run [TASK]`
|
124
136
|
|
125
137
|
Tomo can also `run` individual remote tasks on demand. You can use the `tasks` command to see the list of tasks tomo knows about.
|
126
138
|
|
@@ -130,9 +142,15 @@ One of the built-in Rails tasks is `rails:console`, which brings up a fully-inte
|
|
130
142
|
|
131
143
|
![$ tomo run rails:console](./readme_images/tomo-run-rails-console.png)
|
132
144
|
|
133
|
-
|
145
|
+
> 💡 **Protip:** you can shorten this as `tomo rails:console` (the `run` command is implied).
|
146
|
+
|
147
|
+
[→ The `tomo run` section of the reference docs explains supported command-line options and has more examples.](https://tomo-deploy.com/commands/run/)
|
148
|
+
|
134
149
|
|
135
|
-
|
150
|
+
|
151
|
+
## Extending tomo
|
152
|
+
|
153
|
+
Tomo has a powerful plugin system that lets you extend tomo by installing Ruby gems (e.g. [tomo-plugin-sidekiq](https://github.com/mattbrictson/tomo-plugin-sidekiq)). You can also define plugins on the fly within your project by adding simple `.rb` files to `.tomo/plugins/`. These plugins can define tasks as plain ruby methods. For example:
|
136
154
|
|
137
155
|
```ruby
|
138
156
|
# .tomo/plugins/my-plugin.rb
|
@@ -142,8 +160,6 @@ def hello
|
|
142
160
|
end
|
143
161
|
```
|
144
162
|
|
145
|
-
Use `remote.run` to execute shell scripts on the remote host, similar to how you would use Ruby's `system`. Project settings are accessible via `settings`, which is a plain Ruby hash.
|
146
|
-
|
147
163
|
Load your plugin in `config.rb` like this:
|
148
164
|
|
149
165
|
```ruby
|
@@ -156,7 +172,9 @@ And run it!
|
|
156
172
|
|
157
173
|
![$ tomo run my-plugin:hello](./readme_images/tomo-run-hello.png)
|
158
174
|
|
159
|
-
|
175
|
+
[→ The **Writing Custom Tasks** tutorial has an in-depth explanation of how plugins work.](https://tomo-deploy.com/tutorials/writing-custom-tasks/)<br>
|
176
|
+
[→ The **TaskLibrary** API is tomo's DSL for building tasks.](https://tomo-deploy.com/api/TaskLibrary/)<br>
|
177
|
+
[→ The **Publishing a Plugin** tutorial explains how to package your plugin as a Ruby gem to share it with the community.](https://tomo-deploy.com/tutorials/publishing-a-plugin/)
|
160
178
|
|
161
179
|
## Tutorials
|
162
180
|
|
data/lib/tomo/commands/init.rb
CHANGED
@@ -99,6 +99,10 @@ module Tomo
|
|
99
99
|
Gem::Requirement.new(">= 2.2").satisfied_by?(erb_version)
|
100
100
|
end
|
101
101
|
|
102
|
+
def ruby_version_file?
|
103
|
+
File.exist?(".ruby-version")
|
104
|
+
end
|
105
|
+
|
102
106
|
def config_rb_template(app)
|
103
107
|
path = File.expand_path("../templates/config.rb.erb", __dir__)
|
104
108
|
template = IO.read(path)
|
@@ -31,8 +31,7 @@ module Tomo::Plugin::Rbenv
|
|
31
31
|
end
|
32
32
|
|
33
33
|
def compile_ruby
|
34
|
-
|
35
|
-
ruby_version = settings[:rbenv_ruby_version]
|
34
|
+
ruby_version = version_setting || extract_ruby_ver_from_version_file
|
36
35
|
|
37
36
|
unless ruby_installed?(ruby_version)
|
38
37
|
logger.info(
|
@@ -51,5 +50,20 @@ module Tomo::Plugin::Rbenv
|
|
51
50
|
end
|
52
51
|
false
|
53
52
|
end
|
53
|
+
|
54
|
+
def version_setting
|
55
|
+
settings[:rbenv_ruby_version]
|
56
|
+
end
|
57
|
+
|
58
|
+
def extract_ruby_ver_from_version_file
|
59
|
+
path = paths.release.join(".ruby-version")
|
60
|
+
version = remote.capture("cat", path, raise_on_error: false).strip
|
61
|
+
return version unless version.empty?
|
62
|
+
|
63
|
+
die <<~REASON
|
64
|
+
Could not guess ruby version from .ruby-version file.
|
65
|
+
Use the :rbenv_ruby_version setting to specify the version of ruby to install.
|
66
|
+
REASON
|
67
|
+
end
|
54
68
|
end
|
55
69
|
end
|
@@ -15,10 +15,10 @@ module Tomo
|
|
15
15
|
|
16
16
|
def assert_valid_executable!
|
17
17
|
result = begin
|
18
|
-
|
19
|
-
|
20
|
-
|
21
|
-
|
18
|
+
ChildProcess.execute(executable, "-V")
|
19
|
+
rescue StandardError => e
|
20
|
+
handle_bad_executable(e)
|
21
|
+
end
|
22
22
|
|
23
23
|
Tomo.logger.debug(result.output)
|
24
24
|
return if result.success? && supported?(result.output)
|
@@ -14,7 +14,9 @@ host "user@hostname.or.ip.address"
|
|
14
14
|
|
15
15
|
set application: <%= app.inspect %>
|
16
16
|
set deploy_to: "/var/www/%{application}"
|
17
|
+
<% unless ruby_version_file? -%>
|
17
18
|
set rbenv_ruby_version: <%= RUBY_VERSION.inspect %>
|
19
|
+
<% end -%>
|
18
20
|
set nodenv_node_version: <%= node_version&.inspect || "nil # FIXME" %>
|
19
21
|
set nodenv_yarn_version: <%= yarn_version.inspect %>
|
20
22
|
set git_url: <%= git_origin_url&.inspect || "nil # FIXME" %>
|
@@ -80,9 +80,9 @@ module Tomo
|
|
80
80
|
end
|
81
81
|
|
82
82
|
def build_image
|
83
|
-
|
84
|
-
|
85
|
-
|
83
|
+
tag = "tomo_testing:latest"
|
84
|
+
Local.capture("docker build --tag #{tag} #{build_dir}")
|
85
|
+
tag
|
86
86
|
end
|
87
87
|
|
88
88
|
def start_container
|
data/lib/tomo/version.rb
CHANGED
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: tomo
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.
|
4
|
+
version: 1.4.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Matt Brictson
|
8
8
|
autorequire:
|
9
9
|
bindir: exe
|
10
10
|
cert_chain: []
|
11
|
-
date: 2020-
|
11
|
+
date: 2020-10-28 00:00:00.000000000 Z
|
12
12
|
dependencies: []
|
13
13
|
description: Tomo is a feature-rich deployment tool that contains everything you need
|
14
14
|
to deploy a basic Rails app out of the box. It has an opinionated, production-tested
|