shiplane 0.1.11 → 0.1.12
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +9 -3
- data/lib/shiplane/checkout_artifact.rb +1 -0
- data/lib/shiplane/version.rb +1 -1
- metadata +6 -6
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 1591dbd040e2a6e98f4e30902db96a2172fc77834ea1932dc9d81fc690d728c1
|
4
|
+
data.tar.gz: dc9b146b77075a18a36a694fc49a2a756b6197ce9d172201ee15204770f47d08
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 7a619260852c0cab02dd798d897a85340ee31b9b03fb5a8ead16b07b623a97fd300332428f779d72beecd3fbe5840eb79a333cdff6e34d988740d59e9ab7a20f
|
7
|
+
data.tar.gz: 28b2e1e9e5f070ec63667754070a94a32f65f56232acacbc9a4eeffc9cbe2dbabf11958dff6e00553f7f6702a6d5e2c818b5135b71306ab7e69ea14195447c49
|
data/README.md
CHANGED
@@ -73,6 +73,8 @@ You can generate a default version of this file via the following command:
|
|
73
73
|
rake shiplane:install[<application_name>]
|
74
74
|
```
|
75
75
|
|
76
|
+
Reference the example [shiplane.ymls](examples/rails_app/shiplane.yml) for some ideas on how to configure your app.
|
77
|
+
|
76
78
|
### Using Shiplane
|
77
79
|
#### Steps involved in provisioning and deploying
|
78
80
|
Currently, Shiplane assumes you have an empty VM/VPS/Metal Box with some form of linux on it (though testing has primarily been done on Ubuntu boxes). Shiplane assumes an otherwise EMPTY install. It is HIGHLY recommended that you NOT use Shiplane (or any other provisioning) on an install with software other than a basic OS installed.
|
@@ -107,6 +109,8 @@ Shiplane provides rake tasks that may be used to build your Docker containers in
|
|
107
109
|
|
108
110
|
It is intended that this be integrated into your CI pipeline and some examples are provided (Currently, we provide an example for Circle CI).
|
109
111
|
|
112
|
+
Configuration for building is provided by the `shiplane.yml` file that has already been mentioned and any files in the `.shiplane` folder. Under this folder, any files under `insert_on_build` will be inserted into you application structure during the build process. e.g. in the [rails_app](examples/rails_app) example, the config folder will be inserted into the docker container during the build process. ERB files can be evaluated by shiplane to provide files with keys or other such things inserted. The `production_dockerfile_stages` file under the `.shiplane` folder utilizes docker's multistage building technique to take your local dockerfile and append new stages that give you the chance to perform any pre-production stages you might need. See the [example](examples/rails_app/.shiplane/production_dockerfile_stages) for a sample of what you might do yourself.
|
113
|
+
|
110
114
|
You can build a docker container based on the HEAD of your current branch like so:
|
111
115
|
```sh
|
112
116
|
bundle exec cap production shiplane
|
@@ -118,6 +122,7 @@ Shiplane provides tasks to help you deploy your code. These tasks depend on your
|
|
118
122
|
Currently, the following Deployers are provided:
|
119
123
|
- shiplane_deployers_capistrano_docker `# Uses Capistrano and Raw Docker to run your containers`
|
120
124
|
|
125
|
+
The Capistrano deployer uses Capistrano's configuration. You can see an example of how this works under the [examples folder](examples/rails_app/config/deploy.rb)
|
121
126
|
|
122
127
|
You can run a deployment like so:
|
123
128
|
```sh
|
@@ -130,7 +135,7 @@ This is as much a reminder to me as anyone else. If a new version of the gem has
|
|
130
135
|
bundle install --full-index
|
131
136
|
```
|
132
137
|
|
133
|
-
##### `Could not load database configuration. No such file - ["config/database.yml"]`
|
138
|
+
##### [Rails Application] `Could not load database configuration. No such file - ["config/database.yml"]`
|
134
139
|
If you are receiving similar messages during the build process, this likely means that you are running a task during the build (e.g. asset precompilation) that is loading up the Rails initializers and have an initializer that tries to connect to the database. You can fix this by finding which of your initializers is being called. See this snippet here from an app that shows where you would find the offending initializer:
|
135
140
|
```
|
136
141
|
/var/www/surveyor/vendor/bundle/ruby/2.6.0/gems/zeitwerk-2.1.6/lib/zeitwerk/kernel.rb:23:in `require'
|
@@ -155,17 +160,18 @@ Shiplane::SafeBuild.wrap do
|
|
155
160
|
belongs_to :true_owner, polymorphic: true
|
156
161
|
end
|
157
162
|
end
|
158
|
-
|
159
163
|
```
|
160
164
|
|
161
165
|
## Becoming Involved
|
162
166
|
### Community Channels
|
163
|
-
You can join our [Discord community](https://discord.gg/drrn2YG) to ask any questions you might have or to get ahold of someone in the community who might be able to help you. There is no guarantee of service implied, but we absolutely believe in helping out our fellow developers and will do so as we are able. If you feel you know some stuff about Shiplane, feel free to hang out and please help out as well!
|
167
|
+
You can join our [Discord community](https://discord.gg/drrn2YG) to ask any questions you might have or to get ahold of someone in the community who might be able to help you (I hang out here just about every day of the week and most of the weekend). There is no guarantee of service implied, but we absolutely believe in helping out our fellow developers and will do so as we are able. If you feel you know some stuff about Shiplane, feel free to hang out and please help out as well!
|
164
168
|
|
165
169
|
### Contributing
|
166
170
|
|
167
171
|
We highly encourage you to contribute to Shiplane! Check out the [Contribution Guidelines](CONTRIBUTING.md) and help make Shiplane better!
|
168
172
|
|
173
|
+
Everyone interacting in Shiplane's codebase, issue trackers, and chatroom is expected to follow the [Code of Conduct](CODE_OF_CONDUCT.md)
|
174
|
+
|
169
175
|
### Security Concerns
|
170
176
|
If you have a security concern with Shiplane, please follow our Security Policy guidelines to submit the issue to us.
|
171
177
|
|
data/lib/shiplane/version.rb
CHANGED
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: shiplane
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.1.
|
4
|
+
version: 0.1.12
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- John Epperson
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2019-
|
11
|
+
date: 2019-08-02 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: shiplane_bootstrappers_chef
|
@@ -16,28 +16,28 @@ dependencies:
|
|
16
16
|
requirements:
|
17
17
|
- - '='
|
18
18
|
- !ruby/object:Gem::Version
|
19
|
-
version: 0.1.
|
19
|
+
version: 0.1.12
|
20
20
|
type: :runtime
|
21
21
|
prerelease: false
|
22
22
|
version_requirements: !ruby/object:Gem::Requirement
|
23
23
|
requirements:
|
24
24
|
- - '='
|
25
25
|
- !ruby/object:Gem::Version
|
26
|
-
version: 0.1.
|
26
|
+
version: 0.1.12
|
27
27
|
- !ruby/object:Gem::Dependency
|
28
28
|
name: shiplane_deployers_capistrano_docker
|
29
29
|
requirement: !ruby/object:Gem::Requirement
|
30
30
|
requirements:
|
31
31
|
- - '='
|
32
32
|
- !ruby/object:Gem::Version
|
33
|
-
version: 0.1.
|
33
|
+
version: 0.1.12
|
34
34
|
type: :runtime
|
35
35
|
prerelease: false
|
36
36
|
version_requirements: !ruby/object:Gem::Requirement
|
37
37
|
requirements:
|
38
38
|
- - '='
|
39
39
|
- !ruby/object:Gem::Version
|
40
|
-
version: 0.1.
|
40
|
+
version: 0.1.12
|
41
41
|
- !ruby/object:Gem::Dependency
|
42
42
|
name: dotenv
|
43
43
|
requirement: !ruby/object:Gem::Requirement
|