version_gem 1.1.0 → 1.1.8
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 +149 -21
- data/CODE_OF_CONDUCT.md +80 -29
- data/CONTRIBUTING.md +124 -12
- data/LICENSE.txt +1 -1
- data/README.md +517 -223
- data/SECURITY.md +15 -7
- data/lib/version_gem/api.rb +11 -8
- data/lib/version_gem/basic.rb +7 -5
- data/lib/version_gem/epoch.rb +70 -0
- data/lib/version_gem/error.rb +3 -0
- data/lib/version_gem/rspec.rb +43 -18
- data/lib/version_gem/ruby.rb +23 -0
- data/lib/version_gem/version.rb +3 -1
- data/lib/version_gem.rb +4 -2
- data.tar.gz.sig +0 -0
- metadata +77 -69
- metadata.gz.sig +0 -0
- data/sig/version_gem.rbs +0 -4
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: f457e0e7c9cc404965d171bec3c4a3703a90450291032992f4ea50e8a27933b7
|
|
4
|
+
data.tar.gz: c68b6defc2beeb3bc81a131cead2b865d3ad62ec39419a3eb9cb90a41fcf3672
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 2d03578bb83c1bfb270d81cb041ce2e9fb1689ce1dfbefaab4f69c28661e4f2c34ecf752d941f501d978167c232dcf7012b12a3d99e96e74d0bf949c51d1eaed
|
|
7
|
+
data.tar.gz: a24a29785103417074f6bf6e8ec8a8281c71fe67a3ab079386b44a31a82bdac2218625084e8ee8db6a95af8ceefd635ef51daefac30ddd8f8ddc166c438163c6
|
checksums.yaml.gz.sig
ADDED
|
Binary file
|
data/CHANGELOG.md
CHANGED
|
@@ -1,41 +1,169 @@
|
|
|
1
|
-
|
|
1
|
+
# Changelog
|
|
2
|
+
|
|
3
|
+
[![SemVer 2.0.0][📌semver-img]][📌semver] [![Keep-A-Changelog 1.0.0][📗keep-changelog-img]][📗keep-changelog]
|
|
4
|
+
|
|
2
5
|
All notable changes to this project will be documented in this file.
|
|
3
6
|
|
|
4
|
-
The format is based on [Keep a Changelog]
|
|
5
|
-
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html)
|
|
7
|
+
The format is based on [Keep a Changelog][📗keep-changelog],
|
|
8
|
+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html),
|
|
9
|
+
and [yes][📌major-versions-not-sacred], platform and engine support are part of the [public API][📌semver-breaking].
|
|
10
|
+
Please file a bug if you notice a violation of semantic versioning.
|
|
11
|
+
|
|
12
|
+
[📌semver]: https://semver.org/spec/v2.0.0.html
|
|
13
|
+
[📌semver-img]: https://img.shields.io/badge/semver-2.0.0-FFDD67.svg?style=flat
|
|
14
|
+
[📌semver-breaking]: https://github.com/semver/semver/issues/716#issuecomment-869336139
|
|
15
|
+
[📌major-versions-not-sacred]: https://tom.preston-werner.com/2022/05/23/major-version-numbers-are-not-sacred.html
|
|
16
|
+
[📗keep-changelog]: https://keepachangelog.com/en/1.0.0/
|
|
17
|
+
[📗keep-changelog-img]: https://img.shields.io/badge/keep--a--changelog-1.0.0-FFDD67.svg?style=flat
|
|
6
18
|
|
|
7
19
|
## [Unreleased]
|
|
8
20
|
### Added
|
|
21
|
+
### Changed
|
|
22
|
+
### Fixed
|
|
23
|
+
### Removed
|
|
9
24
|
|
|
25
|
+
## [1.1.8] 2025-05-06 ([tag][1.1.8t])
|
|
26
|
+
- Line Coverage: 100.0% (117 / 117)
|
|
27
|
+
- Branch Coverage: 100.0% (4 / 4)
|
|
28
|
+
- 84.62% documented
|
|
29
|
+
### Added
|
|
30
|
+
- CITATION.cff (@pboling)
|
|
31
|
+
- Cryptographically signed with new 20-year cert (@pboling)
|
|
32
|
+
- expires 2045-04-29
|
|
33
|
+
- Improved documentation (@pboling)
|
|
34
|
+
- Addressed entire REEK list (@pboling)
|
|
35
|
+
- GitLab CI, as an addition to existing GHA (@pboling)
|
|
36
|
+
|
|
37
|
+
## [1.1.7] 2025-04-15 ([tag][1.1.7t])
|
|
38
|
+
- Line Coverage: 100.0% (117 / 117)
|
|
39
|
+
- Branch Coverage: 100.0% (4 / 4)
|
|
40
|
+
- 76.92% documented
|
|
41
|
+
### Added
|
|
42
|
+
- Support for Epoch Semantic Versioning (@pboling)
|
|
43
|
+
- `extend VersionGem::Epoch` in your library's `MyLib::Version` module
|
|
44
|
+
- Support for JRuby 10 (@pboling)
|
|
45
|
+
- More documentation (@pboling)
|
|
46
|
+
### Removed
|
|
47
|
+
- Ruby 2.2 removed from CI, though technically still supported
|
|
48
|
+
- can't run directly in GHA anymore
|
|
49
|
+
|
|
50
|
+
## [1.1.6] 2025-02-24 ([tag][1.1.6t])
|
|
51
|
+
- Line Coverage: 100.0% (77 / 77)
|
|
52
|
+
- Branch Coverage: 100.0% (2 / 2)
|
|
53
|
+
- 77.78% documented
|
|
54
|
+
### Added
|
|
55
|
+
- Support for JRuby 9.1, 9.2, 9.3, 9.4, and head (@pboling)
|
|
56
|
+
- Support for Truffle Ruby 22.3, 23.0, 23.1, 24.1, and head (@pboling)
|
|
57
|
+
- Evergreen current latest engine release workflow (@pboling)
|
|
58
|
+
- Runs ruby, truffleruby, and jruby, always latest release
|
|
59
|
+
- Improved developer experience for contributors (@pboling)
|
|
60
|
+
- More documentation (@pboling)
|
|
61
|
+
- Switch to stone_checksums for checksum generation (@pboling)
|
|
10
62
|
### Changed
|
|
63
|
+
- Code of Conduct updated - Contributor Covenant v2.0 => v2.1 (@pboling)
|
|
11
64
|
|
|
65
|
+
## [1.1.5] 2025-02-22 ([tag][1.1.5t])
|
|
66
|
+
- Line Coverage: 100.0% (77 / 77)
|
|
67
|
+
- Branch Coverage: 100.0% (2 / 2)
|
|
68
|
+
- 77.78% documented
|
|
69
|
+
### Added
|
|
70
|
+
- Document approach to get code coverage on your gem's version.rb file (@pboling)
|
|
71
|
+
- More documentation, and yard task for documentation (@pboling)
|
|
72
|
+
- Documentation of Ruby version and SemVer support (@pboling)
|
|
12
73
|
### Fixed
|
|
74
|
+
- [#3](https://gitlab.com/oauth-xx/version_gem/-/issues/3) - Allow packaging without signing (@pboling)
|
|
75
|
+
- to support secure linux distros which have alternate means of signing packages within their package managers
|
|
76
|
+
- Code coverage tracking (@pboling)
|
|
77
|
+
- Documentation of usage in gemspec via `Kernel.load` (@pboling)
|
|
78
|
+
- Improved gemspec config (@pboling)
|
|
13
79
|
|
|
14
|
-
|
|
80
|
+
## [1.1.4] 2024-03-21 ([tag][1.1.4t])
|
|
81
|
+
### Added
|
|
82
|
+
- Ruby 3.3 to CI (@pboling)
|
|
83
|
+
### Fixed
|
|
84
|
+
- Remove the executable bit from non-executable files (@Fryguy)
|
|
15
85
|
|
|
16
|
-
## [1.1.
|
|
86
|
+
## [1.1.3] 2023-06-05 ([tag][1.1.3t])
|
|
87
|
+
### Added
|
|
88
|
+
- More test coverage (now 100% 🎉) (@pboling)
|
|
89
|
+
- Improved documentation (now 77% 🎉) (@pboling)
|
|
90
|
+
- Gemfile context pattern (@pboling)
|
|
91
|
+
- Improved linting (via rubocop-lts) (@pboling)
|
|
92
|
+
- More robust GHA config (@pboling)
|
|
93
|
+
- (dev) Dependencies (@pboling)
|
|
94
|
+
- yard-junk
|
|
95
|
+
- redcarpet
|
|
96
|
+
- pry, IRB alternative
|
|
97
|
+
- pry-suite
|
|
98
|
+
- debase, for IDE debugging
|
|
99
|
+
- (dev) Rake task for rubocop_gradual (@pboling)
|
|
17
100
|
### Fixed
|
|
18
|
-
-
|
|
101
|
+
- (dev) `yard` documentation task (@pboling)
|
|
102
|
+
### Removed
|
|
103
|
+
- Formally drop Ruby 2.2 support
|
|
104
|
+
- Ruby 2.2 was already de facto minimum version supported, which is why this wasn't a 2.0 release.
|
|
105
|
+
|
|
106
|
+
## [1.1.2] - 2023-03-17 ([tag][1.1.2t])
|
|
19
107
|
### Added
|
|
20
|
-
-
|
|
108
|
+
- `VersionGem::Ruby` to help library CI integration against many different versions of Ruby (@pboling)
|
|
109
|
+
- Experimental, optional, require (not loaded by default, which is why this can be in a patch)
|
|
110
|
+
- Spec coverage is now 100%, lines and branches, including the fabled `version.rb` (@pboling)
|
|
111
|
+
- Full RBS Signatures (@pboling)
|
|
112
|
+
|
|
113
|
+
## [1.1.1] - 2022-09-19 ([tag][1.1.1t])
|
|
114
|
+
### Added
|
|
115
|
+
- Alternatives section to README.md (@pboling)
|
|
116
|
+
- Signing cert for gem releases (@pboling)
|
|
117
|
+
- Mailing List and other metadata URIs (@pboling)
|
|
118
|
+
- Checksums for released gems (@pboling)
|
|
119
|
+
### Changed
|
|
120
|
+
- SECURITY.md policy (@pboling)
|
|
121
|
+
- Version methods are now memoized (||=) on initial call for performance (@pboling)
|
|
122
|
+
- Gem releases are now cryptographically signed (@pboling)
|
|
123
|
+
|
|
124
|
+
## [1.1.0] - 2022-06-24 ([tag][1.1.0t])
|
|
125
|
+
### Added
|
|
126
|
+
- RSpec Matchers and Shared Example (@pboling)
|
|
127
|
+
### Fixed
|
|
128
|
+
- `to_a` uses same type casting as major, minor, patch, and pre (@pboling)
|
|
21
129
|
|
|
22
|
-
## [1.0.2] - 2022-06-23
|
|
130
|
+
## [1.0.2] - 2022-06-23 ([tag][1.0.2t])
|
|
23
131
|
### Added
|
|
24
|
-
- Delay loading of library code until after code coverage tool is loaded
|
|
132
|
+
- Delay loading of library code until after code coverage tool is loaded (@pboling)
|
|
25
133
|
|
|
26
|
-
## [1.0.1] - 2022-06-23
|
|
134
|
+
## [1.0.1] - 2022-06-23 ([tag][1.0.1t])
|
|
27
135
|
### Added
|
|
28
|
-
- CI Build improvements
|
|
29
|
-
- Code coverage reporting
|
|
30
|
-
- Documentation improvements
|
|
31
|
-
- Badges!
|
|
136
|
+
- CI Build improvements (@pboling)
|
|
137
|
+
- Code coverage reporting (@pboling)
|
|
138
|
+
- Documentation improvements (@pboling)
|
|
139
|
+
- Badges! (@pboling)
|
|
32
140
|
|
|
33
|
-
## [1.0.0] - 2022-06-21
|
|
141
|
+
## [1.0.0] - 2022-06-21 ([tag][1.0.0t])
|
|
34
142
|
### Added
|
|
35
|
-
- Initial release, with basic version parsing API
|
|
143
|
+
- Initial release, with basic version parsing API (@pboling)
|
|
36
144
|
|
|
37
|
-
[Unreleased]: https://
|
|
38
|
-
[1.1.
|
|
39
|
-
[1.
|
|
40
|
-
[1.
|
|
41
|
-
[1.
|
|
145
|
+
[Unreleased]: https://gitlab.com/oauth-xx/version_gem/-/compare/v1.1.8...main
|
|
146
|
+
[1.1.8]: https://gitlab.com/oauth-xx/version_gem/-/compare/v1.1.7...v1.1.8
|
|
147
|
+
[1.1.8t]: https://gitlab.com/oauth-xx/oauth2/-/tags/v1.1.8
|
|
148
|
+
[1.1.7]: https://gitlab.com/oauth-xx/version_gem/-/compare/v1.1.6...v1.1.7
|
|
149
|
+
[1.1.7t]: https://gitlab.com/oauth-xx/oauth2/-/tags/v1.1.7
|
|
150
|
+
[1.1.6]: https://gitlab.com/oauth-xx/version_gem/-/compare/v1.1.5...v1.1.6
|
|
151
|
+
[1.1.6t]: https://gitlab.com/oauth-xx/oauth2/-/tags/v1.1.6
|
|
152
|
+
[1.1.5]: https://gitlab.com/oauth-xx/version_gem/-/compare/v1.1.4...v1.1.5
|
|
153
|
+
[1.1.5t]: https://gitlab.com/oauth-xx/oauth2/-/tags/v1.1.5
|
|
154
|
+
[1.1.4]: https://gitlab.com/oauth-xx/version_gem/-/compare/v1.1.3...v1.1.4
|
|
155
|
+
[1.1.4t]: https://gitlab.com/oauth-xx/oauth2/-/tags/v1.1.4
|
|
156
|
+
[1.1.3]: https://gitlab.com/oauth-xx/version_gem/-/compare/v1.1.2...v1.1.3
|
|
157
|
+
[1.1.3t]: https://gitlab.com/oauth-xx/oauth2/-/tags/v1.1.3
|
|
158
|
+
[1.1.2]: https://gitlab.com/oauth-xx/version_gem/-/compare/v1.1.1...v1.1.2
|
|
159
|
+
[1.1.2t]: https://gitlab.com/oauth-xx/oauth2/-/tags/v1.1.2
|
|
160
|
+
[1.1.1]: https://gitlab.com/oauth-xx/version_gem/-/compare/v1.1.0...v1.1.1
|
|
161
|
+
[1.1.1t]: https://gitlab.com/oauth-xx/oauth2/-/tags/v1.1.1
|
|
162
|
+
[1.1.0]: https://gitlab.com/oauth-xx/version_gem/-/compare/v1.0.2...v1.1.0
|
|
163
|
+
[1.1.0t]: https://gitlab.com/oauth-xx/oauth2/-/tags/v1.1.0
|
|
164
|
+
[1.0.2]: https://gitlab.com/oauth-xx/version_gem/-/compare/v1.0.1...v1.0.2
|
|
165
|
+
[1.0.2t]: https://gitlab.com/oauth-xx/oauth2/-/tags/v1.0.2
|
|
166
|
+
[1.0.1]: https://gitlab.com/oauth-xx/version_gem/-/compare/v1.0.0...v1.0.1
|
|
167
|
+
[1.0.1t]: https://gitlab.com/oauth-xx/oauth2/-/tags/v1.0.1
|
|
168
|
+
[1.0.0]: https://gitlab.com/oauth-xx/version_gem/-/compare/a3055964517c159bf214712940982034b75264be...v1.0.0
|
|
169
|
+
[1.0.0t]: https://gitlab.com/oauth-xx/oauth2/-/tags/v1.0.0
|
data/CODE_OF_CONDUCT.md
CHANGED
|
@@ -1,84 +1,135 @@
|
|
|
1
|
+
|
|
1
2
|
# Contributor Covenant Code of Conduct
|
|
2
3
|
|
|
3
4
|
## Our Pledge
|
|
4
5
|
|
|
5
|
-
We as members, contributors, and leaders pledge to make participation in our
|
|
6
|
+
We as members, contributors, and leaders pledge to make participation in our
|
|
7
|
+
community a harassment-free experience for everyone, regardless of age, body
|
|
8
|
+
size, visible or invisible disability, ethnicity, sex characteristics, gender
|
|
9
|
+
identity and expression, level of experience, education, socio-economic status,
|
|
10
|
+
nationality, personal appearance, race, caste, color, religion, or sexual
|
|
11
|
+
identity and orientation.
|
|
6
12
|
|
|
7
|
-
We pledge to act and interact in ways that contribute to an open, welcoming,
|
|
13
|
+
We pledge to act and interact in ways that contribute to an open, welcoming,
|
|
14
|
+
diverse, inclusive, and healthy community.
|
|
8
15
|
|
|
9
16
|
## Our Standards
|
|
10
17
|
|
|
11
|
-
Examples of behavior that contributes to a positive environment for our
|
|
18
|
+
Examples of behavior that contributes to a positive environment for our
|
|
19
|
+
community include:
|
|
12
20
|
|
|
13
21
|
* Demonstrating empathy and kindness toward other people
|
|
14
22
|
* Being respectful of differing opinions, viewpoints, and experiences
|
|
15
23
|
* Giving and gracefully accepting constructive feedback
|
|
16
|
-
* Accepting responsibility and apologizing to those affected by our mistakes,
|
|
17
|
-
|
|
24
|
+
* Accepting responsibility and apologizing to those affected by our mistakes,
|
|
25
|
+
and learning from the experience
|
|
26
|
+
* Focusing on what is best not just for us as individuals, but for the overall
|
|
27
|
+
community
|
|
18
28
|
|
|
19
29
|
Examples of unacceptable behavior include:
|
|
20
30
|
|
|
21
|
-
* The use of sexualized language or imagery, and sexual attention or
|
|
22
|
-
|
|
31
|
+
* The use of sexualized language or imagery, and sexual attention or advances of
|
|
32
|
+
any kind
|
|
23
33
|
* Trolling, insulting or derogatory comments, and personal or political attacks
|
|
24
34
|
* Public or private harassment
|
|
25
|
-
* Publishing others' private information, such as a physical or email
|
|
26
|
-
|
|
35
|
+
* Publishing others' private information, such as a physical or email address,
|
|
36
|
+
without their explicit permission
|
|
27
37
|
* Other conduct which could reasonably be considered inappropriate in a
|
|
28
38
|
professional setting
|
|
29
39
|
|
|
30
40
|
## Enforcement Responsibilities
|
|
31
41
|
|
|
32
|
-
Community leaders are responsible for clarifying and enforcing our standards of
|
|
42
|
+
Community leaders are responsible for clarifying and enforcing our standards of
|
|
43
|
+
acceptable behavior and will take appropriate and fair corrective action in
|
|
44
|
+
response to any behavior that they deem inappropriate, threatening, offensive,
|
|
45
|
+
or harmful.
|
|
33
46
|
|
|
34
|
-
Community leaders have the right and responsibility to remove, edit, or reject
|
|
47
|
+
Community leaders have the right and responsibility to remove, edit, or reject
|
|
48
|
+
comments, commits, code, wiki edits, issues, and other contributions that are
|
|
49
|
+
not aligned to this Code of Conduct, and will communicate reasons for moderation
|
|
50
|
+
decisions when appropriate.
|
|
35
51
|
|
|
36
52
|
## Scope
|
|
37
53
|
|
|
38
|
-
This Code of Conduct applies within all community spaces, and also applies when
|
|
54
|
+
This Code of Conduct applies within all community spaces, and also applies when
|
|
55
|
+
an individual is officially representing the community in public spaces.
|
|
56
|
+
Examples of representing our community include using an official email address,
|
|
57
|
+
posting via an official social media account, or acting as an appointed
|
|
58
|
+
representative at an online or offline event.
|
|
39
59
|
|
|
40
60
|
## Enforcement
|
|
41
61
|
|
|
42
|
-
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
|
62
|
+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
|
63
|
+
reported to the community leaders responsible for enforcement at
|
|
64
|
+
[![Contact BDFL][🚂bdfl-contact-img]][🚂bdfl-contact].
|
|
65
|
+
All complaints will be reviewed and investigated promptly and fairly.
|
|
43
66
|
|
|
44
|
-
All community leaders are obligated to respect the privacy and security of the
|
|
67
|
+
All community leaders are obligated to respect the privacy and security of the
|
|
68
|
+
reporter of any incident.
|
|
45
69
|
|
|
46
70
|
## Enforcement Guidelines
|
|
47
71
|
|
|
48
|
-
Community leaders will follow these Community Impact Guidelines in determining
|
|
72
|
+
Community leaders will follow these Community Impact Guidelines in determining
|
|
73
|
+
the consequences for any action they deem in violation of this Code of Conduct:
|
|
49
74
|
|
|
50
75
|
### 1. Correction
|
|
51
76
|
|
|
52
|
-
**Community Impact**: Use of inappropriate language or other behavior deemed
|
|
77
|
+
**Community Impact**: Use of inappropriate language or other behavior deemed
|
|
78
|
+
unprofessional or unwelcome in the community.
|
|
53
79
|
|
|
54
|
-
**Consequence**: A private, written warning from community leaders, providing
|
|
80
|
+
**Consequence**: A private, written warning from community leaders, providing
|
|
81
|
+
clarity around the nature of the violation and an explanation of why the
|
|
82
|
+
behavior was inappropriate. A public apology may be requested.
|
|
55
83
|
|
|
56
84
|
### 2. Warning
|
|
57
85
|
|
|
58
|
-
**Community Impact**: A violation through a single incident or series of
|
|
86
|
+
**Community Impact**: A violation through a single incident or series of
|
|
87
|
+
actions.
|
|
59
88
|
|
|
60
|
-
**Consequence**: A warning with consequences for continued behavior. No
|
|
89
|
+
**Consequence**: A warning with consequences for continued behavior. No
|
|
90
|
+
interaction with the people involved, including unsolicited interaction with
|
|
91
|
+
those enforcing the Code of Conduct, for a specified period of time. This
|
|
92
|
+
includes avoiding interactions in community spaces as well as external channels
|
|
93
|
+
like social media. Violating these terms may lead to a temporary or permanent
|
|
94
|
+
ban.
|
|
61
95
|
|
|
62
96
|
### 3. Temporary Ban
|
|
63
97
|
|
|
64
|
-
**Community Impact**: A serious violation of community standards, including
|
|
98
|
+
**Community Impact**: A serious violation of community standards, including
|
|
99
|
+
sustained inappropriate behavior.
|
|
65
100
|
|
|
66
|
-
**Consequence**: A temporary ban from any sort of interaction or public
|
|
101
|
+
**Consequence**: A temporary ban from any sort of interaction or public
|
|
102
|
+
communication with the community for a specified period of time. No public or
|
|
103
|
+
private interaction with the people involved, including unsolicited interaction
|
|
104
|
+
with those enforcing the Code of Conduct, is allowed during this period.
|
|
105
|
+
Violating these terms may lead to a permanent ban.
|
|
67
106
|
|
|
68
107
|
### 4. Permanent Ban
|
|
69
108
|
|
|
70
|
-
**Community Impact**: Demonstrating a pattern of violation of community
|
|
109
|
+
**Community Impact**: Demonstrating a pattern of violation of community
|
|
110
|
+
standards, including sustained inappropriate behavior, harassment of an
|
|
111
|
+
individual, or aggression toward or disparagement of classes of individuals.
|
|
71
112
|
|
|
72
|
-
**Consequence**: A permanent ban from any sort of public interaction within the
|
|
113
|
+
**Consequence**: A permanent ban from any sort of public interaction within the
|
|
114
|
+
community.
|
|
73
115
|
|
|
74
116
|
## Attribution
|
|
75
117
|
|
|
76
|
-
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
|
|
77
|
-
available at
|
|
78
|
-
|
|
79
|
-
Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
|
|
118
|
+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
|
|
119
|
+
version 2.1, available at
|
|
120
|
+
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
|
|
80
121
|
|
|
81
|
-
|
|
122
|
+
Community Impact Guidelines were inspired by
|
|
123
|
+
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
|
|
82
124
|
|
|
83
125
|
For answers to common questions about this code of conduct, see the FAQ at
|
|
84
|
-
https://www.contributor-covenant.org/faq. Translations are available at
|
|
126
|
+
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
|
|
127
|
+
[https://www.contributor-covenant.org/translations][translations].
|
|
128
|
+
|
|
129
|
+
[homepage]: https://www.contributor-covenant.org
|
|
130
|
+
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
|
|
131
|
+
[Mozilla CoC]: https://github.com/mozilla/diversity
|
|
132
|
+
[FAQ]: https://www.contributor-covenant.org/faq
|
|
133
|
+
[translations]: https://www.contributor-covenant.org/translations
|
|
134
|
+
[🚂bdfl-contact]: http://www.railsbling.com/contact
|
|
135
|
+
[🚂bdfl-contact-img]: https://img.shields.io/badge/Contact-BDFL-0093D0.svg?style=flat&logo=rubyonrails&logoColor=red
|
data/CONTRIBUTING.md
CHANGED
|
@@ -1,25 +1,137 @@
|
|
|
1
|
-
|
|
1
|
+
# Contributing
|
|
2
2
|
|
|
3
|
-
Bug reports and pull requests are welcome on GitHub at [https://
|
|
3
|
+
Bug reports and pull requests are welcome on GitHub at [https://gitlab.com/oauth-xx/version_gem][🚎src-main]
|
|
4
4
|
. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to
|
|
5
|
-
the [code of conduct][conduct].
|
|
5
|
+
the [code of conduct][🤝conduct].
|
|
6
6
|
|
|
7
|
-
To submit a patch, please fork the project and create a patch with
|
|
7
|
+
To submit a patch, please fork the project and create a patch with
|
|
8
|
+
tests. Once you're happy with it send a pull request and post a message to the
|
|
9
|
+
[google group][⛳mail-list] or on the [gitter chat][🏘chat].
|
|
10
|
+
|
|
11
|
+
We [![Keep A Changelog][📗keep-changelog-img]][📗keep-changelog] so if you make changes, remember to update it.
|
|
12
|
+
|
|
13
|
+
## You can help!
|
|
14
|
+
|
|
15
|
+
Simply follow these instructions:
|
|
16
|
+
|
|
17
|
+
1. Fork the repository
|
|
18
|
+
2. Create your feature branch (`git checkout -b my-new-feature`)
|
|
19
|
+
3. Make some fixes.
|
|
20
|
+
4. Commit your changes (`git commit -am 'Added some feature'`)
|
|
21
|
+
5. Push to the branch (`git push origin my-new-feature`)
|
|
22
|
+
6. Make sure to add tests for it. This is important, so it doesn't break in a future release.
|
|
23
|
+
7. Create new Pull Request.
|
|
24
|
+
|
|
25
|
+
## Appraisals
|
|
26
|
+
|
|
27
|
+
From time to time the appraisal gemfiles in `gemfiles/` will need to be updated.
|
|
28
|
+
They are created and updated with the commands:
|
|
29
|
+
|
|
30
|
+
NOTE: We run on a [fork][🚎appraisal-fork] of Appraisal.
|
|
31
|
+
|
|
32
|
+
Please upvote the PR for `eval_gemfile` [support][🚎appraisal-eval-gemfile-pr]
|
|
33
|
+
|
|
34
|
+
```shell
|
|
35
|
+
BUNDLE_GEMFILE=Appraisal.root.gemfile bundle
|
|
36
|
+
BUNDLE_GEMFILE=Appraisal.root.gemfile bundle exec appraisal update
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
When adding an appraisal to CI check the [runner tool cache][🏃♂️runner-tool-cache] to see which runner to use.
|
|
40
|
+
|
|
41
|
+
## The Reek List
|
|
42
|
+
|
|
43
|
+
Take a look at the `reek` list which is the file called `REEK` and find something to improve.
|
|
44
|
+
|
|
45
|
+
To refresh the `reek` list:
|
|
46
|
+
|
|
47
|
+
```bash
|
|
48
|
+
bundle exec reek > REEK
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
## Run Tests
|
|
52
|
+
|
|
53
|
+
To run all tests
|
|
54
|
+
|
|
55
|
+
```bash
|
|
56
|
+
bundle exec rake test
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
## Lint It
|
|
60
|
+
|
|
61
|
+
Run all the default tasks, which includes running the gradually autocorrecting linter, `rubocop-gradual`.
|
|
62
|
+
|
|
63
|
+
```bash
|
|
64
|
+
bundle exec rake
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
Or just run the linter.
|
|
68
|
+
|
|
69
|
+
```bash
|
|
70
|
+
bundle exec rake rubocop_gradual:autocorrect
|
|
71
|
+
```
|
|
8
72
|
|
|
9
73
|
## Contributors
|
|
10
74
|
|
|
11
|
-
|
|
75
|
+
Your picture could be here!
|
|
76
|
+
|
|
77
|
+
[![Contributors][🖐contributors-img]][🖐contributors]
|
|
78
|
+
|
|
79
|
+
Made with [contributors-img][🖐contrib-rocks].
|
|
80
|
+
|
|
81
|
+
Also see GitLab Contributors: [https://gitlab.com/oauth-xx/version_gem/-/graphs/main][🚎contributors-gl]
|
|
12
82
|
|
|
13
|
-
|
|
83
|
+
## For Maintainers
|
|
14
84
|
|
|
15
|
-
|
|
85
|
+
### One-time, Per-maintainer, Setup
|
|
16
86
|
|
|
17
|
-
|
|
87
|
+
**IMPORTANT**: If you want to sign the build you create,
|
|
88
|
+
your public key for signing gems will need to be picked up by the line in the
|
|
89
|
+
`gemspec` defining the `spec.cert_chain` (check the relevant ENV variables there).
|
|
90
|
+
All releases to RubyGems.org will be signed.
|
|
91
|
+
See: [RubyGems Security Guide][🔒️rubygems-security-guide]
|
|
18
92
|
|
|
19
|
-
|
|
93
|
+
NOTE: To build without signing the gem you must set `SKIP_GEM_SIGNING` to some value in your environment.
|
|
20
94
|
|
|
21
|
-
|
|
95
|
+
### To release a new version:
|
|
22
96
|
|
|
23
|
-
|
|
97
|
+
1. Run `bin/setup && bin/rake` as a tests, coverage, & linting sanity check
|
|
98
|
+
2. Update the version number in `version.rb`, and ensure `CHANGELOG.md` reflects changes
|
|
99
|
+
3. Run `bin/setup && bin/rake` again as a secondary check, and to update `Gemfile.lock`
|
|
100
|
+
4. Run `git commit -am "🔖 Prepare release v<VERSION>"` to commit the changes
|
|
101
|
+
5. Run `git push` to trigger the final CI pipeline before release, & merge PRs
|
|
102
|
+
- NOTE: Remember to [check the build][🧪build]!
|
|
103
|
+
6. Run `export GIT_TRUNK_BRANCH_NAME="$(git remote show origin | grep 'HEAD branch' | cut -d ' ' -f5)" && echo $GIT_TRUNK_BRANCH_NAME`
|
|
104
|
+
7. Run `git checkout $GIT_TRUNK_BRANCH_NAME`
|
|
105
|
+
8. Run `git pull origin $GIT_TRUNK_BRANCH_NAME` to ensure you will release the latest trunk code
|
|
106
|
+
9. Set `SOURCE_DATE_EPOCH` so `rake build` and `rake release` use same timestamp, and generate same checksums
|
|
107
|
+
- Run `export SOURCE_DATE_EPOCH=$EPOCHSECONDS && echo $SOURCE_DATE_EPOCH`
|
|
108
|
+
- If the echo above has no output, then it didn't work.
|
|
109
|
+
- Note that you'll need the `zsh/datetime` module, if running `zsh`.
|
|
110
|
+
- In `bash` you can use `date +%s` instead, i.e. `export SOURCE_DATE_EPOCH=$(date +%s) && echo $SOURCE_DATE_EPOCH`
|
|
111
|
+
10. Run `bundle exec rake build`
|
|
112
|
+
11. Run `bin/gem_checksums` (more context [1][🔒️rubygems-checksums-pr] and [2][🔒️rubygems-guides-pr])
|
|
113
|
+
to create SHA-256 and SHA-512 checksums
|
|
114
|
+
- Checksums will be committed automatically by the script, but not pushed
|
|
115
|
+
12. Run `bundle exec rake release` which will create a git tag for the version,
|
|
116
|
+
push git commits and tags, and push the `.gem` file to [rubygems.org][💎rubygems]
|
|
24
117
|
|
|
25
|
-
[
|
|
118
|
+
[⛳mail-list]: http://groups.google.com/group/oauth-ruby
|
|
119
|
+
[🚎src-main]: https://gitlab.com/oauth-xx/version_gem
|
|
120
|
+
[🧪build]: https://github.com/oauth-xx/version_gem/actions
|
|
121
|
+
[🏘chat]: https://matrix.to/#/#pboling_version_gem:gitter.im
|
|
122
|
+
[🤝conduct]: https://gitlab.com/oauth-xx/version_gem/-/blob/main/CODE_OF_CONDUCT.md
|
|
123
|
+
[🖐contrib-rocks]: https://contrib.rocks
|
|
124
|
+
[🖐contributors]: https://github.com/oauth-xx/version_gem/graphs/contributors
|
|
125
|
+
[🚎contributors-gl]: https://gitlab.com/oauth-xx/version_gem/-/graphs/main
|
|
126
|
+
[🖐contributors-img]: https://contrib.rocks/image?repo=oauth-xx/version_gem
|
|
127
|
+
[💎rubygems]: https://rubygems.org
|
|
128
|
+
[🔒️rubygems-security-guide]: https://guides.rubygems.org/security/#building-gems
|
|
129
|
+
[🔒️rubygems-checksums-pr]: https://github.com/rubygems/rubygems/pull/6022
|
|
130
|
+
[🔒️rubygems-guides-pr]: https://github.com/rubygems/guides/pull/325
|
|
131
|
+
[📗keep-changelog]: https://keepachangelog.com/en/1.0.0/
|
|
132
|
+
[📗keep-changelog-img]: https://img.shields.io/badge/keep--a--changelog-1.0.0-FFDD67.svg?style=flat
|
|
133
|
+
[📌semver-breaking]: https://github.com/semver/semver/issues/716#issuecomment-869336139
|
|
134
|
+
[📌major-versions-not-sacred]: https://tom.preston-werner.com/2022/05/23/major-version-numbers-are-not-sacred.html
|
|
135
|
+
[🚎appraisal-eval-gemfile-pr]: https://github.com/thoughtbot/appraisal/pull/248
|
|
136
|
+
[🚎appraisal-fork]: https://github.com/pboling/appraisal/tree/galtzo
|
|
137
|
+
[🏃♂️runner-tool-cache]: https://github.com/ruby/ruby-builder/releases/tag/toolcache
|
data/LICENSE.txt
CHANGED