ferryboat 0.1.0 → 0.1.2

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.
Files changed (7) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +119 -20
  3. data/lib/ferryboat/cli.rb +0 -0
  4. data/lib/ferryboat/deployer.rb +0 -0
  5. data/lib/ferryboat/version.rb +1 -1
  6. metadata +5 -4
  7. data/LICENSE.txt +0 -21
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: b3e9221bee5ebbbe905afe36dfa757b7abc06eb3cdefb864923e6d6af240ad4f
4
- data.tar.gz: e4004406ecb9a0b0ccb73beadcbf172a08625d5549939fe8cba44dfd31f4c3c1
3
+ metadata.gz: acf7c7b501facc790dcfc02da30974c7ca0e0bc6f756ff5ae0a8eedfdac4baca
4
+ data.tar.gz: 3007ce3a3ceaeccb10dfc04b943b64e384f0da9e5ceebfac3107224ad673202f
5
5
  SHA512:
6
- metadata.gz: b0d9854ff37bba6cb8554bd62901da24358c362648083ad7f3f00a1ee44f481ff8f0aa4a69486e6c43a47e19e04ae1b74d7ba5ac6b4c5824822ae33883cdf25f
7
- data.tar.gz: a453639dee1289f74585f49033810f820d8d1cc9e8494384ef11571aef721e3235b5e129ec22ce8b331e29eef82f270a9df3ba573ec6f88efb2920145597fb33
6
+ metadata.gz: f0ef8c0b48dfa47ed6e8974998787ccf2052ac5824dc5d86289617c52fee8e70bcf248e0c970b59dfff6668ac490311d91e409d4819fadb7f197609745db9eb9
7
+ data.tar.gz: 874cd8a690a4fd14e58411f3528c5d1569f00c3f2d61465a12049092aaf8d10d1ede998f079afd1c42b39f7f9433c4e5d5c6709489117f43e8e65a9bba30337b
data/README.md CHANGED
@@ -1,43 +1,142 @@
1
- # Ferryboat
1
+ # Ferryboat ⚓️
2
2
 
3
- TODO: Delete this and the text below, and describe your gem
3
+ **Ferryboat** is a lightweight deployment tool built by **21tycoons** for teams who want **zero-downtime deployments** for marketing/static sites without the complexity of Kubernetes or heavyweight DevOps stacks.
4
4
 
5
- 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/ferryboat`. To experiment with that code, run `bin/console` for an interactive prompt.
5
+ It’s designed for marketing sites, micro-apps, and fast-moving projects that need **confidence in production** while staying **simple, portable, and developer-friendly**.
6
6
 
7
- ## Installation
7
+ ---
8
8
 
9
- TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
9
+ ## ✨ Features
10
10
 
11
- Install the gem and add to the application's Gemfile by executing:
11
+ - **Zero-downtime deployments** (blue/green swap, even on a single server)
12
+ - **Staging environments baked in**
13
+ - **Lightweight backups** of container volumes
14
+ - **GitHub integration** for pulling and building images
15
+ - **Simple CLI** powered by Thor
16
+ - **Config-driven** via `ferryboat.yml`
17
+
18
+ ---
19
+
20
+ ## 📦 Installation
21
+
22
+ Add to your Gemfile:
23
+
24
+ ```ruby
25
+ gem "ferryboat"
26
+ ```
27
+
28
+ Or install directly:
29
+
30
+ ```bash
31
+ gem install ferryboat
32
+ ```
33
+
34
+ ---
35
+
36
+ ## 🚀 Usage
37
+
38
+ ### Create a new project
39
+
40
+ ```bash
41
+ ferryboat new mysite
42
+ cd mysite
43
+ ```
44
+
45
+ ### Deploy to production (zero downtime)
46
+
47
+ ```bash
48
+ ferryboat deploy
49
+ ```
50
+
51
+ ### Deploy to staging
52
+
53
+ ```bash
54
+ ferryboat deploy --staging
55
+ ```
56
+
57
+ ### Backup before deploy
58
+
59
+ ```bash
60
+ ferryboat backup
61
+ ```
62
+
63
+ ### Restore a backup
12
64
 
13
65
  ```bash
14
- bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
66
+ ferryboat restore
15
67
  ```
16
68
 
17
- If bundler is not being used to manage dependencies, install the gem by executing:
69
+ ### View logs
18
70
 
19
71
  ```bash
