appraisal2 3.1.4 → 3.2.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 +4 -4
- checksums.yaml.gz.sig +0 -0
- data/CHANGELOG.md +50 -1
- data/README.md +32 -2
- data/lib/appraisal/appraisal.rb +1 -1
- data/lib/appraisal/cli.rb +129 -20
- data/lib/appraisal/command.rb +125 -78
- data/lib/appraisal/gem_manager/bundler_adapter.rb +15 -2
- data/lib/appraisal/utils.rb +4 -0
- data/lib/appraisal2/version.rb +1 -1
- data.tar.gz.sig +0 -0
- metadata +21 -38
- metadata.gz.sig +0 -0
- data/CITATION.cff +0 -20
- data/CODE_OF_CONDUCT.md +0 -134
- data/CONTRIBUTING.md +0 -275
- data/FUNDING.md +0 -70
- data/MIT.md +0 -21
- data/RUBOCOP.md +0 -71
- data/SECURITY.md +0 -21
- data/certs/pboling.pem +0 -27
- /data/sig/{appraisal2/version.rbs → appraisal2.rbs} +0 -0
|
@@ -2,6 +2,8 @@
|
|
|
2
2
|
|
|
3
3
|
require "shellwords"
|
|
4
4
|
|
|
5
|
+
require "appraisal/utils"
|
|
6
|
+
|
|
5
7
|
require_relative "base"
|
|
6
8
|
|
|
7
9
|
module Appraisal
|
|
@@ -53,7 +55,16 @@ module Appraisal
|
|
|
53
55
|
end
|
|
54
56
|
|
|
55
57
|
def update_command(gems)
|
|
56
|
-
|
|
58
|
+
gems = Array(gems).compact
|
|
59
|
+
return full_update_command if gems.empty?
|
|
60
|
+
|
|
61
|
+
["bundle", "update", *gems]
|
|
62
|
+
end
|
|
63
|
+
|
|
64
|
+
def full_update_command
|
|
65
|
+
return ["bundle", "update", "--all"] if Utils.support_bundle_update_all?
|
|
66
|
+
|
|
67
|
+
["bundle", "update"]
|
|
57
68
|
end
|
|
58
69
|
|
|
59
70
|
def bundle_options(options)
|
|
@@ -85,12 +96,14 @@ module Appraisal
|
|
|
85
96
|
end
|
|
86
97
|
|
|
87
98
|
def install_environment(options)
|
|
88
|
-
env = {}
|
|
99
|
+
env = {"BUNDLE_JOBS" => DEFAULT_INSTALL_OPTIONS.fetch("jobs").to_s}
|
|
89
100
|
|
|
90
101
|
if options["path"].nil? && Bundler.settings[:path]
|
|
91
102
|
env["BUNDLE_DISABLE_SHARED_GEMS"] = "1"
|
|
92
103
|
end
|
|
93
104
|
|
|
105
|
+
env["BUNDLE_JOBS"] = options["jobs"].to_s if options["jobs"].to_i > 1 && Utils.support_parallel_installation?
|
|
106
|
+
|
|
94
107
|
env
|
|
95
108
|
end
|
|
96
109
|
end
|
data/lib/appraisal/utils.rb
CHANGED
|
@@ -12,6 +12,10 @@ module Appraisal
|
|
|
12
12
|
Gem::Version.create(Bundler::VERSION) > Gem::Version.create("2.4.22")
|
|
13
13
|
end
|
|
14
14
|
|
|
15
|
+
def support_bundle_update_all?
|
|
16
|
+
Gem::Version.create(Bundler::VERSION) >= Gem::Version.create("1.16.5")
|
|
17
|
+
end
|
|
18
|
+
|
|
15
19
|
# Appraisal needs to print Gemfiles in the oldest Ruby syntax that is supported by Appraisal.
|
|
16
20
|
# Otherwise, a project would not be able to use Appraisal to test compatibility
|
|
17
21
|
# with older versions of Ruby, which is a core use case for Appraisal.
|
data/lib/appraisal2/version.rb
CHANGED
data.tar.gz.sig
CHANGED
|
Binary file
|
metadata
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: appraisal2
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 3.
|
|
4
|
+
version: 3.2.0
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Joe Ferris
|
|
@@ -121,20 +121,20 @@ dependencies:
|
|
|
121
121
|
requirements:
|
|
122
122
|
- - "~>"
|
|
123
123
|
- !ruby/object:Gem::Version
|
|
124
|
-
version: '2.
|
|
124
|
+
version: '2.3'
|
|
125
125
|
- - ">="
|
|
126
126
|
- !ruby/object:Gem::Version
|
|
127
|
-
version: 2.
|
|
127
|
+
version: 2.3.6
|
|
128
128
|
type: :development
|
|
129
129
|
prerelease: false
|
|
130
130
|
version_requirements: !ruby/object:Gem::Requirement
|
|
131
131
|
requirements:
|
|
132
132
|
- - "~>"
|
|
133
133
|
- !ruby/object:Gem::Version
|
|
134
|
-
version: '2.
|
|
134
|
+
version: '2.3'
|
|
135
135
|
- - ">="
|
|
136
136
|
- !ruby/object:Gem::Version
|
|
137
|
-
version: 2.
|
|
137
|
+
version: 2.3.6
|
|
138
138
|
- !ruby/object:Gem::Dependency
|
|
139
139
|
name: bundler-audit
|
|
140
140
|
requirement: !ruby/object:Gem::Requirement
|
|
@@ -178,7 +178,7 @@ dependencies:
|
|
|
178
178
|
version: '2.0'
|
|
179
179
|
- - ">="
|
|
180
180
|
- !ruby/object:Gem::Version
|
|
181
|
-
version: 2.0.
|
|
181
|
+
version: 2.0.11
|
|
182
182
|
type: :development
|
|
183
183
|
prerelease: false
|
|
184
184
|
version_requirements: !ruby/object:Gem::Requirement
|
|
@@ -188,7 +188,7 @@ dependencies:
|
|
|
188
188
|
version: '2.0'
|
|
189
189
|
- - ">="
|
|
190
190
|
- !ruby/object:Gem::Version
|
|
191
|
-
version: 2.0.
|
|
191
|
+
version: 2.0.11
|
|
192
192
|
- !ruby/object:Gem::Dependency
|
|
193
193
|
name: turbo_tests2
|
|
194
194
|
requirement: !ruby/object:Gem::Requirement
|
|
@@ -198,7 +198,7 @@ dependencies:
|
|
|
198
198
|
version: '3.1'
|
|
199
199
|
- - ">="
|
|
200
200
|
- !ruby/object:Gem::Version
|
|
201
|
-
version: 3.1.
|
|
201
|
+
version: 3.1.14
|
|
202
202
|
type: :development
|
|
203
203
|
prerelease: false
|
|
204
204
|
version_requirements: !ruby/object:Gem::Requirement
|
|
@@ -208,7 +208,7 @@ dependencies:
|
|
|
208
208
|
version: '3.1'
|
|
209
209
|
- - ">="
|
|
210
210
|
- !ruby/object:Gem::Version
|
|
211
|
-
version: 3.1.
|
|
211
|
+
version: 3.1.14
|
|
212
212
|
- !ruby/object:Gem::Dependency
|
|
213
213
|
name: ruby-progressbar
|
|
214
214
|
requirement: !ruby/object:Gem::Requirement
|
|
@@ -232,7 +232,7 @@ dependencies:
|
|
|
232
232
|
version: '1.0'
|
|
233
233
|
- - ">="
|
|
234
234
|
- !ruby/object:Gem::Version
|
|
235
|
-
version: 1.0.
|
|
235
|
+
version: 1.0.6
|
|
236
236
|
type: :development
|
|
237
237
|
prerelease: false
|
|
238
238
|
version_requirements: !ruby/object:Gem::Requirement
|
|
@@ -242,7 +242,7 @@ dependencies:
|
|
|
242
242
|
version: '1.0'
|
|
243
243
|
- - ">="
|
|
244
244
|
- !ruby/object:Gem::Version
|
|
245
|
-
version: 1.0.
|
|
245
|
+
version: 1.0.6
|
|
246
246
|
- !ruby/object:Gem::Dependency
|
|
247
247
|
name: gitmoji-regex
|
|
248
248
|
requirement: !ruby/object:Gem::Requirement
|
|
@@ -252,7 +252,7 @@ dependencies:
|
|
|
252
252
|
version: '2.0'
|
|
253
253
|
- - ">="
|
|
254
254
|
- !ruby/object:Gem::Version
|
|
255
|
-
version: 2.0.
|
|
255
|
+
version: 2.0.4
|
|
256
256
|
type: :development
|
|
257
257
|
prerelease: false
|
|
258
258
|
version_requirements: !ruby/object:Gem::Requirement
|
|
@@ -262,7 +262,7 @@ dependencies:
|
|
|
262
262
|
version: '2.0'
|
|
263
263
|
- - ">="
|
|
264
264
|
- !ruby/object:Gem::Version
|
|
265
|
-
version: 2.0.
|
|
265
|
+
version: 2.0.4
|
|
266
266
|
- !ruby/object:Gem::Dependency
|
|
267
267
|
name: activesupport
|
|
268
268
|
requirement: !ruby/object:Gem::Requirement
|
|
@@ -354,7 +354,7 @@ dependencies:
|
|
|
354
354
|
version: '1.0'
|
|
355
355
|
- - ">="
|
|
356
356
|
- !ruby/object:Gem::Version
|
|
357
|
-
version: 1.0.
|
|
357
|
+
version: 1.0.6
|
|
358
358
|
type: :development
|
|
359
359
|
prerelease: false
|
|
360
360
|
version_requirements: !ruby/object:Gem::Requirement
|
|
@@ -364,7 +364,7 @@ dependencies:
|
|
|
364
364
|
version: '1.0'
|
|
365
365
|
- - ">="
|
|
366
366
|
- !ruby/object:Gem::Version
|
|
367
|
-
version: 1.0.
|
|
367
|
+
version: 1.0.6
|
|
368
368
|
- !ruby/object:Gem::Dependency
|
|
369
369
|
name: silent_stream
|
|
370
370
|
requirement: !ruby/object:Gem::Requirement
|
|
@@ -393,28 +393,11 @@ email:
|
|
|
393
393
|
executables:
|
|
394
394
|
- appraisal
|
|
395
395
|
extensions: []
|
|
396
|
-
extra_rdoc_files:
|
|
397
|
-
- CHANGELOG.md
|
|
398
|
-
- CITATION.cff
|
|
399
|
-
- CODE_OF_CONDUCT.md
|
|
400
|
-
- CONTRIBUTING.md
|
|
401
|
-
- FUNDING.md
|
|
402
|
-
- LICENSE.md
|
|
403
|
-
- README.md
|
|
404
|
-
- RUBOCOP.md
|
|
405
|
-
- SECURITY.md
|
|
396
|
+
extra_rdoc_files: []
|
|
406
397
|
files:
|
|
407
398
|
- CHANGELOG.md
|
|
408
|
-
- CITATION.cff
|
|
409
|
-
- CODE_OF_CONDUCT.md
|
|
410
|
-
- CONTRIBUTING.md
|
|
411
|
-
- FUNDING.md
|
|
412
399
|
- LICENSE.md
|
|
413
|
-
- MIT.md
|
|
414
400
|
- README.md
|
|
415
|
-
- RUBOCOP.md
|
|
416
|
-
- SECURITY.md
|
|
417
|
-
- certs/pboling.pem
|
|
418
401
|
- exe/appraisal
|
|
419
402
|
- lib/appraisal.rb
|
|
420
403
|
- lib/appraisal/appraisal.rb
|
|
@@ -446,16 +429,16 @@ files:
|
|
|
446
429
|
- lib/appraisal/version.rb
|
|
447
430
|
- lib/appraisal2.rb
|
|
448
431
|
- lib/appraisal2/version.rb
|
|
449
|
-
- sig/appraisal2
|
|
432
|
+
- sig/appraisal2.rbs
|
|
450
433
|
homepage: https://github.com/appraisal-rb/appraisal2
|
|
451
434
|
licenses:
|
|
452
435
|
- MIT
|
|
453
436
|
metadata:
|
|
454
437
|
homepage_uri: https://appraisal2.galtzo.com
|
|
455
|
-
source_code_uri: https://github.com/appraisal-rb/appraisal2/tree/v3.
|
|
456
|
-
changelog_uri: https://github.com/appraisal-rb/appraisal2/blob/v3.
|
|
438
|
+
source_code_uri: https://github.com/appraisal-rb/appraisal2/tree/v3.2.0
|
|
439
|
+
changelog_uri: https://github.com/appraisal-rb/appraisal2/blob/v3.2.0/CHANGELOG.md
|
|
457
440
|
bug_tracker_uri: https://github.com/appraisal-rb/appraisal2/issues
|
|
458
|
-
documentation_uri: https://www.rubydoc.info/gems/appraisal2/3.
|
|
441
|
+
documentation_uri: https://www.rubydoc.info/gems/appraisal2/3.2.0
|
|
459
442
|
funding_uri: https://github.com/sponsors/pboling
|
|
460
443
|
wiki_uri: https://github.com/appraisal-rb/appraisal2/wiki
|
|
461
444
|
news_uri: https://www.railsbling.com/tags/appraisal2
|
|
@@ -484,7 +467,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
|
484
467
|
- !ruby/object:Gem::Version
|
|
485
468
|
version: '0'
|
|
486
469
|
requirements: []
|
|
487
|
-
rubygems_version: 4.0.
|
|
470
|
+
rubygems_version: 4.0.16
|
|
488
471
|
specification_version: 4
|
|
489
472
|
summary: "\U0001F50D️ Find out what your Ruby gems are worth"
|
|
490
473
|
test_files: []
|
metadata.gz.sig
CHANGED
|
Binary file
|
data/CITATION.cff
DELETED
|
@@ -1,20 +0,0 @@
|
|
|
1
|
-
cff-version: 1.2.0
|
|
2
|
-
title: "appraisal2"
|
|
3
|
-
message: >-
|
|
4
|
-
If you use this work and you want to cite it,
|
|
5
|
-
then you can use the metadata from this file.
|
|
6
|
-
type: software
|
|
7
|
-
authors:
|
|
8
|
-
- given-names: "Peter H."
|
|
9
|
-
family-names: "Boling"
|
|
10
|
-
email: "floss@galtzo.com"
|
|
11
|
-
affiliation: "galtzo.com"
|
|
12
|
-
orcid: 'https://orcid.org/0009-0008-8519-441X'
|
|
13
|
-
identifiers:
|
|
14
|
-
- type: url
|
|
15
|
-
value: 'https://github.com/appraisal-rb/appraisal2'
|
|
16
|
-
description: "appraisal2"
|
|
17
|
-
repository-code: 'https://github.com/appraisal-rb/appraisal2'
|
|
18
|
-
abstract: >-
|
|
19
|
-
appraisal2
|
|
20
|
-
license: See license file
|
data/CODE_OF_CONDUCT.md
DELETED
|
@@ -1,134 +0,0 @@
|
|
|
1
|
-
# Contributor Covenant Code of Conduct
|
|
2
|
-
|
|
3
|
-
## Our Pledge
|
|
4
|
-
|
|
5
|
-
We as members, contributors, and leaders pledge to make participation in our
|
|
6
|
-
community a harassment-free experience for everyone, regardless of age, body
|
|
7
|
-
size, visible or invisible disability, ethnicity, sex characteristics, gender
|
|
8
|
-
identity and expression, level of experience, education, socio-economic status,
|
|
9
|
-
nationality, personal appearance, race, caste, color, religion, or sexual
|
|
10
|
-
identity and orientation.
|
|
11
|
-
|
|
12
|
-
We pledge to act and interact in ways that contribute to an open, welcoming,
|
|
13
|
-
diverse, inclusive, and healthy community.
|
|
14
|
-
|
|
15
|
-
## Our Standards
|
|
16
|
-
|
|
17
|
-
Examples of behavior that contributes to a positive environment for our
|
|
18
|
-
community include:
|
|
19
|
-
|
|
20
|
-
* Demonstrating empathy and kindness toward other people
|
|
21
|
-
* Being respectful of differing opinions, viewpoints, and experiences
|
|
22
|
-
* Giving and gracefully accepting constructive feedback
|
|
23
|
-
* Accepting responsibility and apologizing to those affected by our mistakes,
|
|
24
|
-
and learning from the experience
|
|
25
|
-
* Focusing on what is best not just for us as individuals, but for the overall
|
|
26
|
-
community
|
|
27
|
-
|
|
28
|
-
Examples of unacceptable behavior include:
|
|
29
|
-
|
|
30
|
-
* The use of sexualized language or imagery, and sexual attention or advances of
|
|
31
|
-
any kind
|
|
32
|
-
* Trolling, insulting or derogatory comments, and personal or political attacks
|
|
33
|
-
* Public or private harassment
|
|
34
|
-
* Publishing others' private information, such as a physical or email address,
|
|
35
|
-
without their explicit permission
|
|
36
|
-
* Other conduct which could reasonably be considered inappropriate in a
|
|
37
|
-
professional setting
|
|
38
|
-
|
|
39
|
-
## Enforcement Responsibilities
|
|
40
|
-
|
|
41
|
-
Community leaders are responsible for clarifying and enforcing our standards of
|
|
42
|
-
acceptable behavior and will take appropriate and fair corrective action in
|
|
43
|
-
response to any behavior that they deem inappropriate, threatening, offensive,
|
|
44
|
-
or harmful.
|
|
45
|
-
|
|
46
|
-
Community leaders have the right and responsibility to remove, edit, or reject
|
|
47
|
-
comments, commits, code, wiki edits, issues, and other contributions that are
|
|
48
|
-
not aligned to this Code of Conduct, and will communicate reasons for moderation
|
|
49
|
-
decisions when appropriate.
|
|
50
|
-
|
|
51
|
-
## Scope
|
|
52
|
-
|
|
53
|
-
This Code of Conduct applies within all community spaces, and also applies when
|
|
54
|
-
an individual is officially representing the community in public spaces.
|
|
55
|
-
Examples of representing our community include using an official email address,
|
|
56
|
-
posting via an official social media account, or acting as an appointed
|
|
57
|
-
representative at an online or offline event.
|
|
58
|
-
|
|
59
|
-
## Enforcement
|
|
60
|
-
|
|
61
|
-
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
|
62
|
-
reported to the community leaders responsible for enforcement at
|
|
63
|
-
[![Contact Maintainer][🚂maint-contact-img]][🚂maint-contact].
|
|
64
|
-
All complaints will be reviewed and investigated promptly and fairly.
|
|
65
|
-
|
|
66
|
-
All community leaders are obligated to respect the privacy and security of the
|
|
67
|
-
reporter of any incident.
|
|
68
|
-
|
|
69
|
-
## Enforcement Guidelines
|
|
70
|
-
|
|
71
|
-
Community leaders will follow these Community Impact Guidelines in determining
|
|
72
|
-
the consequences for any action they deem in violation of this Code of Conduct:
|
|
73
|
-
|
|
74
|
-
### 1. Correction
|
|
75
|
-
|
|
76
|
-
**Community Impact**: Use of inappropriate language or other behavior deemed
|
|
77
|
-
unprofessional or unwelcome in the community.
|
|
78
|
-
|
|
79
|
-
**Consequence**: A private, written warning from community leaders, providing
|
|
80
|
-
clarity around the nature of the violation and an explanation of why the
|
|
81
|
-
behavior was inappropriate. A public apology may be requested.
|
|
82
|
-
|
|
83
|
-
### 2. Warning
|
|
84
|
-
|
|
85
|
-
**Community Impact**: A violation through a single incident or series of
|
|
86
|
-
actions.
|
|
87
|
-
|
|
88
|
-
**Consequence**: A warning with consequences for continued behavior. No
|
|
89
|
-
interaction with the people involved, including unsolicited interaction with
|
|
90
|
-
those enforcing the Code of Conduct, for a specified period of time. This
|
|
91
|
-
includes avoiding interactions in community spaces as well as external channels
|
|
92
|
-
like social media. Violating these terms may lead to a temporary or permanent
|
|
93
|
-
ban.
|
|
94
|
-
|
|
95
|
-
### 3. Temporary Ban
|
|
96
|
-
|
|
97
|
-
**Community Impact**: A serious violation of community standards, including
|
|
98
|
-
sustained inappropriate behavior.
|
|
99
|
-
|
|
100
|
-
**Consequence**: A temporary ban from any sort of interaction or public
|
|
101
|
-
communication with the community for a specified period of time. No public or
|
|
102
|
-
private interaction with the people involved, including unsolicited interaction
|
|
103
|
-
with those enforcing the Code of Conduct, is allowed during this period.
|
|
104
|
-
Violating these terms may lead to a permanent ban.
|
|
105
|
-
|
|
106
|
-
### 4. Permanent Ban
|
|
107
|
-
|
|
108
|
-
**Community Impact**: Demonstrating a pattern of violation of community
|
|
109
|
-
standards, including sustained inappropriate behavior, harassment of an
|
|
110
|
-
individual, or aggression toward or disparagement of classes of individuals.
|
|
111
|
-
|
|
112
|
-
**Consequence**: A permanent ban from any sort of public interaction within the
|
|
113
|
-
community.
|
|
114
|
-
|
|
115
|
-
## Attribution
|
|
116
|
-
|
|
117
|
-
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
|
|
118
|
-
version 2.1, available at
|
|
119
|
-
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
|
|
120
|
-
|
|
121
|
-
Community Impact Guidelines were inspired by
|
|
122
|
-
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
|
|
123
|
-
|
|
124
|
-
For answers to common questions about this code of conduct, see the FAQ at
|
|
125
|
-
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
|
|
126
|
-
[https://www.contributor-covenant.org/translations][translations].
|
|
127
|
-
|
|
128
|
-
[homepage]: https://www.contributor-covenant.org
|
|
129
|
-
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
|
|
130
|
-
[Mozilla CoC]: https://github.com/mozilla/diversity
|
|
131
|
-
[FAQ]: https://www.contributor-covenant.org/faq
|
|
132
|
-
[translations]: https://www.contributor-covenant.org/translations
|
|
133
|
-
[🚂maint-contact]: http://www.railsbling.com/contact
|
|
134
|
-
[🚂maint-contact-img]: https://img.shields.io/badge/Contact-Maintainer-0093D0.svg?style=flat&logo=rubyonrails&logoColor=red
|
data/CONTRIBUTING.md
DELETED
|
@@ -1,275 +0,0 @@
|
|
|
1
|
-
# Contributing
|
|
2
|
-
|
|
3
|
-
Bug reports and pull requests are welcome on [CodeBerg][📜src-cb], [GitLab][📜src-gl], or [GitHub][📜src-gh].
|
|
4
|
-
This project should be a safe, welcoming space for collaboration, so contributors agree to adhere to
|
|
5
|
-
the [code of conduct][🤝conduct].
|
|
6
|
-
|
|
7
|
-
To submit a patch, please fork the project, create a patch with tests, and send a pull request.
|
|
8
|
-
|
|
9
|
-
Remember to [![Keep A Changelog][📗keep-changelog-img]][📗keep-changelog] if you make changes.
|
|
10
|
-
|
|
11
|
-
## Developer Certificate of Origin
|
|
12
|
-
|
|
13
|
-
In order to protect users of this project, we require all contributors to comply with the
|
|
14
|
-
[Developer Certificate of Origin](https://developercertificate.org/).
|
|
15
|
-
This ensures that all contributions are properly licensed and attributed.
|
|
16
|
-
|
|
17
|
-
## Help out!
|
|
18
|
-
|
|
19
|
-
Take a look at the open issues and pull requests, or use the gem and find something to improve.
|
|
20
|
-
|
|
21
|
-
Follow these instructions:
|
|
22
|
-
|
|
23
|
-
1. Join the Discord: [![Live Chat on Discord][✉️discord-invite-img]][✉️discord-invite]
|
|
24
|
-
2. Fork the repository
|
|
25
|
-
3. Create your feature branch (`git checkout -b my-new-feature`)
|
|
26
|
-
4. Make some fixes.
|
|
27
|
-
5. Commit your changes (`git commit -am 'Added some feature'`)
|
|
28
|
-
6. Push to the branch (`git push origin my-new-feature`)
|
|
29
|
-
7. Make sure to add tests for it. This is important, so it doesn't break in a future release.
|
|
30
|
-
8. Create new Pull Request.
|
|
31
|
-
9. Announce it in the channel for this org in the [Discord][✉️discord-invite]!
|
|
32
|
-
|
|
33
|
-
## Executables vs Rake tasks
|
|
34
|
-
|
|
35
|
-
Executables shipped by dependencies, such as kettle-dev, and stone_checksums, are available
|
|
36
|
-
after running `bin/setup`. These include:
|
|
37
|
-
|
|
38
|
-
- gem_checksums
|
|
39
|
-
- kettle-changelog
|
|
40
|
-
- kettle-commit-msg
|
|
41
|
-
- kettle-dev-setup
|
|
42
|
-
- kettle-dvcs
|
|
43
|
-
- kettle-pre-release
|
|
44
|
-
- kettle-readme-backers
|
|
45
|
-
- kettle-release
|
|
46
|
-
|
|
47
|
-
There are many Rake tasks available as well. You can see them by running:
|
|
48
|
-
|
|
49
|
-
```shell
|
|
50
|
-
bin/rake -T
|
|
51
|
-
```
|
|
52
|
-
|
|
53
|
-
## Code quality checks
|
|
54
|
-
|
|
55
|
-
Run the Reek task when you want a smell check that fails on current findings:
|
|
56
|
-
|
|
57
|
-
```shell
|
|
58
|
-
bin/rake reek
|
|
59
|
-
```
|
|
60
|
-
|
|
61
|
-
Refresh the checked-in `REEK` backlog through the rake task, not by redirecting
|
|
62
|
-
the raw `reek` executable output. The rake task uses the project bundle and
|
|
63
|
-
avoids stale generated binstubs shadowing the Reek gem executable:
|
|
64
|
-
|
|
65
|
-
```shell
|
|
66
|
-
bin/rake reek:update
|
|
67
|
-
```
|
|
68
|
-
|
|
69
|
-
## Environment Variables for Local Development
|
|
70
|
-
|
|
71
|
-
Below are the primary environment variables recognized by stone_checksums (and its integrated tools). Unless otherwise noted, set boolean values to the string "true" to enable.
|
|
72
|
-
|
|
73
|
-
General/runtime
|
|
74
|
-
- DEBUG: Enable extra internal logging for this library (default: false)
|
|
75
|
-
- REQUIRE_BENCH: Enable `require_bench` to profile requires (default: false)
|
|
76
|
-
- CI: When set to true, adjusts default rake tasks toward CI behavior
|
|
77
|
-
|
|
78
|
-
Coverage (kettle-soup-cover / SimpleCov)
|
|
79
|
-
- K_SOUP_COV_DO: Enable coverage collection (default: true in `mise.toml`)
|
|
80
|
-
- K_SOUP_COV_FORMATTERS: Comma-separated list of formatters (html, xml, rcov, lcov, json, tty)
|
|
81
|
-
- K_SOUP_COV_MIN_LINE: Minimum line coverage threshold (integer, e.g., 100)
|
|
82
|
-
- K_SOUP_COV_MIN_BRANCH: Minimum branch coverage threshold (integer, e.g., 100)
|
|
83
|
-
- K_SOUP_COV_MIN_HARD: Fail the run if thresholds are not met (true/false)
|
|
84
|
-
- K_SOUP_COV_MULTI_FORMATTERS: Enable multiple formatters at once (true/false)
|
|
85
|
-
- K_SOUP_COV_OPEN_BIN: Path to browser opener for HTML (empty disables auto-open)
|
|
86
|
-
- MAX_ROWS: Limit console output rows for simplecov-console (e.g., 1)
|
|
87
|
-
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.
|
|
88
|
-
|
|
89
|
-
GitHub API and CI helpers
|
|
90
|
-
- GITHUB_TOKEN or GH_TOKEN: Token used by `ci:act` and release workflow checks to query GitHub Actions status at higher rate limits
|
|
91
|
-
|
|
92
|
-
Releasing and signing
|
|
93
|
-
- SKIP_GEM_SIGNING: If set, skip gem signing during build/release
|
|
94
|
-
- GEM_CERT_USER: Username for selecting your public cert in `certs/<USER>.pem` (defaults to $USER)
|
|
95
|
-
- SOURCE_DATE_EPOCH: Reproducible build timestamp.
|
|
96
|
-
- `kettle-release` will set this automatically for the session.
|
|
97
|
-
- Not needed on bundler >= 2.7.0, as reproducible builds have become the default.
|
|
98
|
-
|
|
99
|
-
Git hooks and commit message helpers (exe/kettle-commit-msg)
|
|
100
|
-
- GIT_HOOK_BRANCH_VALIDATE: Branch name validation mode (e.g., `jira`) or `false` to disable
|
|
101
|
-
- GIT_HOOK_FOOTER_APPEND: Append a footer to commit messages when goalie allows (true/false)
|
|
102
|
-
- GIT_HOOK_FOOTER_SENTINEL: Required when footer append is enabled — a unique first-line sentinel to prevent duplicates
|
|
103
|
-
- GIT_HOOK_FOOTER_APPEND_DEBUG: Extra debug output in the footer template (true/false)
|
|
104
|
-
|
|
105
|
-
Git diff driver setup
|
|
106
|
-
- Local setup writes repository `.gitattributes` entries and local Git `diff.smorg-*` command config so this checkout uses StructuredMerge semantic diffs.
|
|
107
|
-
- Global setup registers `diff.smorg-*` commands once in the user Git config; use it when you work across several StructuredMerge-enabled repositories.
|
|
108
|
-
- Include-file setup writes `.git/smorg/config` and includes it from local Git config, keeping command registrations out of the repository files.
|
|
109
|
-
- Git hosting forges generally ignore external diff drivers, so pull request views may still show raw textual diffs even when local `git diff` uses semantic drivers.
|
|
110
|
-
|
|
111
|
-
```console
|
|
112
|
-
K_JEM_TEMPLATING=true kettle-jem install
|
|
113
|
-
```
|
|
114
|
-
|
|
115
|
-
Troubleshooting Git diffs
|
|
116
|
-
- Use `git diff --no-ext-diff` to compare against Git's built-in diff output.
|
|
117
|
-
- Use `git diff --no-textconv` when a textconv projection obscures the raw file bytes you need to inspect.
|
|
118
|
-
- If Git reports a missing `smorg-*` executable, rerun `bundle install` and the setup command above, then check `git config --local --get-regexp '^diff\.smorg-'`.
|
|
119
|
-
- To remove managed local entries, run `K_JEM_TEMPLATING=true kettle-jem install --undo`; remove global command registrations with `git config --global --unset-all diff.smorg-ruby.command`.
|
|
120
|
-
|
|
121
|
-
For a quick starting point, this repository’s `mise.toml` defines the shared defaults, and `.env.local` can override them locally. Copy `.env.local.example` to `.env.local`, use `KEY=value` lines, and either activate `mise` in your shell or run commands through `mise exec -C /path/to/project -- ...`.
|
|
122
|
-
|
|
123
|
-
## Appraisals
|
|
124
|
-
|
|
125
|
-
From time to time the [appraisal2][🚎appraisal2] gemfiles in `gemfiles/` will need to be updated.
|
|
126
|
-
Generated appraisal and CI workflow floors are controlled by `ruby.test_minimum`
|
|
127
|
-
in `.structuredmerge/kettle-jem.yml`; this project was templated with `ruby.test_minimum: 2.4`.
|
|
128
|
-
That value describes the lowest Ruby version expected to run the test/development
|
|
129
|
-
toolchain, and it may be higher than the gemspec runtime floor.
|
|
130
|
-
|
|
131
|
-
They are created and updated with the commands:
|
|
132
|
-
|
|
133
|
-
```console
|
|
134
|
-
bin/rake appraisal:generate
|
|
135
|
-
```
|
|
136
|
-
|
|
137
|
-
Use `bin/rake appraisal:update` when you intentionally need to resolve fresh
|
|
138
|
-
appraisal locks.
|
|
139
|
-
|
|
140
|
-
If you need to reset all gemfiles/*.gemfile.lock files:
|
|
141
|
-
|
|
142
|
-
```console
|
|
143
|
-
bin/rake appraisal:reset
|
|
144
|
-
```
|
|
145
|
-
|
|
146
|
-
When adding an appraisal to CI, check the [runner tool cache][🏃♂️runner-tool-cache] to see which runner to use.
|
|
147
|
-
|
|
148
|
-
## Run Tests
|
|
149
|
-
|
|
150
|
-
Run tests via `kettle-test` (provided by `kettle-test`). It runs RSpec, writes the full log to
|
|
151
|
-
`tmp/kettle-test/rspec-TIMESTAMP.log`, and prints a compact highlight block with timing, seed,
|
|
152
|
-
pass/fail count, failing example list, and SimpleCov coverage percentages.
|
|
153
|
-
|
|
154
|
-
```console
|
|
155
|
-
bundle exec kettle-test
|
|
156
|
-
```
|
|
157
|
-
|
|
158
|
-
For targeted runs, disable the hard coverage threshold to avoid false failures:
|
|
159
|
-
|
|
160
|
-
```console
|
|
161
|
-
K_SOUP_COV_MIN_HARD=false bundle exec kettle-test spec/path/to/spec.rb
|
|
162
|
-
```
|
|
163
|
-
|
|
164
|
-
### Spec organization (required)
|
|
165
|
-
|
|
166
|
-
- One spec file per class/module. For each class or module under `lib/`, keep all of its unit tests in a single spec file under `spec/` that mirrors the path and file name exactly: `lib/appraisal2/my_class.rb` -> `spec/appraisal2/my_class_spec.rb`.
|
|
167
|
-
- Exception: Integration specs that intentionally span multiple classes. Place these under `spec/integration/` (or a clearly named integration folder), and do not directly mirror a single class. Name them after the scenario, not a class.
|
|
168
|
-
|
|
169
|
-
## Lint It
|
|
170
|
-
|
|
171
|
-
Run all the default tasks, which includes running the gradually autocorrecting linter, `rubocop-gradual`.
|
|
172
|
-
|
|
173
|
-
```console
|
|
174
|
-
bundle exec rake
|
|
175
|
-
```
|
|
176
|
-
|
|
177
|
-
Or just run the linter.
|
|
178
|
-
|
|
179
|
-
```console
|
|
180
|
-
bundle exec rake rubocop_gradual:autocorrect
|
|
181
|
-
```
|
|
182
|
-
|
|
183
|
-
For more detailed information about using RuboCop in this project, please see the [RUBOCOP.md](RUBOCOP.md) guide. This project uses `rubocop_gradual` instead of vanilla RuboCop, which requires specific commands for checking violations.
|
|
184
|
-
|
|
185
|
-
### Important: Do not add inline RuboCop disables
|
|
186
|
-
|
|
187
|
-
Never add `# rubocop:disable ...` / `# rubocop:enable ...` comments to code or specs (except when following the few existing `rubocop:disable` patterns for a rule already being disabled elsewhere in the code). Instead:
|
|
188
|
-
|
|
189
|
-
- Prefer configuration-based exclusions when a rule should not apply to certain paths or files (e.g., via `.rubocop.yml`).
|
|
190
|
-
- When a violation is temporary, and you plan to fix it later, record it in `.rubocop_gradual.lock` using the gradual workflow:
|
|
191
|
-
- `bundle exec rake rubocop_gradual:autocorrect` (preferred)
|
|
192
|
-
- `bundle exec rake rubocop_gradual:force_update` (only when you cannot fix the violations immediately)
|
|
193
|
-
|
|
194
|
-
As a general rule, fix style issues rather than ignoring them. For example, our specs should follow RSpec conventions like using `described_class` for the class under test.
|
|
195
|
-
|
|
196
|
-
## Contributors
|
|
197
|
-
|
|
198
|
-
Your picture could be here!
|
|
199
|
-
|
|
200
|
-
[![Contributors][🖐contributors-img]][🖐contributors]
|
|
201
|
-
|
|
202
|
-
Made with [contributors-img][🖐contrib-rocks].
|
|
203
|
-
|
|
204
|
-
Also see GitLab Contributors: [https://gitlab.com/appraisal-rb/appraisal2/-/graphs/main][🚎contributors-gl]
|
|
205
|
-
|
|
206
|
-
## For Maintainers
|
|
207
|
-
|
|
208
|
-
### One-time, Per-maintainer, Setup
|
|
209
|
-
|
|
210
|
-
**IMPORTANT**: To sign a build,
|
|
211
|
-
a public key for signing gems will need to be picked up by the line in the
|
|
212
|
-
`gemspec` defining the `spec.cert_chain` (check the relevant ENV variables there).
|
|
213
|
-
All releases are signed releases.
|
|
214
|
-
See: [RubyGems Security Guide][🔒️rubygems-security-guide]
|
|
215
|
-
|
|
216
|
-
NOTE: To build without signing the gem set `SKIP_GEM_SIGNING` to any value in the environment.
|
|
217
|
-
|
|
218
|
-
### To release a new version:
|
|
219
|
-
|
|
220
|
-
#### Automated process
|
|
221
|
-
|
|
222
|
-
1. Update version.rb to contain the correct version-to-be-released.
|
|
223
|
-
2. Run `bundle exec kettle-changelog`.
|
|
224
|
-
3. Run `bundle exec kettle-release`.
|
|
225
|
-
4. Stay awake and monitor the release process for any errors, and answer any prompts.
|
|
226
|
-
|
|
227
|
-
#### Manual process
|
|
228
|
-
|
|
229
|
-
1. Run `bin/setup && bin/rake` as a "test, coverage, & linting" sanity check
|
|
230
|
-
2. Update the version number in `version.rb`, and ensure `CHANGELOG.md` reflects changes
|
|
231
|
-
3. Run `bin/setup && bin/rake` again as a secondary check, and to update `Gemfile.lock`
|
|
232
|
-
4. Run `bin/rake yard` to regenerate the docs site using the canonical docs task
|
|
233
|
-
5. Run `git commit -am "🔖 Prepare release v<VERSION>"` to commit the changes
|
|
234
|
-
6. Run `git push` to trigger the final CI pipeline before release, and merge PRs
|
|
235
|
-
- NOTE: Remember to [check the build][🧪build].
|
|
236
|
-
7. Run `export GIT_TRUNK_BRANCH_NAME="$(git remote show origin | grep 'HEAD branch' | cut -d ' ' -f5)" && echo $GIT_TRUNK_BRANCH_NAME`
|
|
237
|
-
8. Run `git checkout $GIT_TRUNK_BRANCH_NAME`
|
|
238
|
-
9. Run `git pull origin $GIT_TRUNK_BRANCH_NAME` to ensure latest trunk code
|
|
239
|
-
10. Optional for older Bundler (< 2.7.0): Set `SOURCE_DATE_EPOCH` so `rake build` and `rake release` use the same timestamp and generate the same checksums
|
|
240
|
-
- If your Bundler is >= 2.7.0, you can skip this; builds are reproducible by default.
|
|
241
|
-
- Run `export SOURCE_DATE_EPOCH=$EPOCHSECONDS && echo $SOURCE_DATE_EPOCH`
|
|
242
|
-
- If the echo above has no output, then it didn't work.
|
|
243
|
-
- Note: `zsh/datetime` module is needed, if running `zsh`.
|
|
244
|
-
- In older versions of `bash` you can use `date +%s` instead, i.e. `export SOURCE_DATE_EPOCH=$(date +%s) && echo $SOURCE_DATE_EPOCH`
|
|
245
|
-
11. Run `bundle exec rake build`
|
|
246
|
-
12. Run `bin/gem_checksums` (more context [1][🔒️rubygems-checksums-pr], [2][🔒️rubygems-guides-pr])
|
|
247
|
-
to create SHA-256 and SHA-512 checksums. This functionality is provided by the `stone_checksums`
|
|
248
|
-
[gem][💎stone_checksums].
|
|
249
|
-
- The script automatically commits but does not push the checksums
|
|
250
|
-
13. Sanity check the SHA256, comparing with the output from the `bin/gem_checksums` command:
|
|
251
|
-
- `sha256sum pkg/<gem name>-<version>.gem`
|
|
252
|
-
14. Run `bundle exec rake release` which will create a git tag for the version,
|
|
253
|
-
push git commits and tags, and push the `.gem` file to the gem host configured in the gemspec.
|
|
254
|
-
|
|
255
|
-
[📜src-gl]: https://gitlab.com/appraisal-rb/appraisal2
|
|
256
|
-
[📜src-cb]: https://codeberg.org/appraisal-rb/appraisal2
|
|
257
|
-
[📜src-gh]: https://github.com/appraisal-rb/appraisal2
|
|
258
|
-
[🧪build]: https://github.com/appraisal-rb/appraisal2/actions
|
|
259
|
-
[🤝conduct]: https://github.com/appraisal-rb/appraisal2/blob/main/CODE_OF_CONDUCT.md
|
|
260
|
-
[🖐contrib-rocks]: https://contrib.rocks
|
|
261
|
-
[🖐contributors]: https://github.com/appraisal-rb/appraisal2/graphs/contributors
|
|
262
|
-
[🚎contributors-gl]: https://gitlab.com/appraisal-rb/appraisal2/-/graphs/main
|
|
263
|
-
[🖐contributors-img]: https://contrib.rocks/image?repo=appraisal-rb/appraisal2
|
|
264
|
-
[💎gem-coop]: https://gem.coop
|
|
265
|
-
[🔒️rubygems-security-guide]: https://guides.rubygems.org/security/#building-gems
|
|
266
|
-
[🔒️rubygems-checksums-pr]: https://github.com/rubygems/rubygems/pull/6022
|
|
267
|
-
[🔒️rubygems-guides-pr]: https://github.com/rubygems/guides/pull/325
|
|
268
|
-
[💎stone_checksums]: https://github.com/galtzo-floss/stone_checksums
|
|
269
|
-
[📗keep-changelog]: https://keepachangelog.com/en/1.0.0/
|
|
270
|
-
[📗keep-changelog-img]: https://img.shields.io/badge/keep--a--changelog-1.0.0-FFDD67.svg?style=flat
|
|
271
|
-
[📌semver-breaking]: https://github.com/semver/semver/issues/716#issuecomment-869336139
|
|
272
|
-
[📌major-versions-not-sacred]: https://tom.preston-werner.com/2022/05/23/major-version-numbers-are-not-sacred.html
|
|
273
|
-
[🚎appraisal2]: https://github.com/appraisal-rb/appraisal2
|
|
274
|
-
[🏃♂️runner-tool-cache]: https://github.com/ruby/ruby-builder/releases/tag/toolcache
|
|
275
|
-
[✉️discord-invite]: https://discord.gg/3qme4XHNKN
|