version_gem 1.1.9 → 1.1.12
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- checksums.yaml.gz.sig +0 -0
- data/CHANGELOG.md +157 -1
- data/CITATION.cff +6 -6
- data/CONTRIBUTING.md +112 -40
- data/FUNDING.md +10 -13
- data/LICENSE.md +11 -0
- data/README.md +181 -196
- data/SECURITY.md +1 -1
- data/certs/pboling.pem +27 -0
- data/lib/version_gem/api.rb +1 -1
- data/lib/version_gem/epoch.rb +1 -1
- data/lib/version_gem/ruby.rb +2 -2
- data/lib/version_gem/version.rb +2 -8
- data/lib/version_gem.rb +1 -0
- data/sig/version_gem/version.rbs +1 -4
- data.tar.gz.sig +0 -0
- metadata +49 -39
- metadata.gz.sig +0 -0
- data/LICENSE.txt +0 -21
- data/REEK +0 -0
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 036c36e35a1bba8fb12b5a2e8ad2fb960070487462f56a906e07abc1f269a8f0
|
|
4
|
+
data.tar.gz: 49e719e30a2e23747b5ca0f262926da0f3dbac329cdb9bf441c063fbca985565
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 100e2c8fd944bdbcbb4630b1a6cdf1f18c1e84812a7660d0d96b919b9f0a82f4fa7ece31fa44980c2c4e73622be5d7efc7f8af2bc455af90135d8c6bfad0b5bf
|
|
7
|
+
data.tar.gz: d7f870ceea407bf03a615ba0fe27deedcf4db724bd7a0f4380a6d8d4dbfacbc28462a28820cf339b7f8986d2a09ea86318ce0624a33b8928c5983ee5ecd8cd5e
|
checksums.yaml.gz.sig
CHANGED
|
Binary file
|
data/CHANGELOG.md
CHANGED
|
@@ -17,34 +17,135 @@ Please file a bug if you notice a violation of semantic versioning.
|
|
|
17
17
|
[📗keep-changelog-img]: https://img.shields.io/badge/keep--a--changelog-1.0.0-FFDD67.svg?style=flat
|
|
18
18
|
|
|
19
19
|
## [Unreleased]
|
|
20
|
+
|
|
20
21
|
### Added
|
|
22
|
+
|
|
21
23
|
### Changed
|
|
24
|
+
|
|
22
25
|
### Deprecated
|
|
26
|
+
|
|
23
27
|
### Removed
|
|
28
|
+
|
|
24
29
|
### Fixed
|
|
30
|
+
|
|
25
31
|
### Security
|
|
26
32
|
|
|
33
|
+
## [1.1.12] - 2026-06-14
|
|
34
|
+
|
|
35
|
+
- TAG: [v1.1.12][1.1.12t]
|
|
36
|
+
- COVERAGE: 100.00% -- 58/58 lines in 2 files
|
|
37
|
+
- BRANCH COVERAGE: 0.00% -- 0/0 branches in 2 files
|
|
38
|
+
- 85.19% documented
|
|
39
|
+
|
|
40
|
+
### Changed
|
|
41
|
+
|
|
42
|
+
- Retemplated repository metadata, workflows, modular gemfiles, and documentation
|
|
43
|
+
scaffolding with the current `kettle-jem` template.
|
|
44
|
+
|
|
45
|
+
### Fixed
|
|
46
|
+
|
|
47
|
+
- Restored `docs/CNAME` so the generated documentation site keeps its custom domain.
|
|
48
|
+
- Corrected misspelled contact metadata to use `galtzo.com`.
|
|
49
|
+
|
|
50
|
+
## [1.1.11] - 2026-06-06
|
|
51
|
+
|
|
52
|
+
- TAG: [v1.1.11][1.1.11t]
|
|
53
|
+
- COVERAGE: 100.00% -- 58/58 lines in 2 files
|
|
54
|
+
- BRANCH COVERAGE: 0.00% -- 0/0 branches in 2 files
|
|
55
|
+
- 85.19% documented
|
|
56
|
+
|
|
57
|
+
### Added
|
|
58
|
+
|
|
59
|
+
- Added the generated `appraisal2` binstub.
|
|
60
|
+
|
|
61
|
+
### Changed
|
|
62
|
+
|
|
63
|
+
- Refreshed generated CI workflows, README support badges, gemspec development
|
|
64
|
+
dependency floors, and template metadata from the current kettle-jem
|
|
65
|
+
template.
|
|
66
|
+
- Updated generated Appraisal2 integration to use the `appraisal2-rubocop`
|
|
67
|
+
plugin DSL and raised the generated `appraisal2` / `appraisal2-rubocop`
|
|
68
|
+
dependency floors.
|
|
69
|
+
|
|
70
|
+
## [1.1.10] - 2026-06-02
|
|
71
|
+
|
|
72
|
+
- TAG: [v1.1.10][1.1.10t]
|
|
73
|
+
- COVERAGE: 100.00% -- 58/58 lines in 2 files
|
|
74
|
+
- BRANCH COVERAGE: 0.00% -- 0/0 branches in 2 files
|
|
75
|
+
- 85.19% documented
|
|
76
|
+
|
|
77
|
+
### Added
|
|
78
|
+
|
|
79
|
+
- StructuredMerge-managed template configuration under `.structuredmerge/`,
|
|
80
|
+
including semantic Git diff driver settings and kettle-drift integration.
|
|
81
|
+
- `rubocop-gradual` baseline tracking for style checks.
|
|
82
|
+
|
|
83
|
+
### Changed
|
|
84
|
+
|
|
85
|
+
- Re-templated the project with the current kettle-jem / StructuredMerge
|
|
86
|
+
template.
|
|
87
|
+
- Development and test dependency floors now use current template floors:
|
|
88
|
+
`kettle-dev` 2.0.7, `kettle-test` 2.0.3, `kettle-soup-cover` 2.0.0,
|
|
89
|
+
`turbo_tests2` 3.1.1, `rubocop-lts` 8.3.0, and
|
|
90
|
+
`rubocop-lts-rspec` 1.0.3.
|
|
91
|
+
- Development and test tooling now targets Ruby 2.4 or newer while the
|
|
92
|
+
published runtime Ruby requirement remains Ruby 2.2 or newer.
|
|
93
|
+
- RSpec setup now loads `kettle-test` helpers and kettle-soup-cover coverage
|
|
94
|
+
bootstrap from `spec/spec_helper.rb`.
|
|
95
|
+
- Templating dependencies now load only when `K_JEM_TEMPLATING=true`, with
|
|
96
|
+
local StructuredMerge and Kettle workspace dependencies wired through
|
|
97
|
+
`SMORG_RB_DEV`, `KETTLE_RB_DEV`, and `nomono`.
|
|
98
|
+
- Gem metadata and packaging inventory were refreshed by the template,
|
|
99
|
+
including homepage, wiki, license-file, and packaged file handling.
|
|
100
|
+
|
|
101
|
+
### Removed
|
|
102
|
+
|
|
103
|
+
- Removed the obsolete `.yard_gfm_support.rb` documentation hook; YARD setup now
|
|
104
|
+
uses the current template-managed plugin configuration.
|
|
105
|
+
- Removed obsolete CI workflows for Ruby 2.3, JRuby 9.1, TruffleRuby 23.2,
|
|
106
|
+
CodeQL, framework CI, and Discord notifications.
|
|
107
|
+
- Removed legacy generated binstubs in favor of the current curated
|
|
108
|
+
`kettle-check-eof`, `kettle-test`, and retained documentation binstubs.
|
|
109
|
+
|
|
110
|
+
### Fixed
|
|
111
|
+
|
|
112
|
+
- logo at top of README.md
|
|
113
|
+
|
|
114
|
+
- Fixed the Style workflow RBS validation command so CI uses the bundled `rbs`
|
|
115
|
+
executable instead of the non-executable `bin/rbs` binstub.
|
|
116
|
+
- Fixed the Coverage workflow so Codecov repository-registration/upload errors
|
|
117
|
+
do not fail CI after local coverage reports have already been generated and
|
|
118
|
+
verified.
|
|
119
|
+
|
|
27
120
|
## [1.1.9] - 2025-09-02
|
|
121
|
+
|
|
28
122
|
- TAG: [v1.1.9][1.1.9t]
|
|
29
123
|
- COVERAGE: 100.00% -- 118/118 lines in 8 files
|
|
30
124
|
- BRANCH COVERAGE: 100.00% -- 4/4 branches in 8 files
|
|
31
125
|
- 84.62% documented
|
|
126
|
+
|
|
32
127
|
### Added
|
|
128
|
+
|
|
33
129
|
- re-templated gem using kettle-dev v1.1.2
|
|
34
130
|
- new binstubs for changelog, readme, commit message, & release management
|
|
35
131
|
- new CI workflows
|
|
36
132
|
- enhanced project documentation
|
|
37
133
|
- More RBS types
|
|
38
134
|
- docs site: https://version-gem.galtzo.com
|
|
135
|
+
|
|
39
136
|
### Fixed
|
|
137
|
+
|
|
40
138
|
- RBS types are more accurate
|
|
41
139
|
|
|
42
140
|
## [1.1.8] 2025-05-06
|
|
141
|
+
|
|
43
142
|
- TAG: [1.1.8][1.1.8t]
|
|
44
143
|
- COVERAGE: 100.00% -- 118/118 lines in 8 files
|
|
45
144
|
- BRANCH COVERAGE: 100.00% -- 4/4 branches in 8 files
|
|
46
145
|
- 84.62% documented
|
|
146
|
+
|
|
47
147
|
### Added
|
|
148
|
+
|
|
48
149
|
- CITATION.cff (@pboling)
|
|
49
150
|
- Cryptographically signed with new 20-year cert (@pboling)
|
|
50
151
|
- expires 2045-04-29
|
|
@@ -53,25 +154,33 @@ Please file a bug if you notice a violation of semantic versioning.
|
|
|
53
154
|
- GitLab CI, as an addition to existing GHA (@pboling)
|
|
54
155
|
|
|
55
156
|
## [1.1.7] 2025-04-15
|
|
157
|
+
|
|
56
158
|
- TAG: [1.1.7][1.1.7t]
|
|
57
159
|
- Line Coverage: 100.0% (117 / 117)
|
|
58
160
|
- Branch Coverage: 100.0% (4 / 4)
|
|
59
161
|
- 76.92% documented
|
|
162
|
+
|
|
60
163
|
### Added
|
|
164
|
+
|
|
61
165
|
- Support for Epoch Semantic Versioning (@pboling)
|
|
62
166
|
- `extend VersionGem::Epoch` in your library's `MyLib::Version` module
|
|
63
167
|
- Support for JRuby 10 (@pboling)
|
|
64
168
|
- More documentation (@pboling)
|
|
169
|
+
|
|
65
170
|
### Removed
|
|
171
|
+
|
|
66
172
|
- Ruby 2.2 removed from CI, though technically still supported
|
|
67
173
|
- can't run directly in GHA anymore
|
|
68
174
|
|
|
69
175
|
## [1.1.6] 2025-02-24
|
|
176
|
+
|
|
70
177
|
- TAG: [1.1.6][1.1.6t]
|
|
71
178
|
- Line Coverage: 100.0% (77 / 77)
|
|
72
179
|
- Branch Coverage: 100.0% (2 / 2)
|
|
73
180
|
- 77.78% documented
|
|
181
|
+
|
|
74
182
|
### Added
|
|
183
|
+
|
|
75
184
|
- Support for JRuby 9.1, 9.2, 9.3, 9.4, and head (@pboling)
|
|
76
185
|
- Support for Truffle Ruby 22.3, 23.0, 23.1, 24.1, and head (@pboling)
|
|
77
186
|
- Evergreen current latest engine release workflow (@pboling)
|
|
@@ -79,19 +188,26 @@ Please file a bug if you notice a violation of semantic versioning.
|
|
|
79
188
|
- Improved developer experience for contributors (@pboling)
|
|
80
189
|
- More documentation (@pboling)
|
|
81
190
|
- Switch to stone_checksums for checksum generation (@pboling)
|
|
191
|
+
|
|
82
192
|
### Changed
|
|
193
|
+
|
|
83
194
|
- Code of Conduct updated - Contributor Covenant v2.0 => v2.1 (@pboling)
|
|
84
195
|
|
|
85
196
|
## [1.1.5] 2025-02-22
|
|
197
|
+
|
|
86
198
|
- TAG: [1.1.5][1.1.5t]
|
|
87
199
|
- Line Coverage: 100.0% (77 / 77)
|
|
88
200
|
- Branch Coverage: 100.0% (2 / 2)
|
|
89
201
|
- 77.78% documented
|
|
202
|
+
|
|
90
203
|
### Added
|
|
204
|
+
|
|
91
205
|
- Document approach to get code coverage on your gem's version.rb file (@pboling)
|
|
92
206
|
- More documentation, and yard task for documentation (@pboling)
|
|
93
207
|
- Documentation of Ruby version and SemVer support (@pboling)
|
|
208
|
+
|
|
94
209
|
### Fixed
|
|
210
|
+
|
|
95
211
|
- [#3](https://gitlab.com/ruby-oauth/version_gem/-/issues/3) - Allow packaging without signing (@pboling)
|
|
96
212
|
- to support secure linux distros which have alternate means of signing packages within their package managers
|
|
97
213
|
- Code coverage tracking (@pboling)
|
|
@@ -99,15 +215,23 @@ Please file a bug if you notice a violation of semantic versioning.
|
|
|
99
215
|
- Improved gemspec config (@pboling)
|
|
100
216
|
|
|
101
217
|
## [1.1.4] 2024-03-21
|
|
218
|
+
|
|
102
219
|
- TAG: [1.1.4][1.1.4t]
|
|
220
|
+
|
|
103
221
|
### Added
|
|
222
|
+
|
|
104
223
|
- Ruby 3.3 to CI (@pboling)
|
|
224
|
+
|
|
105
225
|
### Fixed
|
|
226
|
+
|
|
106
227
|
- Remove the executable bit from non-executable files (@Fryguy)
|
|
107
228
|
|
|
108
229
|
## [1.1.3] 2023-06-05
|
|
230
|
+
|
|
109
231
|
- TAG: [1.1.3][1.1.3t]
|
|
232
|
+
|
|
110
233
|
### Added
|
|
234
|
+
|
|
111
235
|
- More test coverage (now 100% 🎉) (@pboling)
|
|
112
236
|
- Improved documentation (now 77% 🎉) (@pboling)
|
|
113
237
|
- Gemfile context pattern (@pboling)
|
|
@@ -120,58 +244,90 @@ Please file a bug if you notice a violation of semantic versioning.
|
|
|
120
244
|
- pry-suite
|
|
121
245
|
- debase, for IDE debugging
|
|
122
246
|
- (dev) Rake task for rubocop_gradual (@pboling)
|
|
247
|
+
|
|
123
248
|
### Fixed
|
|
249
|
+
|
|
124
250
|
- (dev) `yard` documentation task (@pboling)
|
|
251
|
+
|
|
125
252
|
### Removed
|
|
253
|
+
|
|
126
254
|
- Formally drop Ruby 2.2 support
|
|
127
255
|
- Ruby 2.2 was already de facto minimum version supported, which is why this wasn't a 2.0 release.
|
|
128
256
|
|
|
129
257
|
## [1.1.2] - 2023-03-17
|
|
258
|
+
|
|
130
259
|
- TAG: [1.1.2][1.1.2t]
|
|
260
|
+
|
|
131
261
|
### Added
|
|
262
|
+
|
|
132
263
|
- `VersionGem::Ruby` to help library CI integration against many different versions of Ruby (@pboling)
|
|
133
264
|
- Experimental, optional, require (not loaded by default, which is why this can be in a patch)
|
|
134
265
|
- Spec coverage is now 100%, lines and branches, including the fabled `version.rb` (@pboling)
|
|
135
266
|
- Full RBS Signatures (@pboling)
|
|
136
267
|
|
|
137
268
|
## [1.1.1] - 2022-09-19
|
|
269
|
+
|
|
138
270
|
- TAG: [1.1.1][1.1.1t]
|
|
271
|
+
|
|
139
272
|
### Added
|
|
273
|
+
|
|
140
274
|
- Alternatives section to README.md (@pboling)
|
|
141
275
|
- Signing cert for gem releases (@pboling)
|
|
142
276
|
- Mailing List and other metadata URIs (@pboling)
|
|
143
277
|
- Checksums for released gems (@pboling)
|
|
278
|
+
|
|
144
279
|
### Changed
|
|
280
|
+
|
|
145
281
|
- SECURITY.md policy (@pboling)
|
|
146
282
|
- Version methods are now memoized (||=) on initial call for performance (@pboling)
|
|
147
283
|
- Gem releases are now cryptographically signed (@pboling)
|
|
148
284
|
|
|
149
285
|
## [1.1.0] - 2022-06-24
|
|
286
|
+
|
|
150
287
|
- TAG: [1.1.0][1.1.0t]
|
|
288
|
+
|
|
151
289
|
### Added
|
|
290
|
+
|
|
152
291
|
- RSpec Matchers and Shared Example (@pboling)
|
|
292
|
+
|
|
153
293
|
### Fixed
|
|
294
|
+
|
|
154
295
|
- `to_a` uses same type casting as major, minor, patch, and pre (@pboling)
|
|
155
296
|
|
|
156
297
|
## [1.0.2] - 2022-06-23
|
|
298
|
+
|
|
157
299
|
- TAG: [1.0.2][1.0.2t]
|
|
300
|
+
|
|
158
301
|
### Added
|
|
302
|
+
|
|
159
303
|
- Delay loading of library code until after code coverage tool is loaded (@pboling)
|
|
160
304
|
|
|
161
305
|
## [1.0.1] - 2022-06-23
|
|
306
|
+
|
|
162
307
|
- TAG: [1.0.1][1.0.1t]
|
|
308
|
+
|
|
163
309
|
### Added
|
|
310
|
+
|
|
164
311
|
- CI Build improvements (@pboling)
|
|
165
312
|
- Code coverage reporting (@pboling)
|
|
166
313
|
- Documentation improvements (@pboling)
|
|
167
314
|
- Badges! (@pboling)
|
|
168
315
|
|
|
169
316
|
## [1.0.0] - 2022-06-21
|
|
317
|
+
|
|
170
318
|
- TAG: [1.0.0][1.0.0t]
|
|
319
|
+
|
|
171
320
|
### Added
|
|
321
|
+
|
|
172
322
|
- Initial release, with basic version parsing API (@pboling)
|
|
173
323
|
|
|
174
|
-
[Unreleased]: https://github.com/ruby-oauth/version_gem/compare/v1.1.
|
|
324
|
+
[Unreleased]: https://github.com/ruby-oauth/version_gem/compare/v1.1.12...HEAD
|
|
325
|
+
[1.1.12]: https://github.com/ruby-oauth/version_gem/compare/v1.1.11...v1.1.12
|
|
326
|
+
[1.1.12t]: https://github.com/ruby-oauth/version_gem/releases/tag/v1.1.12
|
|
327
|
+
[1.1.11]: https://github.com/ruby-oauth/version_gem/compare/v1.1.10...v1.1.11
|
|
328
|
+
[1.1.11t]: https://github.com/ruby-oauth/version_gem/releases/tag/v1.1.11
|
|
329
|
+
[1.1.10]: https://github.com/ruby-oauth/version_gem/compare/v1.1.9...v1.1.10
|
|
330
|
+
[1.1.10t]: https://github.com/ruby-oauth/version_gem/releases/tag/v1.1.10
|
|
175
331
|
[1.1.9]: https://github.com/ruby-oauth/version_gem/compare/v1.1.8...v1.1.9
|
|
176
332
|
[1.1.9t]: https://github.com/ruby-oauth/version_gem/releases/tag/v1.1.9
|
|
177
333
|
[1.1.8]: https://gitlab.com/ruby-oauth/version_gem/-/compare/v1.1.7...v1.1.8
|
data/CITATION.cff
CHANGED
|
@@ -1,19 +1,19 @@
|
|
|
1
1
|
cff-version: 1.2.0
|
|
2
|
-
title: version_gem
|
|
2
|
+
title: "version_gem"
|
|
3
3
|
message: >-
|
|
4
4
|
If you use this work and you want to cite it,
|
|
5
5
|
then you can use the metadata from this file.
|
|
6
6
|
type: software
|
|
7
7
|
authors:
|
|
8
|
-
- given-names: Peter
|
|
9
|
-
family-names: Boling
|
|
10
|
-
email:
|
|
11
|
-
affiliation:
|
|
8
|
+
- given-names: "Peter H."
|
|
9
|
+
family-names: "Boling"
|
|
10
|
+
email: "floss@galtzo.com"
|
|
11
|
+
affiliation: "galtzo.com"
|
|
12
12
|
orcid: 'https://orcid.org/0009-0008-8519-441X'
|
|
13
13
|
identifiers:
|
|
14
14
|
- type: url
|
|
15
15
|
value: 'https://github.com/ruby-oauth/version_gem'
|
|
16
|
-
description: version_gem
|
|
16
|
+
description: "version_gem"
|
|
17
17
|
repository-code: 'https://github.com/ruby-oauth/version_gem'
|
|
18
18
|
abstract: >-
|
|
19
19
|
version_gem
|
data/CONTRIBUTING.md
CHANGED
|
@@ -8,19 +8,63 @@ To submit a patch, please fork the project, create a patch with tests, and send
|
|
|
8
8
|
|
|
9
9
|
Remember to [![Keep A Changelog][📗keep-changelog-img]][📗keep-changelog] if you make changes.
|
|
10
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
|
+
|
|
11
17
|
## Help out!
|
|
12
18
|
|
|
13
|
-
Take a look at the
|
|
19
|
+
Take a look at the open issues and pull requests, or use the gem and find something to improve.
|
|
14
20
|
|
|
15
21
|
Follow these instructions:
|
|
16
22
|
|
|
17
|
-
1.
|
|
18
|
-
2.
|
|
19
|
-
3.
|
|
20
|
-
4.
|
|
21
|
-
5.
|
|
22
|
-
6.
|
|
23
|
-
7.
|
|
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
|
+
```
|
|
24
68
|
|
|
25
69
|
## Environment Variables for Local Development
|
|
26
70
|
|
|
@@ -32,7 +76,7 @@ General/runtime
|
|
|
32
76
|
- CI: When set to true, adjusts default rake tasks toward CI behavior
|
|
33
77
|
|
|
34
78
|
Coverage (kettle-soup-cover / SimpleCov)
|
|
35
|
-
- K_SOUP_COV_DO: Enable coverage collection (default: true in .
|
|
79
|
+
- K_SOUP_COV_DO: Enable coverage collection (default: true in `mise.toml`)
|
|
36
80
|
- K_SOUP_COV_FORMATTERS: Comma-separated list of formatters (html, xml, rcov, lcov, json, tty)
|
|
37
81
|
- K_SOUP_COV_MIN_LINE: Minimum line coverage threshold (integer, e.g., 100)
|
|
38
82
|
- K_SOUP_COV_MIN_BRANCH: Minimum branch coverage threshold (integer, e.g., 100)
|
|
@@ -48,7 +92,9 @@ GitHub API and CI helpers
|
|
|
48
92
|
Releasing and signing
|
|
49
93
|
- SKIP_GEM_SIGNING: If set, skip gem signing during build/release
|
|
50
94
|
- GEM_CERT_USER: Username for selecting your public cert in `certs/<USER>.pem` (defaults to $USER)
|
|
51
|
-
- SOURCE_DATE_EPOCH: Reproducible build timestamp.
|
|
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.
|
|
52
98
|
|
|
53
99
|
Git hooks and commit message helpers (exe/kettle-commit-msg)
|
|
54
100
|
- GIT_HOOK_BRANCH_VALIDATE: Branch name validation mode (e.g., `jira`) or `false` to disable
|
|
@@ -56,43 +102,66 @@ Git hooks and commit message helpers (exe/kettle-commit-msg)
|
|
|
56
102
|
- GIT_HOOK_FOOTER_SENTINEL: Required when footer append is enabled — a unique first-line sentinel to prevent duplicates
|
|
57
103
|
- GIT_HOOK_FOOTER_APPEND_DEBUG: Extra debug output in the footer template (true/false)
|
|
58
104
|
|
|
59
|
-
|
|
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 bundle exec 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 bundle exec 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 -- ...`.
|
|
60
122
|
|
|
61
123
|
## Appraisals
|
|
62
124
|
|
|
63
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
|
+
|
|
64
131
|
They are created and updated with the commands:
|
|
65
132
|
|
|
66
133
|
```console
|
|
67
134
|
bin/rake appraisal:update
|
|
68
135
|
```
|
|
69
136
|
|
|
70
|
-
|
|
137
|
+
If you need to reset all gemfiles/*.gemfile.lock files:
|
|
138
|
+
|
|
139
|
+
```console
|
|
140
|
+
bin/rake appraisal:reset
|
|
141
|
+
```
|
|
71
142
|
|
|
72
|
-
|
|
143
|
+
When adding an appraisal to CI, check the [runner tool cache][🏃♂️runner-tool-cache] to see which runner to use.
|
|
73
144
|
|
|
74
|
-
|
|
145
|
+
## Run Tests
|
|
75
146
|
|
|
76
|
-
|
|
147
|
+
Run tests via `kettle-test` (provided by `kettle-test`). It runs RSpec, writes the full log to
|
|
148
|
+
`tmp/kettle-test/rspec-TIMESTAMP.log`, and prints a compact highlight block with timing, seed,
|
|
149
|
+
pass/fail count, failing example list, and SimpleCov coverage percentages.
|
|
77
150
|
|
|
78
151
|
```console
|
|
79
|
-
bundle exec
|
|
152
|
+
bundle exec kettle-test
|
|
80
153
|
```
|
|
81
154
|
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
To run all tests
|
|
155
|
+
For targeted runs, disable the hard coverage threshold to avoid false failures:
|
|
85
156
|
|
|
86
157
|
```console
|
|
87
|
-
bundle exec
|
|
158
|
+
K_SOUP_COV_MIN_HARD=false bundle exec kettle-test spec/path/to/spec.rb
|
|
88
159
|
```
|
|
89
160
|
|
|
90
161
|
### Spec organization (required)
|
|
91
162
|
|
|
92
|
-
- 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/version_gem/
|
|
93
|
-
- Never add a second spec file for the same class/module. Examples of disallowed names: `*_more_spec.rb`, `*_extra_spec.rb`, `*_status_spec.rb`, or any other suffix that still targets the same class. If you find yourself wanting a second file, merge those examples into the canonical spec file for that class/module.
|
|
163
|
+
- 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/version_gem/my_class.rb` -> `spec/version_gem/my_class_spec.rb`.
|
|
94
164
|
- 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.
|
|
95
|
-
- Migration note: If a duplicate spec file exists, move all examples into the canonical file and delete the duplicate. Do not leave stubs or empty files behind.
|
|
96
165
|
|
|
97
166
|
## Lint It
|
|
98
167
|
|
|
@@ -115,7 +184,7 @@ For more detailed information about using RuboCop in this project, please see th
|
|
|
115
184
|
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:
|
|
116
185
|
|
|
117
186
|
- Prefer configuration-based exclusions when a rule should not apply to certain paths or files (e.g., via `.rubocop.yml`).
|
|
118
|
-
- When a violation is temporary and you plan to fix it later, record it in `.rubocop_gradual.lock` using the gradual workflow:
|
|
187
|
+
- When a violation is temporary, and you plan to fix it later, record it in `.rubocop_gradual.lock` using the gradual workflow:
|
|
119
188
|
- `bundle exec rake rubocop_gradual:autocorrect` (preferred)
|
|
120
189
|
- `bundle exec rake rubocop_gradual:force_update` (only when you cannot fix the violations immediately)
|
|
121
190
|
|
|
@@ -138,7 +207,7 @@ Also see GitLab Contributors: [https://gitlab.com/ruby-oauth/version_gem/-/graph
|
|
|
138
207
|
**IMPORTANT**: To sign a build,
|
|
139
208
|
a public key for signing gems will need to be picked up by the line in the
|
|
140
209
|
`gemspec` defining the `spec.cert_chain` (check the relevant ENV variables there).
|
|
141
|
-
All releases
|
|
210
|
+
All releases are signed releases.
|
|
142
211
|
See: [RubyGems Security Guide][🔒️rubygems-security-guide]
|
|
143
212
|
|
|
144
213
|
NOTE: To build without signing the gem set `SKIP_GEM_SIGNING` to any value in the environment.
|
|
@@ -147,47 +216,49 @@ NOTE: To build without signing the gem set `SKIP_GEM_SIGNING` to any value in th
|
|
|
147
216
|
|
|
148
217
|
#### Automated process
|
|
149
218
|
|
|
150
|
-
1. Update version.rb to
|
|
219
|
+
1. Update version.rb to contain the correct version-to-be-released.
|
|
151
220
|
2. Run `bundle exec kettle-changelog`.
|
|
152
221
|
3. Run `bundle exec kettle-release`.
|
|
222
|
+
4. Stay awake and monitor the release process for any errors, and answer any prompts.
|
|
153
223
|
|
|
154
224
|
#### Manual process
|
|
155
225
|
|
|
156
226
|
1. Run `bin/setup && bin/rake` as a "test, coverage, & linting" sanity check
|
|
157
227
|
2. Update the version number in `version.rb`, and ensure `CHANGELOG.md` reflects changes
|
|
158
228
|
3. Run `bin/setup && bin/rake` again as a secondary check, and to update `Gemfile.lock`
|
|
159
|
-
4. Run `
|
|
160
|
-
5. Run `git
|
|
229
|
+
4. Run `bin/rake yard` to regenerate the docs site using the canonical docs task
|
|
230
|
+
5. Run `git commit -am "🔖 Prepare release v<VERSION>"` to commit the changes
|
|
231
|
+
6. Run `git push` to trigger the final CI pipeline before release, and merge PRs
|
|
161
232
|
- NOTE: Remember to [check the build][🧪build].
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
233
|
+
7. Run `export GIT_TRUNK_BRANCH_NAME="$(git remote show origin | grep 'HEAD branch' | cut -d ' ' -f5)" && echo $GIT_TRUNK_BRANCH_NAME`
|
|
234
|
+
8. Run `git checkout $GIT_TRUNK_BRANCH_NAME`
|
|
235
|
+
9. Run `git pull origin $GIT_TRUNK_BRANCH_NAME` to ensure latest trunk code
|
|
236
|
+
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
|
|
166
237
|
- If your Bundler is >= 2.7.0, you can skip this; builds are reproducible by default.
|
|
167
238
|
- Run `export SOURCE_DATE_EPOCH=$EPOCHSECONDS && echo $SOURCE_DATE_EPOCH`
|
|
168
239
|
- If the echo above has no output, then it didn't work.
|
|
169
240
|
- Note: `zsh/datetime` module is needed, if running `zsh`.
|
|
170
241
|
- In older versions of `bash` you can use `date +%s` instead, i.e. `export SOURCE_DATE_EPOCH=$(date +%s) && echo $SOURCE_DATE_EPOCH`
|
|
171
|
-
|
|
172
|
-
|
|
242
|
+
11. Run `bundle exec rake build`
|
|
243
|
+
12. Run `bin/gem_checksums` (more context [1][🔒️rubygems-checksums-pr], [2][🔒️rubygems-guides-pr])
|
|
173
244
|
to create SHA-256 and SHA-512 checksums. This functionality is provided by the `stone_checksums`
|
|
174
245
|
[gem][💎stone_checksums].
|
|
175
246
|
- The script automatically commits but does not push the checksums
|
|
176
|
-
|
|
247
|
+
13. Sanity check the SHA256, comparing with the output from the `bin/gem_checksums` command:
|
|
177
248
|
- `sha256sum pkg/<gem name>-<version>.gem`
|
|
178
|
-
|
|
179
|
-
push git commits and tags, and push the `.gem` file to
|
|
249
|
+
14. Run `bundle exec rake release` which will create a git tag for the version,
|
|
250
|
+
push git commits and tags, and push the `.gem` file to the gem host configured in the gemspec.
|
|
180
251
|
|
|
181
|
-
[📜src-gl]: https://gitlab.com/ruby-oauth/version_gem
|
|
252
|
+
[📜src-gl]: https://gitlab.com/ruby-oauth/version_gem
|
|
182
253
|
[📜src-cb]: https://codeberg.org/ruby-oauth/version_gem
|
|
183
254
|
[📜src-gh]: https://github.com/ruby-oauth/version_gem
|
|
184
255
|
[🧪build]: https://github.com/ruby-oauth/version_gem/actions
|
|
185
|
-
[🤝conduct]: https://
|
|
256
|
+
[🤝conduct]: https://github.com/ruby-oauth/version_gem/blob/main/CODE_OF_CONDUCT.md
|
|
186
257
|
[🖐contrib-rocks]: https://contrib.rocks
|
|
187
258
|
[🖐contributors]: https://github.com/ruby-oauth/version_gem/graphs/contributors
|
|
188
259
|
[🚎contributors-gl]: https://gitlab.com/ruby-oauth/version_gem/-/graphs/main
|
|
189
260
|
[🖐contributors-img]: https://contrib.rocks/image?repo=ruby-oauth/version_gem
|
|
190
|
-
[💎
|
|
261
|
+
[💎gem-coop]: https://gem.coop
|
|
191
262
|
[🔒️rubygems-security-guide]: https://guides.rubygems.org/security/#building-gems
|
|
192
263
|
[🔒️rubygems-checksums-pr]: https://github.com/rubygems/rubygems/pull/6022
|
|
193
264
|
[🔒️rubygems-guides-pr]: https://github.com/rubygems/guides/pull/325
|
|
@@ -198,3 +269,4 @@ NOTE: To build without signing the gem set `SKIP_GEM_SIGNING` to any value in th
|
|
|
198
269
|
[📌major-versions-not-sacred]: https://tom.preston-werner.com/2022/05/23/major-version-numbers-are-not-sacred.html
|
|
199
270
|
[🚎appraisal2]: https://github.com/appraisal-rb/appraisal2
|
|
200
271
|
[🏃♂️runner-tool-cache]: https://github.com/ruby/ruby-builder/releases/tag/toolcache
|
|
272
|
+
[✉️discord-invite]: https://discord.gg/3qme4XHNKN
|