20
- gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
72
+ ferryboat logs
21
73
  ```
22
74
 
23
- ## Usage
75
+ ---
76
+
77
+ ## ⚙️ Configuration
24
78
 
25
- TODO: Write usage instructions here
79
+ Example `ferryboat.yml`:
80
+
81
+ ```yaml
82
+ production:
83
+ server: 203.0.113.42
84
+ ssh_key: ~/.ssh/myserver
85
+ repo: git@github.com:21tycoons/mysite.git
86
+ docker_registry: 21tycoons/mysite
87
+ domain: mysite.com
88
+
89
+ staging:
90
+ server: 203.0.113.42
91
+ ssh_key: ~/.ssh/myserver
92
+ repo: git@github.com:21tycoons/mysite.git
93
+ docker_registry: 21tycoons/mysite-staging
94
+ domain: staging.mysite.com
95
+ ```
26
96
 
27
- ## Development
97
+ Secrets (like Docker or GitHub tokens) should be set as environment variables.
98
+
99
+ ---
100
+
101
+ ## 🛠 Development
102
+
103
+ After checking out the repo:
104
+
105
+ ```bash
106
+ bin/setup
107
+ ```
108
+
109
+ Run tests with:
110
+
111
+ ```bash
112
+ rake spec
113
+ ```
114
+
115
+ Try the interactive console:
116
+
117
+ ```bash
118
+ bin/console
119
+ ```
120
+
121
+ Release a new version:
122
+
123
+ ```bash
124
+ bundle exec rake release
125
+ ```
28
126
 
29
- 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.
127
+ ---
30
128
 
31
- 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 the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
129
+ ## 🤝 Contributing
32
130
 
33
- ## Contributing
131
+ Bug reports and pull requests are welcome at
132
+ 👉 [https://github.com/21tycoons/ferryboat](https://github.com/21tycoons/ferryboat)
34
133
 
35
- Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/ferryboat. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/ferryboat/blob/main/CODE_OF_CONDUCT.md).
134
+ ---
36
135
 
37
- ## License
136
+ ## 📜 License
38
137
 
39
- The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
138
+ Released under the MIT License. See [LICENSE](LICENSE) for details.
40
139
 
41
- ## Code of Conduct
140
+ ---
42
141
 
43
- Everyone interacting in the Ferryboat project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/ferryboat/blob/main/CODE_OF_CONDUCT.md).
142
+ 🚢 **Ferryboat by 21tycoons** — simple, safe deployments without the complexity.
data/lib/ferryboat/cli.rb ADDED
File without changes
data/lib/ferryboat/deployer.rb ADDED
File without changes
data/lib/ferryboat/version.rb CHANGED
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module Ferryboat
4
- VERSION = "0.1.0"
4
+ VERSION = "0.1.2"
5
5
  end
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: ferryboat
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.1.0
4
+ version: 0.1.2
5
5
  platform: ruby
6
6
  authors:
7
7
  - 21tycoons
@@ -38,7 +38,7 @@ dependencies:
38
38
  - !ruby/object:Gem::Version
39
39
  version: '1.0'
40
40
  description: |
41
- Ferryboat is a deployment solution focused on simplicity and reliability.
41
+ Ferryboat is a deployment solution for marketing/static sites focused on simplicity and reliability.
42
42
  It supports zero-downtime rollouts, staging environments, and basic volume
43
43
  backups. Designed to work with Docker and SSH, it helps teams deliver code
44
44
  safely to production without unnecessary complexity.
@@ -48,9 +48,10 @@ executables: []
48
48
  extensions: []
49
49
  extra_rdoc_files: []
50
50
  files:
51
- - LICENSE.txt
52
51
  - README.md
53
52
  - lib/ferryboat.rb
53
+ - lib/ferryboat/cli.rb
54
+ - lib/ferryboat/deployer.rb
54
55
  - lib/ferryboat/version.rb
55
56
  homepage: https://github.com/21tycoons/ferryboat
56
57
  licenses:
@@ -72,5 +73,5 @@ required_rubygems_version: !ruby/object:Gem::Requirement
72
73
  requirements: []
73
74
  rubygems_version: 3.6.5
74
75
  specification_version: 4
75
- summary: Lightweight zero-downtime deployment tool.
76
+ summary: Lightweight zero-downtime deployment tool for marketing/static sites.
76
77
  test_files: []
data/LICENSE.txt DELETED
@@ -1,21 +0,0 @@
1
- The MIT License (MIT)
2
-
3
- Copyright (c) 2025 TODO: Write your name
4
-
5
- Permission is hereby granted, free of charge, to any person obtaining a copy
6
- of this software and associated documentation files (the "Software"), to deal
7
- in the Software without restriction, including without limitation the rights
8
- to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
- copies of the Software, and to permit persons to whom the Software is
10
- furnished to do so, subject to the following conditions:
11
-
12
- The above copyright notice and this permission notice shall be included in
13
- all copies or substantial portions of the Software.
14
-
15
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
- IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
- FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
- AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
- LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
- OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21
- THE SOFTWARE.