kettle-dev 1.0.0
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 +7 -0
- checksums.yaml.gz.sig +2 -0
- data/CHANGELOG.md +47 -0
- data/CITATION.cff +20 -0
- data/CODE_OF_CONDUCT.md +134 -0
- data/CONTRIBUTING.md +149 -0
- data/LICENSE.txt +21 -0
- data/README.md +661 -0
- data/REEK +0 -0
- data/RUBOCOP.md +71 -0
- data/SECURITY.md +21 -0
- data/checksums/kettle-dev-1.0.0.gem.sha256 +1 -0
- data/checksums/kettle-dev-1.0.0.gem.sha512 +1 -0
- data/lib/kettle/dev/ci_helpers.rb +171 -0
- data/lib/kettle/dev/tasks.rb +8 -0
- data/lib/kettle/dev/template_helpers.rb +290 -0
- data/lib/kettle/dev/version.rb +12 -0
- data/lib/kettle/dev.rb +108 -0
- data/lib/kettle/emoji_regex.rb +15 -0
- data/lib/kettle-dev.rb +23 -0
- data/sig/kettle/dev/ci_helpers.rbs +29 -0
- data/sig/kettle/dev/template_helpers.rbs +70 -0
- data/sig/kettle/dev.rbs +19 -0
- data.tar.gz.sig +3 -0
- metadata +267 -0
- metadata.gz.sig +0 -0
data/README.md
ADDED
@@ -0,0 +1,661 @@
|
|
1
|
+
[![Galtzo FLOSS Logo by Aboling0, CC BY-SA 4.0][🖼️galtzo-i]][🖼️galtzo-discord] [![ruby-lang Logo, Yukihiro Matsumoto, Ruby Visual Identity Team, CC BY-SA 2.5][🖼️ruby-lang-i]][🖼️ruby-lang] [![kettle-dev Logo by Aboling0, CC BY-SA 4.0][🖼️kettle-dev-i]][🖼️kettle-dev]
|
2
|
+
|
3
|
+
[🖼️galtzo-i]: https://logos.galtzo.com/assets/images/galtzo-floss/avatar-192px.svg
|
4
|
+
[🖼️galtzo-discord]: https://discord.gg/3qme4XHNKN
|
5
|
+
[🖼️ruby-lang-i]: https://logos.galtzo.com/assets/images/ruby-lang/avatar-192px.svg
|
6
|
+
[🖼️ruby-lang]: https://www.ruby-lang.org/
|
7
|
+
[🖼️kettle-dev-i]: https://logos.galtzo.com/assets/images/kettle-rb/kettle-dev/avatar-192px.svg
|
8
|
+
[🖼️kettle-dev]: https://github.com/kettle-rb/kettle-dev
|
9
|
+
|
10
|
+
# 🍲 Kettle::Dev
|
11
|
+
|
12
|
+
[![Version][👽versioni]][👽version] [![License: MIT][📄license-img]][📄license-ref] [![Downloads Rank][👽dl-ranki]][👽dl-rank] [![Open Source Helpers][👽oss-helpi]][👽oss-help] [![CodeCov Test Coverage][🔑codecovi]][🔑codecov] [![Coveralls Test Coverage][🔑coveralls-img]][🔑coveralls] [![QLTY Test Coverage][🔑qlty-covi]][🔑qlty-cov] [![QLTY Maintainability][🔑qlty-mnti]][🔑qlty-mnt] [![CI Heads][🚎3-hd-wfi]][🚎3-hd-wf] [![CI Current][🚎11-c-wfi]][🚎11-c-wf] [![CI Truffle Ruby][🚎9-t-wfi]][🚎9-t-wf] [![CI JRuby][🚎10-j-wfi]][🚎10-j-wf] [![Deps Locked][🚎13-🔒️-wfi]][🚎13-🔒️-wf] [![Deps Unlocked][🚎14-🔓️-wfi]][🚎14-🔓️-wf] [![CI Supported][🚎6-s-wfi]][🚎6-s-wf] [![CI Legacy][🚎4-lg-wfi]][🚎4-lg-wf] [![CI Unsupported][🚎7-us-wfi]][🚎7-us-wf] [![CI Ancient][🚎1-an-wfi]][🚎1-an-wf] [![CI Test Coverage][🚎2-cov-wfi]][🚎2-cov-wf] [![CI Style][🚎5-st-wfi]][🚎5-st-wf]
|
13
|
+
|
14
|
+
If ☝️ `ci_badges.map(&:color).detect { it != "green"}` [let me know][🖼️galtzo-discord], as I may have missed the [discord notification][🖼️galtzo-discord].
|
15
|
+
|
16
|
+
---
|
17
|
+
|
18
|
+
OTOH, if `ci_badges.map(&:color).all? { it == "green"}` 👇️ send money so I can do more of this. FLOSS is now my full-time job.
|
19
|
+
|
20
|
+
[![Liberapay Goal Progress][⛳liberapay-img]][⛳liberapay] [![Sponsor Me on Github][🖇sponsor-img]][🖇sponsor] [![Buy me a coffee][🖇buyme-small-img]][🖇buyme] [![Donate on Polar][🖇polar-img]][🖇polar] [![Donate to my FLOSS or refugee efforts at ko-fi.com][🖇kofi-img]][🖇kofi] [![Donate to my FLOSS or refugee efforts using Patreon][🖇patreon-img]][🖇patreon]
|
21
|
+
|
22
|
+
## 🌻 Synopsis
|
23
|
+
|
24
|
+
Add to your `Rakefile`:
|
25
|
+
|
26
|
+
```ruby
|
27
|
+
require "kettle/dev"
|
28
|
+
Kettle::Dev.install_tasks
|
29
|
+
```
|
30
|
+
|
31
|
+
Now you have many powerful development and testing tools at your disposal, all fully [documented](#-configuration) and tested.
|
32
|
+
|
33
|
+
I expect the current release of this gem to be compatible with Ruby 2.3+,
|
34
|
+
and concordant releases of JRuby, and TruffleRuby.
|
35
|
+
|
36
|
+
| 🚚 _Amazing_ test matrix was brought to you by | 🔎 appraisal2 🔎 |
|
37
|
+
|------------------------------------------------|-------------------------------------------------------------------------------------|
|
38
|
+
| 👟 Check it out! | ✨ [github.com/appraisal-rb/appraisal2][💎appraisal2] ✨ |
|
39
|
+
|
40
|
+
## 💡 Info you can shake a stick at
|
41
|
+
|
42
|
+
### Federated DVCS
|
43
|
+
|
44
|
+
<details>
|
45
|
+
<summary>Find this repo on other forges (Coming soon!)</summary>
|
46
|
+
|
47
|
+
| Federated [DVCS][💎d-in-dvcs] Repository | Status | Issues | PRs | Wiki | CI | Discussions |
|
48
|
+
|-------------------------------------------------------|-------------------------------------------------------------------|---------------------------|--------------------------|---------------------------|--------------------------|------------------------------|
|
49
|
+
| 🧪 [kettle-rb/kettle-dev on GitLab][📜src-gl] | The Truth | [💚][🤝gl-issues] | [💚][🤝gl-pulls] | [💚][📜wiki] | 🏀 Tiny Matrix | ➖ |
|
50
|
+
| 🧊 [kettle-rb/kettle-dev on CodeBerg][📜src-cb] | An Ethical Mirror ([Donate][🤝cb-donate]) | [💚][🤝cb-issues] | [💚][🤝cb-pulls] | ➖ | ⭕️ No Matrix | ➖ |
|
51
|
+
| 🐙 [kettle-rb/kettle-dev on GitHub][📜src-gh] | A Dirty Mirror | [💚][🤝gh-issues] | [💚][🤝gh-pulls] | ➖ | 💯 Full Matrix | [💚][gh-discussions] |
|
52
|
+
| 🎮️ [Discord Server][✉️discord-invite] | [![Live Chat on Discord][✉️discord-invite-img]][✉️discord-invite] | [Let's][✉️discord-invite] | [talk][✉️discord-invite] | [about][✉️discord-invite] | [this][✉️discord-invite] | [library!][✉️discord-invite] |
|
53
|
+
|
54
|
+
</details>
|
55
|
+
|
56
|
+
[gh-discussions]: https://github.com/kettle-rb/kettle-dev/discussions
|
57
|
+
|
58
|
+
### Enterprise Support [](https://tidelift.com/subscription/pkg/rubygems-kettle-dev?utm_source=rubygems-kettle-dev&utm_medium=referral&utm_campaign=readme)
|
59
|
+
|
60
|
+
<details>
|
61
|
+
<summary>Need enterprise-level guarantees?</summary>
|
62
|
+
|
63
|
+
[![Get help from me on Tidelift][🏙️entsup-tidelift-img]][🏙️entsup-tidelift]
|
64
|
+
|
65
|
+
- 💡Subscribe for support guarantees covering _all_ FLOSS dependencies
|
66
|
+
- 💡Tidelift is part of [Sonar][🏙️entsup-tidelift-sonar]
|
67
|
+
- 💡Tidelift pays maintainers to maintain the software you depend on!<br/>📊`@`Pointy Haired Boss: An [enterprise support][🏙️entsup-tidelift] subscription is "[never gonna let you down][🧮kloc]", and *supports* open source maintainers
|
68
|
+
|
69
|
+
Alternatively:
|
70
|
+
|
71
|
+
- [![Live Chat on Discord][✉️discord-invite-img]][✉️discord-invite]
|
72
|
+
- [![Get help from me on Upwork][👨🏼🏫expsup-upwork-img]][👨🏼🏫expsup-upwork]
|
73
|
+
- [![Get help from me on Codementor][👨🏼🏫expsup-codementor-img]][👨🏼🏫expsup-codementor]
|
74
|
+
|
75
|
+
</details>
|
76
|
+
|
77
|
+
| Tokens to Remember | [![Gem name][⛳️name-img]][⛳️gem-name] [![Gem namespace][⛳️namespace-img]][⛳️gem-namespace] |
|
78
|
+
|-------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
79
|
+
| Works with JRuby | ![JRuby 9.1 Compat][💎jruby-9.1i] ![JRuby 9.2 Compat][💎jruby-9.2i] ![JRuby 9.3 Compat][💎jruby-9.3i] <br/> [![JRuby 9.4 Compat][💎jruby-9.4i]][🚎10-j-wf] [![JRuby 10.0 Compat][💎jruby-c-i]][🚎11-c-wf] [![JRuby HEAD Compat][💎jruby-headi]][🚎3-hd-wf] |
|
80
|
+
| Works with Truffle Ruby | ![Truffle Ruby 22.3 Compat][💎truby-22.3i] <br/> [![Truffle Ruby 23.0 Compat][💎truby-23.0i]][🚎9-t-wf] [![Truffle Ruby 23.1 Compat][💎truby-23.1i]][🚎9-t-wf] [![Truffle Ruby 24.1 Compat][💎truby-c-i]][🚎11-c-wf] |
|
81
|
+
| Works with MRI Ruby 3 | [![Ruby 3.0 Compat][💎ruby-3.0i]][🚎4-lg-wf] [![Ruby 3.1 Compat][💎ruby-3.1i]][🚎6-s-wf] [![Ruby 3.2 Compat][💎ruby-3.2i]][🚎6-s-wf] [![Ruby 3.3 Compat][💎ruby-3.3i]][🚎6-s-wf] [![Ruby 3.4 Compat][💎ruby-c-i]][🚎11-c-wf] [![Ruby HEAD Compat][💎ruby-headi]][🚎3-hd-wf] |
|
82
|
+
| Works with MRI Ruby 2 | ![Ruby 2.0 Compat][💎ruby-2.0i] ![Ruby 2.1 Compat][💎ruby-2.1i] ![Ruby 2.2 Compat][💎ruby-2.2i] <br/> [![Ruby 2.3 Compat][💎ruby-2.3i]][🚎1-an-wf] [![Ruby 2.4 Compat][💎ruby-2.4i]][🚎1-an-wf] [![Ruby 2.5 Compat][💎ruby-2.5i]][🚎1-an-wf] [![Ruby 2.6 Compat][💎ruby-2.6i]][🚎7-us-wf] [![Ruby 2.7 Compat][💎ruby-2.7i]][🚎7-us-wf] |
|
83
|
+
| Works with MRI Ruby 1 | ![Ruby 1.9 Compat][💎ruby-1.9i] |
|
84
|
+
| Source | [![Source on GitLab.com][📜src-gl-img]][📜src-gl] [![Source on CodeBerg.org][📜src-cb-img]][📜src-cb] [![Source on Github.com][📜src-gh-img]][📜src-gh] [![The best SHA: dQw4w9WgXcQ!][🧮kloc-img]][🧮kloc] |
|
85
|
+
| Documentation | [![Current release on RubyDoc.info][📜docs-cr-rd-img]][🚎yard-current] [![YARD on Galtzo.com][📜docs-head-rd-img]][🚎yard-head] [![Maintainer Blog][🚂maint-blog-img]][🚂maint-blog] [![Wiki][📜wiki-img]][📜wiki] |
|
86
|
+
| Compliance | [![License: MIT][📄license-img]][📄license-ref] [![📄ilo-declaration-img]][📄ilo-declaration] [![Security Policy][🔐security-img]][🔐security] [![Contributor Covenant 2.1][🪇conduct-img]][🪇conduct] [![SemVer 2.0.0][📌semver-img]][📌semver] |
|
87
|
+
| Style | [![Enforced Code Style Linter][💎rlts-img]][💎rlts] [![Keep-A-Changelog 1.0.0][📗keep-changelog-img]][📗keep-changelog] [![Gitmoji Commits][📌gitmoji-img]][📌gitmoji] [![Compatibility appraised by: appraisal2][💎appraisal2-img]][💎appraisal2] |
|
88
|
+
| Support | [![Live Chat on Discord][✉️discord-invite-img]][✉️discord-invite] [![Get help from me on Upwork][👨🏼🏫expsup-upwork-img]][👨🏼🏫expsup-upwork] [![Get help from me on Codementor][👨🏼🏫expsup-codementor-img]][👨🏼🏫expsup-codementor] |
|
89
|
+
| Maintainer 🎖️ | [![Follow Me on LinkedIn][💖🖇linkedin-img]][💖🖇linkedin] [![Follow Me on Ruby.Social][💖🐘ruby-mast-img]][💖🐘ruby-mast] [![Follow Me on Bluesky][💖🦋bluesky-img]][💖🦋bluesky] [![Contact Maintainer][🚂maint-contact-img]][🚂maint-contact] [![My technical writing][💖💁🏼♂️devto-img]][💖💁🏼♂️devto] |
|
90
|
+
| `...` 💖 | [![Find Me on WellFound:][💖✌️wellfound-img]][💖✌️wellfound] [![Find Me on CrunchBase][💖💲crunchbase-img]][💖💲crunchbase] [![My LinkTree][💖🌳linktree-img]][💖🌳linktree] [![More About Me][💖💁🏼♂️aboutme-img]][💖💁🏼♂️aboutme] [🧊][💖🧊berg] [🐙][💖🐙hub] [🛖][💖🛖hut] [🧪][💖🧪lab] |
|
91
|
+
|
92
|
+
## ✨ Installation
|
93
|
+
|
94
|
+
Install the gem and add to the application's Gemfile by executing:
|
95
|
+
|
96
|
+
$ bundle add kettle-dev
|
97
|
+
|
98
|
+
If bundler is not being used to manage dependencies, install the gem by executing:
|
99
|
+
|
100
|
+
$ gem install kettle-dev
|
101
|
+
|
102
|
+
### 🔒 Secure Installation
|
103
|
+
|
104
|
+
<details>
|
105
|
+
<summary>For Medium or High Security Installations</summary>
|
106
|
+
|
107
|
+
This gem is cryptographically signed, and has verifiable [SHA-256 and SHA-512][💎SHA_checksums] checksums by
|
108
|
+
[stone_checksums][💎stone_checksums]. Be sure the gem you install hasn’t been tampered with
|
109
|
+
by following the instructions below.
|
110
|
+
|
111
|
+
Add my public key (if you haven’t already, expires 2045-04-29) as a trusted certificate:
|
112
|
+
|
113
|
+
```console
|
114
|
+
gem cert --add <(curl -Ls https://raw.github.com/galtzo-floss/certs/main/pboling.pem)
|
115
|
+
```
|
116
|
+
|
117
|
+
You only need to do that once. Then proceed to install with:
|
118
|
+
|
119
|
+
```console
|
120
|
+
gem install kettle-dev -P HighSecurity
|
121
|
+
```
|
122
|
+
|
123
|
+
The `HighSecurity` trust profile will verify signed gems, and not allow the installation of unsigned dependencies.
|
124
|
+
|
125
|
+
If you want to up your security game full-time:
|
126
|
+
|
127
|
+
```console
|
128
|
+
bundle config set --global trust-policy MediumSecurity
|
129
|
+
```
|
130
|
+
|
131
|
+
`MediumSecurity` instead of `HighSecurity` is necessary if not all the gems you use are signed.
|
132
|
+
|
133
|
+
NOTE: Be prepared to track down certs for signed gems and add them the same way you added mine.
|
134
|
+
|
135
|
+
</details>
|
136
|
+
|
137
|
+
## ⚙️ Configuration
|
138
|
+
|
139
|
+
Add to your `Rakefile`:
|
140
|
+
|
141
|
+
```ruby
|
142
|
+
require "kettle/dev"
|
143
|
+
Kettle::Dev.install_tasks
|
144
|
+
```
|
145
|
+
|
146
|
+
That’s it. When installed, kettle-dev:
|
147
|
+
- Registers RuboCop-LTS tasks and wires your default Rake task to run the gradual linter.
|
148
|
+
- Locally: default task prefers `rubocop_gradual:autocorrect`.
|
149
|
+
- On CI (`CI=true`): default task prefers `rubocop_gradual:check`.
|
150
|
+
- Integrates optional coverage tasks via kettle-soup-cover (enabled locally when present).
|
151
|
+
- Adds gem-shipped Rake tasks from `lib/kettle/dev/rakelib`, including:
|
152
|
+
- `ci:act` — interactive selector for running GitHub Actions workflows via `act`.
|
153
|
+
- `kettle:dev:install` — copies this repo’s .github automation and offers to install .git-hooks templates.
|
154
|
+
- option: force: When truthy (1, true, y, yes), treat all y/N prompts as Yes. Useful for non-interactive runs or to accept defaults quickly. Example: `bundle exec rake kettle:dev:template force=true`
|
155
|
+
- option: allowed: When truthy (1, true, y, yes), resume task after you have reviewed `.envrc`/`.env.local` and run `direnv allow`. If either file is created or updated, the task will abort with instructions unless `allowed=true` is present. Example: `bundle exec rake kettle:dev:install allowed=true`
|
156
|
+
- `kettle:dev:template` — templates files from this gem into your project (e.g., .github workflows, .devcontainer, .qlty, modular Gemfiles, README/CONTRIBUTING stubs). You can run this independently to refresh templates without the extra install prompts.
|
157
|
+
- option: force: When truthy (1, true, y, yes), treat all y/N prompts as Yes. Useful for non-interactive runs or to accept defaults quickly. Example: `bundle exec rake kettle:dev:template force=true`
|
158
|
+
- option: allowed: When truthy (1, true, y, yes), resume task after you have reviewed `.envrc`/`.env.local` and run `direnv allow`. If either file is created or updated, the task will abort with instructions unless `allowed=true` is present. Example: `bundle exec rake kettle:dev:template allowed=true`
|
159
|
+
|
160
|
+
Recommended one-time setup in your project:
|
161
|
+
- Install binstubs so kettle-dev executables are available under `./bin`:
|
162
|
+
- `bundle binstubs kettle-dev --path bin`
|
163
|
+
- Use direnv (recommended) so `./bin` is on PATH automatically:
|
164
|
+
- `brew install direnv`
|
165
|
+
- In your project’s `.envrc` add:
|
166
|
+
- `# Run any command in this library's bin/ without the bin/ prefix!`
|
167
|
+
- `PATH_add bin`
|
168
|
+
- Configure shared git hooks path (optional, recommended):
|
169
|
+
- `git config --global core.hooksPath .git-hooks`
|
170
|
+
- Install project automation and sample hooks/templates:
|
171
|
+
- `bundle exec rake kettle:dev:install` and follow prompts (copies .github and installs .git-hooks templates locally or globally).
|
172
|
+
|
173
|
+
See the next section for environment variables that tweak behavior.
|
174
|
+
|
175
|
+
### Environment Variables
|
176
|
+
|
177
|
+
Below are the primary environment variables recognized by kettle-dev (and its integrated tools). Unless otherwise noted, set boolean values to the string "true" to enable.
|
178
|
+
|
179
|
+
General/runtime
|
180
|
+
- DEBUG: Enable extra internal logging for this library (default: false)
|
181
|
+
- REQUIRE_BENCH: Enable `require_bench` to profile requires (default: false)
|
182
|
+
- CI: When set to true, adjusts default rake tasks toward CI behavior
|
183
|
+
|
184
|
+
Coverage (kettle-soup-cover / SimpleCov)
|
185
|
+
- K_SOUP_COV_DO: Enable coverage collection (default: true in .envrc)
|
186
|
+
- K_SOUP_COV_FORMATTERS: Comma-separated list of formatters (html, xml, rcov, lcov, json, tty)
|
187
|
+
- K_SOUP_COV_MIN_LINE: Minimum line coverage threshold (integer, e.g., 100)
|
188
|
+
- K_SOUP_COV_MIN_BRANCH: Minimum branch coverage threshold (integer, e.g., 100)
|
189
|
+
- K_SOUP_COV_MIN_HARD: Fail the run if thresholds are not met (true/false)
|
190
|
+
- K_SOUP_COV_MULTI_FORMATTERS: Enable multiple formatters at once (true/false)
|
191
|
+
- K_SOUP_COV_OPEN_BIN: Path to browser opener for HTML (empty disables auto-open)
|
192
|
+
- MAX_ROWS: Limit console output rows for simplecov-console (e.g., 1)
|
193
|
+
Tip: When running a single spec file locally, you may want `K_SOUP_COV_MIN_HARD=false` to avoid failing thresholds for a partial run.
|
194
|
+
|
195
|
+
GitHub API and CI helpers
|
196
|
+
- GITHUB_TOKEN or GH_TOKEN: Token used by `ci:act` and release workflow checks to query GitHub Actions status at higher rate limits
|
197
|
+
|
198
|
+
Releasing and signing
|
199
|
+
- SKIP_GEM_SIGNING: If set, skip gem signing during build/release
|
200
|
+
- GEM_CERT_USER: Username for selecting your public cert in `certs/<USER>.pem` (defaults to $USER)
|
201
|
+
- SOURCE_DATE_EPOCH: Reproducible build timestamp. `kettle-release` will set this automatically for the session.
|
202
|
+
|
203
|
+
Git hooks and commit message helpers (exe/kettle-commit-msg)
|
204
|
+
- GIT_HOOK_BRANCH_VALIDATE: Branch name validation mode (e.g., `jira`) or `false` to disable
|
205
|
+
- GIT_HOOK_FOOTER_APPEND: Append a footer to commit messages when goalie allows (true/false)
|
206
|
+
- GIT_HOOK_FOOTER_SENTINEL: Required when footer append is enabled — a unique first-line sentinel to prevent duplicates
|
207
|
+
- GIT_HOOK_FOOTER_APPEND_DEBUG: Extra debug output in the footer template (true/false)
|
208
|
+
|
209
|
+
For a quick starting point, this repository’s `.envrc` shows sane defaults, and `.env.local` can override them locally.
|
210
|
+
|
211
|
+
## 🔧 Basic Usage
|
212
|
+
|
213
|
+
Common flows
|
214
|
+
- Default quality workflow (locally):
|
215
|
+
- `bundle exec rake` — runs the curated default task set (gradual RuboCop autocorrect, coverage if available, and other local tasks). On CI `CI=true`, the default task is adjusted to be CI-friendly.
|
216
|
+
- Run specs:
|
217
|
+
- `bin/rspec` or `bundle exec rspec`
|
218
|
+
- To run a subset without failing coverage thresholds: `K_SOUP_COV_MIN_HARD=false bin/rspec spec/path/to/file_spec.rb`
|
219
|
+
- To produce multiple coverage reports: `K_SOUP_COV_FORMATTERS="html,xml,rcov,lcov,json,tty" bin/rspec`
|
220
|
+
- Linting (Gradual):
|
221
|
+
- `bundle exec rake rubocop_gradual:autocorrect`
|
222
|
+
- `bundle exec rake rubocop_gradual:check` (CI-friendly)
|
223
|
+
- Reek and docs:
|
224
|
+
- `bundle exec rake reek` or `bundle exec rake reek:update`
|
225
|
+
- `bundle exec rake yard`
|
226
|
+
|
227
|
+
GitHub Actions local runner helper
|
228
|
+
- `bundle exec rake ci:act` — interactive menu shows workflows from `.github/workflows` with live status and short codes (first 3 letters of file name). Type a number or short code.
|
229
|
+
- Non-interactive: `bundle exec rake ci:act[loc]` (short code), or `bundle exec rake ci:act[locked_deps.yml]` (filename).
|
230
|
+
|
231
|
+
Project automation bootstrap
|
232
|
+
- `bundle exec rake kettle:dev:install` — copies the library’s `.github` folder into your project and offers to install `.git-hooks` templates locally or globally.
|
233
|
+
- `bundle exec rake kettle:dev:template` — runs only the templating step used by install; useful to re-apply updates to templates (.github workflows, .devcontainer, .qlty, modular Gemfiles, README, and friends) without the `install` task’s extra prompts.
|
234
|
+
- README carry-over during templating: when your project’s README.md is replaced by the template, selected sections from your existing README are preserved and merged into the new one. Specifically, the task carries over the following sections (matched case-insensitively):
|
235
|
+
- "Synopsis"
|
236
|
+
- "Configuration"
|
237
|
+
- "Basic Usage"
|
238
|
+
- Any section whose heading starts with "Note:" at any heading level (for example: "# NOTE: …", "## Note: …", or "### note: …").
|
239
|
+
- Headings are recognized at any level using Markdown hashes (#, ##, ###, …).
|
240
|
+
- Notes about task options:
|
241
|
+
- Non-interactive confirmations: append `force=true` to accept all y/N prompts as Yes, e.g., `bundle exec rake kettle:dev:template force=true`.
|
242
|
+
- direnv review flow: if `.envrc` or `.env.local` is created or updated, the task stops and asks you to run `direnv allow`. After you review and allow, resume with `allowed=true`:
|
243
|
+
- `bundle exec rake kettle:dev:template allowed=true`
|
244
|
+
- `bundle exec rake kettle:dev:install allowed=true`
|
245
|
+
- After that, set up binstubs and direnv for convenience:
|
246
|
+
- `bundle binstubs kettle-dev --path bin`
|
247
|
+
- Add to `.envrc`: `PATH_add bin` (so `bin/` tools run without the prefix)
|
248
|
+
|
249
|
+
Releasing (maintainers)
|
250
|
+
- `exe/kettle-release` — guided release helper that:
|
251
|
+
- Runs sanity checks (`bin/setup`, `bin/rake`), confirms version/changelog, optionally updates Appraisals, commits “🔖 Prepare release vX.Y.Z”.
|
252
|
+
- Ensures trunk sync and rebases feature as needed, pushes, monitors GitHub Actions with a progress bar, and merges feature to trunk on success.
|
253
|
+
- Exports `SOURCE_DATE_EPOCH`, builds (optionally signed), creates gem checksums, and runs `bundle exec rake release` (prompts for signing key + RubyGems MFA OTP as needed).
|
254
|
+
|
255
|
+
Tip: The commit message helper `exe/kettle-commit-msg` prefers project-local `.git-hooks` (then falls back to `~/.git-hooks`). The goalie file `commit-subjects-goalie.txt` controls when a footer is appended; customize `footer-template.erb.txt` as you like.
|
256
|
+
|
257
|
+
### Open Collective README updater
|
258
|
+
|
259
|
+
- Script: `exe/kettle-readme-backers`
|
260
|
+
- Purpose: Updates README sections for Open Collective backers (individuals) and sponsors (organizations) by fetching live data from your collective.
|
261
|
+
- Tags updated in README.md (first match wins for backers):
|
262
|
+
- The default tag prefix is `OPENCOLLECTIVE`, and it is configurable:
|
263
|
+
- ENV: `KETTLE_DEV_BACKER_README_OSC_TAG="OPENCOLLECTIVE"`
|
264
|
+
- YAML (.opencollective.yml): `readme-osc-tag: "OPENCOLLECTIVE"`
|
265
|
+
- The resulting markers become: `<!-- <TAG>:START --> … <!-- <TAG>:END -->`, `<!-- <TAG>-INDIVIDUALS:START --> … <!-- <TAG>-INDIVIDUALS:END -->`, and `<!-- <TAG>-ORGANIZATIONS:START --> … <!-- <TAG>-ORGANIZATIONS:END -->`.
|
266
|
+
- ENV overrides YAML.
|
267
|
+
- Backers (Individuals): `<!-- <TAG>:START --> … <!-- <TAG>:END -->` or `<!-- <TAG>-INDIVIDUALS:START --> … <!-- <TAG>-INDIVIDUALS:END -->`
|
268
|
+
- Sponsors (Organizations): `<!-- <TAG>-ORGANIZATIONS:START --> … <!-- <TAG>-ORGANIZATIONS:END -->`
|
269
|
+
- Handle resolution:
|
270
|
+
1. `OPENCOLLECTIVE_HANDLE` environment variable, if set
|
271
|
+
2. `opencollective.yml` in the project root (`collective: "kettle-rb"` by default in this repo)
|
272
|
+
- Usage:
|
273
|
+
- `exe/kettle-readme-backers`
|
274
|
+
- `OPENCOLLECTIVE_HANDLE=my-collective exe/kettle-readme-backers`
|
275
|
+
- Behavior:
|
276
|
+
- Writes to README.md only if content between the tags would change.
|
277
|
+
- If neither the backers nor sponsors tags are present, prints a helpful warning and exits with status 2.
|
278
|
+
- When there are no entries, inserts a friendly placeholder: "No backers yet. Be the first!" or "No sponsors yet. Be the first!".
|
279
|
+
- When updates are written and the repository is a git work tree, the script stages README.md and commits with a message thanking new backers and subscribers, including mentions for any newly added backers and subscribers (GitHub @handles when their website/profile is a github.com URL; otherwise their name).
|
280
|
+
- Customize the commit subject via env var: `KETTLE_README_BACKERS_COMMIT_SUBJECT="💸 Thanks 🙏 to our new backers 🎒 and subscribers 📜"`.
|
281
|
+
- Or via .opencollective.yml: set `readme-backers-commit-subject: "💸 Thanks 🙏 to our new backers 🎒 and subscribers 📜"`.
|
282
|
+
- Precedence: ENV overrides .opencollective.yml; if neither is set, a sensible default is used.
|
283
|
+
- Note: When used with the provided `.git-hooks`, the subject should start with a gitmoji character (see [gitmoji][📌gitmoji]).
|
284
|
+
- Tip: Run this locally before committing to keep your README current, or schedule it in CI to refresh periodically.
|
285
|
+
|
286
|
+
|
287
|
+
## 🦷 FLOSS Funding
|
288
|
+
|
289
|
+
While kettle-rb tools are free software and will always be, the project would benefit immensely from some funding.
|
290
|
+
Raising a monthly budget of... "dollars" would make the project more sustainable.
|
291
|
+
|
292
|
+
We welcome both individual and corporate sponsors! We also offer a
|
293
|
+
wide array of funding channels to account for your preferences
|
294
|
+
(although currently [Open Collective][🖇osc] is our preferred funding platform).
|
295
|
+
|
296
|
+
**If you're working in a company that's making significant use of kettle-rb tools we'd
|
297
|
+
appreciate it if you suggest to your company to become a kettle-rb sponsor.**
|
298
|
+
|
299
|
+
You can support the development of kettle-rb tools via
|
300
|
+
[GitHub Sponsors][🖇sponsor],
|
301
|
+
[Liberapay][⛳liberapay],
|
302
|
+
[PayPal][🖇paypal],
|
303
|
+
[Open Collective][🖇osc]
|
304
|
+
and [Tidelift][🏙️entsup-tidelift].
|
305
|
+
|
306
|
+
| 📍 NOTE |
|
307
|
+
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
308
|
+
| If doing a sponsorship in the form of donation is problematic for your company <br/> from an accounting standpoint, we'd recommend the use of Tidelift, <br/> where you can get a support-like subscription instead. |
|
309
|
+
|
310
|
+
### Open Collective for Individuals
|
311
|
+
|
312
|
+
<!-- OPENCOLLECTIVE-INDIVIDUALS:START -->
|
313
|
+
No backers yet. Be the first!
|
314
|
+
<!-- OPENCOLLECTIVE-INDIVIDUALS:END -->
|
315
|
+
|
316
|
+
Support us with a monthly donation and help us continue our activities. [[Become a backer](https://opencollective.com/kettle-rb#backer)]
|
317
|
+
|
318
|
+
### Open Collective for Organizations
|
319
|
+
|
320
|
+
<!-- OPENCOLLECTIVE-ORGANIZATIONS:START -->
|
321
|
+
No sponsors yet. Be the first!
|
322
|
+
<!-- OPENCOLLECTIVE-ORGANIZATIONS:END -->
|
323
|
+
|
324
|
+
Become a sponsor and get your logo on our README on GitHub with a link to your site. [[Become a sponsor](https://opencollective.com/kettle-rb#sponsor)]
|
325
|
+
|
326
|
+
### Another way to support open-source
|
327
|
+
|
328
|
+
> How wonderful it is that nobody need wait a single moment before starting to improve the world.<br/>
|
329
|
+
>—Anne Frank
|
330
|
+
|
331
|
+
I’m driven by a passion to foster a thriving open-source community – a space where people can tackle complex problems, no matter how small. Revitalizing libraries that have fallen into disrepair, and building new libraries focused on solving real-world challenges, are my passions — totaling 79 hours of FLOSS coding over just the past seven days, a pretty regular week for me. I was recently affected by layoffs, and the tech jobs market is unwelcoming. I’m reaching out here because your support would significantly aid my efforts to provide for my family, and my farm (11 🐔 chickens, 2 🐶 dogs, 3 🐰 rabbits, 8 🐈 cats).
|
332
|
+
|
333
|
+
If you work at a company that uses my work, please encourage them to support me as a corporate sponsor. My work on gems you use might show up in `bundle fund`.
|
334
|
+
|
335
|
+
I’m developing a new library, [floss_funding][🖇floss-funding-gem], designed to empower open-source developers like myself to get paid for the work we do, in a sustainable way. Please give it a look.
|
336
|
+
|
337
|
+
**[Floss-Funding.dev][🖇floss-funding.dev]: 👉️ No network calls. 👉️ No tracking. 👉️ No oversight. 👉️ Minimal crypto hashing. 💡 Easily disabled nags**
|
338
|
+
|
339
|
+
[![Liberapay Goal Progress][⛳liberapay-img]][⛳liberapay] [![Donate on PayPal][🖇paypal-img]][🖇paypal] [![Sponsor Me on Github][🖇sponsor-img]][🖇sponsor] [![Buy me a coffee][🖇buyme-small-img]][🖇buyme] [![Donate on Polar][🖇polar-img]][🖇polar] [![Donate to my FLOSS or refugee efforts at ko-fi.com][🖇kofi-img]][🖇kofi] [![Donate to my FLOSS or refugee efforts using Patreon][🖇patreon-img]][🖇patreon]
|
340
|
+
|
341
|
+
## 🔐 Security
|
342
|
+
|
343
|
+
See [SECURITY.md][🔐security].
|
344
|
+
|
345
|
+
## 🤝 Contributing
|
346
|
+
|
347
|
+
If you need some ideas of where to help, you could work on adding more code coverage,
|
348
|
+
or if it is already 💯 (see [below](#code-coverage)) check [reek](REEK), [issues][🤝gh-issues], or [PRs][🤝gh-pulls],
|
349
|
+
or use the gem and think about how it could be better.
|
350
|
+
|
351
|
+
We [![Keep A Changelog][📗keep-changelog-img]][📗keep-changelog] so if you make changes, remember to update it.
|
352
|
+
|
353
|
+
See [CONTRIBUTING.md][🤝contributing] for more detailed instructions.
|
354
|
+
|
355
|
+
### 🚀 Release Instructions
|
356
|
+
|
357
|
+
See [CONTRIBUTING.md][🤝contributing].
|
358
|
+
|
359
|
+
### Code Coverage
|
360
|
+
|
361
|
+
[![Coverage Graph][🔑codecov-g]][🔑codecov]
|
362
|
+
|
363
|
+
[![Coveralls Test Coverage][🔑coveralls-img]][🔑coveralls]
|
364
|
+
|
365
|
+
[![QLTY Test Coverage][🔑qlty-covi]][🔑qlty-cov]
|
366
|
+
|
367
|
+
### 🪇 Code of Conduct
|
368
|
+
|
369
|
+
Everyone interacting with this project's codebases, issue trackers,
|
370
|
+
chat rooms and mailing lists agrees to follow the [![Contributor Covenant 2.1][🪇conduct-img]][🪇conduct].
|
371
|
+
|
372
|
+
## 🌈 Contributors
|
373
|
+
|
374
|
+
[![Contributors][🖐contributors-img]][🖐contributors]
|
375
|
+
|
376
|
+
Made with [contributors-img][🖐contrib-rocks].
|
377
|
+
|
378
|
+
Also see GitLab Contributors: [https://gitlab.com/kettle-rb/kettle-dev/-/graphs/main][🚎contributors-gl]
|
379
|
+
|
380
|
+
<details>
|
381
|
+
<summary>⭐️ Star History</summary>
|
382
|
+
|
383
|
+
<a href="https://star-history.com/#kettle-rb/kettle-dev&Date">
|
384
|
+
<picture>
|
385
|
+
<source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=kettle-rb/kettle-dev&type=Date&theme=dark" />
|
386
|
+
<source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=kettle-rb/kettle-dev&type=Date" />
|
387
|
+
<img alt="Star History Chart" src="https://api.star-history.com/svg?repos=kettle-rb/kettle-dev&type=Date" />
|
388
|
+
</picture>
|
389
|
+
</a>
|
390
|
+
|
391
|
+
</details>
|
392
|
+
|
393
|
+
## 📌 Versioning
|
394
|
+
|
395
|
+
This Library adheres to [![Semantic Versioning 2.0.0][📌semver-img]][📌semver].
|
396
|
+
Violations of this scheme should be reported as bugs.
|
397
|
+
Specifically, if a minor or patch version is released that breaks backward compatibility,
|
398
|
+
a new version should be immediately released that restores compatibility.
|
399
|
+
Breaking changes to the public API will only be introduced with new major versions.
|
400
|
+
|
401
|
+
> dropping support for a platform is both obviously and objectively a breaking change <br/>
|
402
|
+
>—Jordan Harband ([@ljharb](https://github.com/ljharb), maintainer of SemVer) [in SemVer issue 716][📌semver-breaking]
|
403
|
+
|
404
|
+
I understand that policy doesn't work universally ("exceptions to every rule!"),
|
405
|
+
but it is the policy here.
|
406
|
+
As such, in many cases it is good to specify a dependency on this library using
|
407
|
+
the [Pessimistic Version Constraint][📌pvc] with two digits of precision.
|
408
|
+
|
409
|
+
For example:
|
410
|
+
|
411
|
+
```ruby
|
412
|
+
spec.add_dependency("kettle-dev", "~> 1.0")
|
413
|
+
```
|
414
|
+
|
415
|
+
<details>
|
416
|
+
<summary>📌 Is "Platform Support" part of the public API? More details inside.</summary>
|
417
|
+
|
418
|
+
SemVer should, IMO, but doesn't explicitly, say that dropping support for specific Platforms
|
419
|
+
is a *breaking change* to an API.
|
420
|
+
It is obvious to many, but not all, and since the spec is silent, the bike shedding is endless.
|
421
|
+
|
422
|
+
To get a better understanding of how SemVer is intended to work over a project's lifetime,
|
423
|
+
read this article from the creator of SemVer:
|
424
|
+
|
425
|
+
- ["Major Version Numbers are Not Sacred"][📌major-versions-not-sacred]
|
426
|
+
|
427
|
+
</details>
|
428
|
+
|
429
|
+
See [CHANGELOG.md][📌changelog] for a list of releases.
|
430
|
+
|
431
|
+
## 📄 License
|
432
|
+
|
433
|
+
The gem is available as open source under the terms of
|
434
|
+
the [MIT License][📄license] [![License: MIT][📄license-img]][📄license-ref].
|
435
|
+
See [LICENSE.txt][📄license] for the official [Copyright Notice][📄copyright-notice-explainer].
|
436
|
+
|
437
|
+
### © Copyright
|
438
|
+
|
439
|
+
<ul>
|
440
|
+
<li>
|
441
|
+
Copyright (c) 2023, 2025 Peter H. Boling, of
|
442
|
+
<a href="https://discord.gg/3qme4XHNKN">
|
443
|
+
Galtzo.com
|
444
|
+
<picture>
|
445
|
+
<img src="https://logos.galtzo.com/assets/images/galtzo-floss/avatar-128px-blank.svg" alt="Galtzo.com Logo (Wordless) by Aboling0, CC BY-SA 4.0" width="24">
|
446
|
+
</picture>
|
447
|
+
</a>, and kettle-dev contributors.
|
448
|
+
</li>
|
449
|
+
</ul>
|
450
|
+
|
451
|
+
## 🤑 A request for help
|
452
|
+
|
453
|
+
Maintainers have teeth, and need to pay their dentists.
|
454
|
+
After getting laid off in an RIF in March, and filled with many dozens of rejections,
|
455
|
+
I'm now spending ~80 hours a week building open source tools.
|
456
|
+
I'm hoping to be able to pay for my kids' health insurance this month,
|
457
|
+
so if you value the work I am doing, I need your support.
|
458
|
+
Please consider sponsoring me or the project.
|
459
|
+
|
460
|
+
[![Sponsor kettle-rb/kettle-dev on Open Source Collective][🖇osc-all-bottom-img]][🖇osc] 💌 [![Sponsor me on GitHub Sponsors][🖇sponsor-bottom-img]][🖇sponsor] 💌 [![Sponsor me on Liberapay][⛳liberapay-bottom-img]][⛳liberapay-img] 💌 [![Donate on PayPal][🖇paypal-bottom-img]][🖇paypal-img]
|
461
|
+
|
462
|
+
To say "thanks for maintaining such a great tool" 👇️ Join the Discord or ☝️ send money.
|
463
|
+
|
464
|
+
To join the community or get help 👇️ Join the Discord.
|
465
|
+
|
466
|
+
[![Live Chat on Discord][✉️discord-invite-img]][✉️discord-invite]
|
467
|
+
|
468
|
+
### Please give the project a star ⭐ ♥.
|
469
|
+
|
470
|
+
Thanks for RTFM. ☺️
|
471
|
+
|
472
|
+
[⛳liberapay-img]: https://img.shields.io/liberapay/goal/pboling.svg?logo=liberapay&color=a51611
|
473
|
+
[⛳liberapay-bottom-img]: https://img.shields.io/liberapay/goal/pboling.svg?style=for-the-badge&logo=liberapay&color=a51611
|
474
|
+
[⛳liberapay]: https://liberapay.com/pboling/donate
|
475
|
+
[🖇osc-all-img]: https://img.shields.io/opencollective/all/kettle-rb
|
476
|
+
[🖇osc-sponsors-img]: https://img.shields.io/opencollective/sponsors/kettle-rb
|
477
|
+
[🖇osc-backers-img]: https://img.shields.io/opencollective/backers/kettle-rb
|
478
|
+
[🖇osc-all-bottom-img]: https://img.shields.io/opencollective/all/kettle-rb?style=for-the-badge
|
479
|
+
[🖇osc-sponsors-bottom-img]: https://img.shields.io/opencollective/sponsors/kettle-rb?style=for-the-badge
|
480
|
+
[🖇osc-backers-bottom-img]: https://img.shields.io/opencollective/backers/kettle-rb?style=for-the-badge
|
481
|
+
[🖇osc]: https://opencollective.com/kettle-rb
|
482
|
+
[🖇sponsor-img]: https://img.shields.io/badge/Sponsor_Me!-pboling.svg?style=social&logo=github
|
483
|
+
[🖇sponsor-bottom-img]: https://img.shields.io/badge/Sponsor_Me!-pboling-blue?style=for-the-badge&logo=github
|
484
|
+
[🖇sponsor]: https://github.com/sponsors/pboling
|
485
|
+
[🖇polar-img]: https://img.shields.io/badge/polar-donate-a51611.svg
|
486
|
+
[🖇polar]: https://polar.sh/pboling
|
487
|
+
[🖇kofi-img]: https://img.shields.io/badge/ko--fi-✓-a51611.svg
|
488
|
+
[🖇kofi]: https://ko-fi.com/O5O86SNP4
|
489
|
+
[🖇patreon-img]: https://img.shields.io/badge/patreon-donate-a51611.svg
|
490
|
+
[🖇patreon]: https://patreon.com/galtzo
|
491
|
+
[🖇buyme-small-img]: https://img.shields.io/badge/buy_me_a_coffee-✓-a51611.svg?style=flat
|
492
|
+
[🖇buyme-img]: https://img.buymeacoffee.com/button-api/?text=Buy%20me%20a%20latte&emoji=&slug=pboling&button_colour=FFDD00&font_colour=000000&font_family=Cookie&outline_colour=000000&coffee_colour=ffffff
|
493
|
+
[🖇buyme]: https://www.buymeacoffee.com/pboling
|
494
|
+
[🖇paypal-img]: https://img.shields.io/badge/donate-paypal-a51611.svg?style=flat&logo=paypal
|
495
|
+
[🖇paypal-bottom-img]: https://img.shields.io/badge/donate-paypal-a51611.svg?style=for-the-badge&logo=paypal&color=0A0A0A
|
496
|
+
[🖇paypal]: https://www.paypal.com/paypalme/peterboling
|
497
|
+
[🖇floss-funding.dev]: https://floss-funding.dev
|
498
|
+
[🖇floss-funding-gem]: https://github.com/galtzo-floss/floss_funding
|
499
|
+
[✉️discord-invite]: https://discord.gg/3qme4XHNKN
|
500
|
+
[✉️discord-invite-img]: https://img.shields.io/discord/1373797679469170758?style=for-the-badge
|
501
|
+
|
502
|
+
[✇bundle-group-pattern]: https://gist.github.com/pboling/4564780
|
503
|
+
[⛳️gem-namespace]: https://github.com/kettle-rb/kettle-dev
|
504
|
+
[⛳️namespace-img]: https://img.shields.io/badge/namespace-Kettle%3A%3ADev-3C2D2D.svg?style=square&logo=ruby&logoColor=white
|
505
|
+
[⛳️gem-name]: https://rubygems.org/gems/kettle-dev
|
506
|
+
[⛳️name-img]: https://img.shields.io/badge/name-kettle--dev-3C2D2D.svg?style=square&logo=rubygems&logoColor=red
|
507
|
+
[🚂maint-blog]: http://www.railsbling.com/tags/kettle-dev
|
508
|
+
[🚂maint-blog-img]: https://img.shields.io/badge/blog-railsbling-0093D0.svg?style=for-the-badge&logo=rubyonrails&logoColor=orange
|
509
|
+
[🚂maint-contact]: http://www.railsbling.com/contact
|
510
|
+
[🚂maint-contact-img]: https://img.shields.io/badge/Contact-Maintainer-0093D0.svg?style=flat&logo=rubyonrails&logoColor=red
|
511
|
+
[💖🖇linkedin]: http://www.linkedin.com/in/peterboling
|
512
|
+
[💖🖇linkedin-img]: https://img.shields.io/badge/PeterBoling-LinkedIn-0B66C2?style=flat&logo=newjapanprowrestling
|
513
|
+
[💖✌️wellfound]: https://wellfound.com/u/peter-boling/u/peter-boling
|
514
|
+
[💖✌️wellfound-img]: https://img.shields.io/badge/peter--boling-orange?style=flat&logo=wellfound
|
515
|
+
[💖💲crunchbase]: https://www.crunchbase.com/person/peter-boling
|
516
|
+
[💖💲crunchbase-img]: https://img.shields.io/badge/peter--boling-purple?style=flat&logo=crunchbase
|
517
|
+
[💖🐘ruby-mast]: https://ruby.social/@galtzo
|
518
|
+
[💖🐘ruby-mast-img]: https://img.shields.io/mastodon/follow/109447111526622197?domain=https%3A%2F%2Fruby.social&style=flat&logo=mastodon&label=Ruby%20%40galtzo
|
519
|
+
[💖🦋bluesky]: https://bsky.app/profile/galtzo.com
|
520
|
+
[💖🦋bluesky-img]: https://img.shields.io/badge/@galtzo.com-0285FF?style=flat&logo=bluesky&logoColor=white
|
521
|
+
[💖🌳linktree]: https://linktr.ee/galtzo
|
522
|
+
[💖🌳linktree-img]: https://img.shields.io/badge/galtzo-purple?style=flat&logo=linktree
|
523
|
+
[💖💁🏼♂️devto]: https://dev.to/galtzo
|
524
|
+
[💖💁🏼♂️devto-img]: https://img.shields.io/badge/dev.to-0A0A0A?style=flat&logo=devdotto&logoColor=white
|
525
|
+
[💖💁🏼♂️aboutme]: https://about.me/peter.boling
|
526
|
+
[💖💁🏼♂️aboutme-img]: https://img.shields.io/badge/about.me-0A0A0A?style=flat&logo=aboutme&logoColor=white
|
527
|
+
[💖🧊berg]: https://codeberg.org/pboling
|
528
|
+
[💖🐙hub]: https://github.org/pboling
|
529
|
+
[💖🛖hut]: https://sr.ht/~galtzo/
|
530
|
+
[💖🧪lab]: https://gitlab.com/pboling
|
531
|
+
[👨🏼🏫expsup-upwork]: https://www.upwork.com/freelancers/~014942e9b056abdf86?mp_source=share
|
532
|
+
[👨🏼🏫expsup-upwork-img]: https://img.shields.io/badge/UpWork-13544E?style=for-the-badge&logo=Upwork&logoColor=white
|
533
|
+
[👨🏼🏫expsup-codementor]: https://www.codementor.io/peterboling?utm_source=github&utm_medium=button&utm_term=peterboling&utm_campaign=github
|
534
|
+
[👨🏼🏫expsup-codementor-img]: https://img.shields.io/badge/CodeMentor-Get_Help-1abc9c?style=for-the-badge&logo=CodeMentor&logoColor=white
|
535
|
+
[🏙️entsup-tidelift]: https://tidelift.com/subscription/pkg/rubygems-kettle-dev?utm_source=rubygems-kettle-dev&utm_medium=referral&utm_campaign=readme
|
536
|
+
[🏙️entsup-tidelift-img]: https://img.shields.io/badge/Tidelift_and_Sonar-Enterprise_Support-FD3456?style=for-the-badge&logo=sonar&logoColor=white
|
537
|
+
[🏙️entsup-tidelift-sonar]: https://blog.tidelift.com/tidelift-joins-sonar
|
538
|
+
[💁🏼♂️peterboling]: http://www.peterboling.com
|
539
|
+
[🚂railsbling]: http://www.railsbling.com
|
540
|
+
[📜src-gl-img]: https://img.shields.io/badge/GitLab-FBA326?style=for-the-badge&logo=Gitlab&logoColor=orange
|
541
|
+
[📜src-gl]: https://gitlab.com/kettle-rb/kettle-dev/
|
542
|
+
[📜src-cb-img]: https://img.shields.io/badge/CodeBerg-4893CC?style=for-the-badge&logo=CodeBerg&logoColor=blue
|
543
|
+
[📜src-cb]: https://codeberg.org/kettle-rb/kettle-dev
|
544
|
+
[📜src-gh-img]: https://img.shields.io/badge/GitHub-238636?style=for-the-badge&logo=Github&logoColor=green
|
545
|
+
[📜src-gh]: https://github.com/kettle-rb/kettle-dev
|
546
|
+
[📜docs-cr-rd-img]: https://img.shields.io/badge/RubyDoc-Current_Release-943CD2?style=for-the-badge&logo=readthedocs&logoColor=white
|
547
|
+
[📜docs-head-rd-img]: https://img.shields.io/badge/YARD_on_Galtzo.com-HEAD-943CD2?style=for-the-badge&logo=readthedocs&logoColor=white
|
548
|
+
[📜wiki]: https://gitlab.com/kettle-rb/kettle-dev/-/wikis/home
|
549
|
+
[📜wiki-img]: https://img.shields.io/badge/wiki-examples-943CD2.svg?style=for-the-badge&logo=Wiki&logoColor=white
|
550
|
+
[👽dl-rank]: https://rubygems.org/gems/kettle-dev
|
551
|
+
[👽dl-ranki]: https://img.shields.io/gem/rd/kettle-dev.svg
|
552
|
+
[👽oss-help]: https://www.codetriage.com/kettle-rb/kettle-dev
|
553
|
+
[👽oss-helpi]: https://www.codetriage.com/kettle-rb/kettle-dev/badges/users.svg
|
554
|
+
[👽version]: https://rubygems.org/gems/kettle-dev
|
555
|
+
[👽versioni]: https://img.shields.io/gem/v/kettle-dev.svg
|
556
|
+
[🔑qlty-mnt]: https://qlty.sh/gh/kettle-rb/projects/kettle-dev
|
557
|
+
[🔑qlty-mnti]: https://qlty.sh/gh/kettle-rb/projects/kettle-dev/maintainability.svg
|
558
|
+
[🔑qlty-cov]: https://qlty.sh/gh/kettle-rb/projects/kettle-dev/metrics/code?sort=coverageRating
|
559
|
+
[🔑qlty-covi]: https://qlty.sh/gh/kettle-rb/projects/kettle-dev/coverage.svg
|
560
|
+
[🔑codecov]: https://codecov.io/gh/kettle-rb/kettle-dev
|
561
|
+
[🔑codecovi]: https://codecov.io/gh/kettle-rb/kettle-dev/graph/badge.svg
|
562
|
+
[🔑coveralls]: https://coveralls.io/github/kettle-rb/kettle-dev?branch=main
|
563
|
+
[🔑coveralls-img]: https://coveralls.io/repos/github/kettle-rb/kettle-dev/badge.svg?branch=main
|
564
|
+
[🖐codeQL]: https://github.com/kettle-rb/kettle-dev/security/code-scanning
|
565
|
+
[🖐codeQL-img]: https://github.com/kettle-rb/kettle-dev/actions/workflows/codeql-analysis.yml/badge.svg
|
566
|
+
[🚎1-an-wf]: https://github.com/kettle-rb/kettle-dev/actions/workflows/ancient.yml
|
567
|
+
[🚎1-an-wfi]: https://github.com/kettle-rb/kettle-dev/actions/workflows/ancient.yml/badge.svg
|
568
|
+
[🚎2-cov-wf]: https://github.com/kettle-rb/kettle-dev/actions/workflows/coverage.yml
|
569
|
+
[🚎2-cov-wfi]: https://github.com/kettle-rb/kettle-dev/actions/workflows/coverage.yml/badge.svg
|
570
|
+
[🚎3-hd-wf]: https://github.com/kettle-rb/kettle-dev/actions/workflows/heads.yml
|
571
|
+
[🚎3-hd-wfi]: https://github.com/kettle-rb/kettle-dev/actions/workflows/heads.yml/badge.svg
|
572
|
+
[🚎4-lg-wf]: https://github.com/kettle-rb/kettle-dev/actions/workflows/legacy.yml
|
573
|
+
[🚎4-lg-wfi]: https://github.com/kettle-rb/kettle-dev/actions/workflows/legacy.yml/badge.svg
|
574
|
+
[🚎5-st-wf]: https://github.com/kettle-rb/kettle-dev/actions/workflows/style.yml
|
575
|
+
[🚎5-st-wfi]: https://github.com/kettle-rb/kettle-dev/actions/workflows/style.yml/badge.svg
|
576
|
+
[🚎6-s-wf]: https://github.com/kettle-rb/kettle-dev/actions/workflows/supported.yml
|
577
|
+
[🚎6-s-wfi]: https://github.com/kettle-rb/kettle-dev/actions/workflows/supported.yml/badge.svg
|
578
|
+
[🚎7-us-wf]: https://github.com/kettle-rb/kettle-dev/actions/workflows/unsupported.yml
|
579
|
+
[🚎7-us-wfi]: https://github.com/kettle-rb/kettle-dev/actions/workflows/unsupported.yml/badge.svg
|
580
|
+
[🚎8-ho-wf]: https://github.com/kettle-rb/kettle-dev/actions/workflows/hoary.yml
|
581
|
+
[🚎8-ho-wfi]: https://github.com/kettle-rb/kettle-dev/actions/workflows/hoary.yml/badge.svg
|
582
|
+
[🚎9-t-wf]: https://github.com/kettle-rb/kettle-dev/actions/workflows/truffle.yml
|
583
|
+
[🚎9-t-wfi]: https://github.com/kettle-rb/kettle-dev/actions/workflows/truffle.yml/badge.svg
|
584
|
+
[🚎10-j-wf]: https://github.com/kettle-rb/kettle-dev/actions/workflows/jruby.yml
|
585
|
+
[🚎10-j-wfi]: https://github.com/kettle-rb/kettle-dev/actions/workflows/jruby.yml/badge.svg
|
586
|
+
[🚎11-c-wf]: https://github.com/kettle-rb/kettle-dev/actions/workflows/current.yml
|
587
|
+
[🚎11-c-wfi]: https://github.com/kettle-rb/kettle-dev/actions/workflows/current.yml/badge.svg
|
588
|
+
[🚎13-🔒️-wf]: https://github.com/kettle-rb/kettle-dev/actions/workflows/locked_deps.yml
|
589
|
+
[🚎13-🔒️-wfi]: https://github.com/kettle-rb/kettle-dev/actions/workflows/locked_deps.yml/badge.svg
|
590
|
+
[🚎14-🔓️-wf]: https://github.com/kettle-rb/kettle-dev/actions/workflows/unlocked_deps.yml
|
591
|
+
[🚎14-🔓️-wfi]: https://github.com/kettle-rb/kettle-dev/actions/workflows/unlocked_deps.yml/badge.svg
|
592
|
+
[💎ruby-1.9i]: https://img.shields.io/badge/Ruby-1.9_(%F0%9F%9A%ABCI)-AABBCC?style=for-the-badge&logo=ruby&logoColor=white
|
593
|
+
[💎ruby-2.0i]: https://img.shields.io/badge/Ruby-2.0_(%F0%9F%9A%ABCI)-AABBCC?style=for-the-badge&logo=ruby&logoColor=white
|
594
|
+
[💎ruby-2.1i]: https://img.shields.io/badge/Ruby-2.1_(%F0%9F%9A%ABCI)-AABBCC?style=for-the-badge&logo=ruby&logoColor=white
|
595
|
+
[💎ruby-2.2i]: https://img.shields.io/badge/Ruby-2.2_(%F0%9F%9A%ABCI)-AABBCC?style=for-the-badge&logo=ruby&logoColor=white
|
596
|
+
[💎ruby-2.3i]: https://img.shields.io/badge/Ruby-2.3-DF00CA?style=for-the-badge&logo=ruby&logoColor=white
|
597
|
+
[💎ruby-2.4i]: https://img.shields.io/badge/Ruby-2.4-DF00CA?style=for-the-badge&logo=ruby&logoColor=white
|
598
|
+
[💎ruby-2.5i]: https://img.shields.io/badge/Ruby-2.5-DF00CA?style=for-the-badge&logo=ruby&logoColor=white
|
599
|
+
[💎ruby-2.6i]: https://img.shields.io/badge/Ruby-2.6-DF00CA?style=for-the-badge&logo=ruby&logoColor=white
|
600
|
+
[💎ruby-2.7i]: https://img.shields.io/badge/Ruby-2.7-DF00CA?style=for-the-badge&logo=ruby&logoColor=white
|
601
|
+
[💎ruby-3.0i]: https://img.shields.io/badge/Ruby-3.0-CC342D?style=for-the-badge&logo=ruby&logoColor=white
|
602
|
+
[💎ruby-3.1i]: https://img.shields.io/badge/Ruby-3.1-CC342D?style=for-the-badge&logo=ruby&logoColor=white
|
603
|
+
[💎ruby-3.2i]: https://img.shields.io/badge/Ruby-3.2-CC342D?style=for-the-badge&logo=ruby&logoColor=white
|
604
|
+
[💎ruby-3.3i]: https://img.shields.io/badge/Ruby-3.3-CC342D?style=for-the-badge&logo=ruby&logoColor=white
|
605
|
+
[💎ruby-c-i]: https://img.shields.io/badge/Ruby-current-CC342D?style=for-the-badge&logo=ruby&logoColor=green
|
606
|
+
[💎ruby-headi]: https://img.shields.io/badge/Ruby-HEAD-CC342D?style=for-the-badge&logo=ruby&logoColor=blue
|
607
|
+
[💎truby-22.3i]: https://img.shields.io/badge/Truffle_Ruby-22.3_(%F0%9F%9A%ABCI)-AABBCC?style=for-the-badge&logo=ruby&logoColor=pink
|
608
|
+
[💎truby-23.0i]: https://img.shields.io/badge/Truffle_Ruby-23.0-34BCB1?style=for-the-badge&logo=ruby&logoColor=pink
|
609
|
+
[💎truby-23.1i]: https://img.shields.io/badge/Truffle_Ruby-23.1-34BCB1?style=for-the-badge&logo=ruby&logoColor=pink
|
610
|
+
[💎truby-c-i]: https://img.shields.io/badge/Truffle_Ruby-current-34BCB1?style=for-the-badge&logo=ruby&logoColor=green
|
611
|
+
[💎truby-headi]: https://img.shields.io/badge/Truffle_Ruby-HEAD-34BCB1?style=for-the-badge&logo=ruby&logoColor=blue
|
612
|
+
[💎jruby-9.1i]: https://img.shields.io/badge/JRuby-9.1_(%F0%9F%9A%ABCI)-AABBCC?style=for-the-badge&logo=ruby&logoColor=red
|
613
|
+
[💎jruby-9.2i]: https://img.shields.io/badge/JRuby-9.2_(%F0%9F%9A%ABCI)-AABBCC?style=for-the-badge&logo=ruby&logoColor=red
|
614
|
+
[💎jruby-9.3i]: https://img.shields.io/badge/JRuby-9.3_(%F0%9F%9A%ABCI)-AABBCC?style=for-the-badge&logo=ruby&logoColor=red
|
615
|
+
[💎jruby-9.4i]: https://img.shields.io/badge/JRuby-9.4-FBE742?style=for-the-badge&logo=ruby&logoColor=red
|
616
|
+
[💎jruby-c-i]: https://img.shields.io/badge/JRuby-current-FBE742?style=for-the-badge&logo=ruby&logoColor=green
|
617
|
+
[💎jruby-headi]: https://img.shields.io/badge/JRuby-HEAD-FBE742?style=for-the-badge&logo=ruby&logoColor=blue
|
618
|
+
[🤝gh-issues]: https://github.com/kettle-rb/kettle-dev/issues
|
619
|
+
[🤝gh-pulls]: https://github.com/kettle-rb/kettle-dev/pulls
|
620
|
+
[🤝gl-issues]: https://gitlab.com/kettle-rb/kettle-dev/-/issues
|
621
|
+
[🤝gl-pulls]: https://gitlab.com/kettle-rb/kettle-dev/-/merge_requests
|
622
|
+
[🤝cb-issues]: https://codeberg.org/kettle-rb/kettle-dev/issues
|
623
|
+
[🤝cb-pulls]: https://codeberg.org/kettle-rb/kettle-dev/pulls
|
624
|
+
[🤝cb-donate]: https://donate.codeberg.org/
|
625
|
+
[🤝contributing]: CONTRIBUTING.md
|
626
|
+
[🔑codecov-g]: https://codecov.io/gh/kettle-rb/kettle-dev/graphs/tree.svg
|
627
|
+
[🖐contrib-rocks]: https://contrib.rocks
|
628
|
+
[🖐contributors]: https://github.com/kettle-rb/kettle-dev/graphs/contributors
|
629
|
+
[🖐contributors-img]: https://contrib.rocks/image?repo=kettle-rb/kettle-dev
|
630
|
+
[🚎contributors-gl]: https://gitlab.com/kettle-rb/kettle-dev/-/graphs/main
|
631
|
+
[🪇conduct]: CODE_OF_CONDUCT.md
|
632
|
+
[🪇conduct-img]: https://img.shields.io/badge/Contributor_Covenant-2.1-259D6C.svg
|
633
|
+
[📌pvc]: http://guides.rubygems.org/patterns/#pessimistic-version-constraint
|
634
|
+
[📌semver]: https://semver.org/spec/v2.0.0.html
|
635
|
+
[📌semver-img]: https://img.shields.io/badge/semver-2.0.0-259D6C.svg?style=flat
|
636
|
+
[📌semver-breaking]: https://github.com/semver/semver/issues/716#issuecomment-869336139
|
637
|
+
[📌major-versions-not-sacred]: https://tom.preston-werner.com/2022/05/23/major-version-numbers-are-not-sacred.html
|
638
|
+
[📌changelog]: CHANGELOG.md
|
639
|
+
[📗keep-changelog]: https://keepachangelog.com/en/1.0.0/
|
640
|
+
[📗keep-changelog-img]: https://img.shields.io/badge/keep--a--changelog-1.0.0-34495e.svg?style=flat
|
641
|
+
[📌gitmoji]:https://gitmoji.dev
|
642
|
+
[📌gitmoji-img]:https://img.shields.io/badge/gitmoji_commits-%20😜%20😍-34495e.svg?style=flat-square
|
643
|
+
[🧮kloc]: https://www.youtube.com/watch?v=dQw4w9WgXcQ
|
644
|
+
[🧮kloc-img]: https://img.shields.io/badge/KLOC-0.069-FFDD67.svg?style=for-the-badge&logo=YouTube&logoColor=blue
|
645
|
+
[🔐security]: SECURITY.md
|
646
|
+
[🔐security-img]: https://img.shields.io/badge/security-policy-259D6C.svg?style=flat
|
647
|
+
[📄copyright-notice-explainer]: https://opensource.stackexchange.com/questions/5778/why-do-licenses-such-as-the-mit-license-specify-a-single-year
|
648
|
+
[📄license]: LICENSE.txt
|
649
|
+
[📄license-ref]: https://opensource.org/licenses/MIT
|
650
|
+
[📄license-img]: https://img.shields.io/badge/License-MIT-259D6C.svg
|
651
|
+
[📄ilo-declaration]: https://www.ilo.org/declaration/lang--en/index.htm
|
652
|
+
[📄ilo-declaration-img]: https://img.shields.io/badge/ILO_Fundamental_Principles-✓-259D6C.svg?style=flat
|
653
|
+
[🚎yard-current]: http://rubydoc.info/gems/kettle-dev
|
654
|
+
[🚎yard-head]: https://rspec-stubbed-env.galtzo.com
|
655
|
+
[💎stone_checksums]: https://github.com/galtzo-floss/stone_checksums
|
656
|
+
[💎SHA_checksums]: https://gitlab.com/kettle-rb/kettle-dev/-/tree/main/checksums
|
657
|
+
[💎rlts]: https://github.com/rubocop-lts/rubocop-lts
|
658
|
+
[💎rlts-img]: https://img.shields.io/badge/code_style_%26_linting-rubocop--lts-34495e.svg?plastic&logo=ruby&logoColor=white
|
659
|
+
[💎appraisal2]: https://github.com/appraisal-rb/appraisal2
|
660
|
+
[💎appraisal2-img]: https://img.shields.io/badge/appraised_by-appraisal2-34495e.svg?plastic&logo=ruby&logoColor=white
|
661
|
+
[💎d-in-dvcs]: https://railsbling.com/posts/dvcs/put_the_d_in_dvcs/
|