omniauth-identity 3.1.1 → 3.1.3
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 +68 -20
- data/CODE_OF_CONDUCT.md +24 -22
- data/CONTRIBUTING.md +65 -41
- data/LICENSE.txt +1 -1
- data/README.md +330 -173
- data/SECURITY.md +30 -8
- data/lib/omniauth/identity/version.rb +1 -1
- data/lib/omniauth/identity.rb +1 -1
- data/lib/omniauth/strategies/identity.rb +3 -3
- data/lib/omniauth-identity.rb +1 -1
- data.tar.gz.sig +2 -2
- metadata +84 -67
- metadata.gz.sig +0 -0
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: ec83ecf143cd1670379934132cb2b2de9eda9728e78bde08e840d7484e4c4355
|
4
|
+
data.tar.gz: 320de15529ce6c80a164ccb8b6cd648be02470080d3991a3d3b20bcf90b779bb
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 20b49fef66e63c724a5307cf80c1fd8d8d632ad604ed0a8bd309b7c4ec480ee29b2bd231832d5404cfe56f59a4fb35ac28dfb9296cfbc21da44a6d0372b9a3ba
|
7
|
+
data.tar.gz: b3fdaec1504f8b8ccfe1f730c765ceae51c24e35ab4405098a6731405c90533eebdd52ae48e05c944cfdb83ecb189359f99d483915e8a3a609ae037375a66ff7
|
checksums.yaml.gz.sig
CHANGED
Binary file
|
data/CHANGELOG.md
CHANGED
@@ -8,12 +8,45 @@ and this project adheres to [Semantic Versioning v2](https://semver.org/spec/v2.
|
|
8
8
|
## [Unreleased]
|
9
9
|
### Added
|
10
10
|
### Changed
|
11
|
-
###
|
11
|
+
### Deprecated
|
12
12
|
### Removed
|
13
|
+
### Fixed
|
14
|
+
### Security
|
13
15
|
|
14
|
-
## [3.1.
|
15
|
-
-
|
16
|
-
-
|
16
|
+
## [3.1.3] - 2025-06-08
|
17
|
+
- TAG: [v3.1.3][3.1.3t]
|
18
|
+
- COVERAGE: 92.06% -- 348/378 lines in 15 files
|
19
|
+
- BRANCH COVERAGE: 79.49% -- 62/78 branches in 15 files
|
20
|
+
- 44.44% documented
|
21
|
+
### Added
|
22
|
+
- More documentation by @pboling
|
23
|
+
- Expanded test suite, covering many more points of the dependency matrix by @pboling
|
24
|
+
- Test workflows with latest dependencies and more platform and dep HEADs
|
25
|
+
### Changed
|
26
|
+
- Updated Code of Conduct to Contributor Covenant v2.1
|
27
|
+
### Fixed
|
28
|
+
- Set `SKIP_GEM_SIGNING` in env to allow `gem build` without cryptographic signing requirement by @pboling
|
29
|
+
- Useful for linux distros whose package managers sign packages independently
|
30
|
+
|
31
|
+
## [3.1.2] - 2025-05-07
|
32
|
+
- TAG: [v3.1.2][3.1.2t]
|
33
|
+
- COVERAGE: 92.02% -- 346/376 lines in 15 files
|
34
|
+
- BRANCH COVERAGE: 79.49% -- 62/78 branches in 15 files
|
35
|
+
### Added
|
36
|
+
- 20 year signing cert expires 2045-04-29 by @pboling
|
37
|
+
- Added CITATION.cff by @pboling
|
38
|
+
- devcontainer for easier maintenance by @pboling
|
39
|
+
- Improved documentation by @pboling
|
40
|
+
- Greatly improved spec suite and CI config by @pboling
|
41
|
+
- Testing against JRuby 9.2, 9.3, 9.4, 10.0, and head
|
42
|
+
- Testing against many more combinations of Databases, ORMs, Rails, and Ruby versions
|
43
|
+
### Changed
|
44
|
+
- Upgraded Code of Conduct based on Contributor Covenant v2.1 by @pboling
|
45
|
+
|
46
|
+
## [3.1.1] - 2024-11-18
|
47
|
+
- TAG: [v3.1.1][3.1.1t]
|
48
|
+
- COVERAGE: 92.00% -- 345/375 lines in 15 files
|
49
|
+
- BRANCH COVERAGE: 80.26% -- 61/76 branches in 15 files
|
17
50
|
- 44.44% documented
|
18
51
|
### Added
|
19
52
|
- [PR 130][130] Add SECURITY.md policy by @pboling
|
@@ -23,9 +56,10 @@ and this project adheres to [Semantic Versioning v2](https://semver.org/spec/v2.
|
|
23
56
|
|
24
57
|
[130]: https://github.com/omniauth/omniauth-identity/pull/130
|
25
58
|
|
26
|
-
## [3.1.0] - 2024-11-18
|
27
|
-
-
|
28
|
-
-
|
59
|
+
## [3.1.0] - 2024-11-18
|
60
|
+
- TAG: [v3.1.0][3.1.0t]
|
61
|
+
- COVERAGE: 91.98% -- 344/374 lines in 15 files
|
62
|
+
- BRANCH COVERAGE: 80.26% -- 61/76 branches in 15 files
|
29
63
|
- 44.44% documented
|
30
64
|
### Added
|
31
65
|
- [PR #123][123] Improve readability in #identity method of OmniAuth::Strategies::Identity by @Xeragus
|
@@ -49,26 +83,28 @@ and this project adheres to [Semantic Versioning v2](https://semver.org/spec/v2.
|
|
49
83
|
[122]: https://github.com/omniauth/omniauth-identity/pull/122
|
50
84
|
[120]: https://github.com/omniauth/omniauth-identity/pull/120
|
51
85
|
|
52
|
-
## [3.0.9] - 2021-06-16
|
86
|
+
## [3.0.9] - 2021-06-16
|
87
|
+
- TAG: [v3.0.9][3.0.9t]
|
53
88
|
### Fixed
|
54
89
|
- \[Sequel\] Fixes loading the Sequel adapter, issue reported as [#112](https://github.com/omniauth/omniauth-identity/issues/112)
|
55
90
|
### Added
|
56
91
|
- 📝 Document the Database adapters and drivers the gem currently works with
|
57
92
|
|
58
|
-
## [3.0.8] - 2021-03-24
|
93
|
+
## [3.0.8] - 2021-03-24
|
94
|
+
- TAG: [v3.0.8][3.0.8t]
|
59
95
|
### Fixed
|
60
96
|
- \[Model\] Fixes 2 issues raised in a comment on PR [#108](https://github.com/omniauth/omniauth-identity/pull/108#issuecomment-804456604)
|
61
97
|
- When `options[:on_validation]` is set `new`/`save`/`persisted?` logic is used.
|
62
98
|
- When `options[:on_validation]` is not set `create`/`persisted?` logic is used.
|
63
99
|
|
64
|
-
## [3.0.7] - 2021-03-23
|
100
|
+
## [3.0.7] - 2021-03-23
|
101
|
+
- TAG: [v3.0.7][3.0.7t]
|
65
102
|
### Fixed
|
66
103
|
- \[ActiveRecord\] Fixed [#110](https://github.com/omniauth/omniauth-identity/issues/110) which prevented `OmniAuth::Identity::Models::ActiveRecord`-based records from saving.
|
67
104
|
- \[CouchPotato\] Fixed `OmniAuth::Identity::Models::CouchPotato`'s `#save`.
|
68
105
|
- \[Sequel\] Fixed `OmniAuth::Identity::Models::Sequel`'s `#save`.
|
69
106
|
- \[Model\] Only define `::create`, `#save`, and `#persisted?` when not already defined.
|
70
107
|
- \[Model\] Restore original `info` functionality which set `name` based on `first_name`, `last_name`, or `nickname`
|
71
|
-
|
72
108
|
### Changed
|
73
109
|
- Upgraded to a newer `OmniAuth::Identity::SecurePassword` ripped from [Rails 6-1-stable](https://github.com/rails/rails/blob/6-1-stable/activemodel/lib/active_model/secure_password.rb)
|
74
110
|
- Aeons ago the original was ripped from Rails 3.1, and frozen in time.
|
@@ -83,7 +119,8 @@ and this project adheres to [Semantic Versioning v2](https://semver.org/spec/v2.
|
|
83
119
|
- Mongoid (MongoDB)
|
84
120
|
- NoBrainer (RethinkDB)
|
85
121
|
|
86
|
-
## [3.0.6] - 2021-03-20
|
122
|
+
## [3.0.6] - 2021-03-20
|
123
|
+
- TAG: [v3.0.6][3.0.6t]
|
87
124
|
### Fixed
|
88
125
|
- Fix breaking changes introduced by [#108](https://github.com/omniauth/omniauth-identity/pull/108) which prevented `:on_validation` from firing
|
89
126
|
### Added
|
@@ -94,7 +131,8 @@ and this project adheres to [Semantic Versioning v2](https://semver.org/spec/v2.
|
|
94
131
|
- `:title` defaults to `'Identity Verification'`
|
95
132
|
- `:registration_form_title` defaults to `'Register Identity'`
|
96
133
|
|
97
|
-
## [3.0.5] - 2021-03-19
|
134
|
+
## [3.0.5] - 2021-03-19
|
135
|
+
- TAG: [v3.0.5][3.0.5t]
|
98
136
|
### Fixed
|
99
137
|
- Fix breaking changes introduced by [#86's](https://github.com/omniauth/omniauth-identity/pull/86) introduction of `:on_validation`
|
100
138
|
### Added
|
@@ -103,11 +141,13 @@ and this project adheres to [Semantic Versioning v2](https://semver.org/spec/v2.
|
|
103
141
|
- Refactor `Omniauth::Strategies::Identity.registration_phase` to support `Omniauth::Identity::Model`-inheriting classes that do not define `#save`.
|
104
142
|
- This support will be dropped in v4.0.
|
105
143
|
|
106
|
-
## [3.0.4] - 2021-02-14
|
144
|
+
## [3.0.4] - 2021-02-14
|
145
|
+
- TAG: [v3.0.4][3.0.4t]
|
107
146
|
### Added
|
108
147
|
- Add support for [sequel ORM](http://sequel.jeremyevans.net/)
|
109
148
|
|
110
|
-
## [3.0.3] - 2021-02-14
|
149
|
+
## [3.0.3] - 2021-02-14
|
150
|
+
- TAG: [v3.0.3][3.0.3t]
|
111
151
|
### Added
|
112
152
|
- Add option `:on_validation`, which can be used to add a Captcha
|
113
153
|
- See [example here](https://github.com/omniauth/omniauth-identity/pull/86#issue-63225122)
|
@@ -116,7 +156,8 @@ and this project adheres to [Semantic Versioning v2](https://semver.org/spec/v2.
|
|
116
156
|
### Removed
|
117
157
|
- ruby-head build... simply too slow
|
118
158
|
|
119
|
-
## [3.0.2] - 2021-02-14
|
159
|
+
## [3.0.2] - 2021-02-14
|
160
|
+
- TAG: [v3.0.2][3.0.2t]
|
120
161
|
### Fixed
|
121
162
|
- Github Actions CI Build for Ruby 2.4, 3.0 and ruby-head
|
122
163
|
- Updated copyright
|
@@ -124,11 +165,13 @@ and this project adheres to [Semantic Versioning v2](https://semver.org/spec/v2.
|
|
124
165
|
- Added Code Climate "Quality"
|
125
166
|
- Updated Readme
|
126
167
|
|
127
|
-
## [3.0.1] - 2021-02-14
|
168
|
+
## [3.0.1] - 2021-02-14
|
169
|
+
- TAG: [v3.0.1][3.0.1t]
|
128
170
|
### Fixed
|
129
171
|
- Github Actions CI Build for various Rubies
|
130
172
|
|
131
|
-
## [3.0.0] - 2021-02-13
|
173
|
+
## [3.0.0] - 2021-02-13
|
174
|
+
- TAG: [v3.0.0][3.0.0t]
|
132
175
|
### Added
|
133
176
|
- Compatibility with Ruby 3
|
134
177
|
- Add option `:enable_login` to bypass OmniAuth disabling of GET method (default `true`)
|
@@ -145,7 +188,8 @@ and this project adheres to [Semantic Versioning v2](https://semver.org/spec/v2.
|
|
145
188
|
- Support for DataMapper, which died long ago.
|
146
189
|
- Unwanted git artifacts
|
147
190
|
|
148
|
-
## [2.0.0] - 2020-09-01
|
191
|
+
## [2.0.0] - 2020-09-01
|
192
|
+
- TAG: [v2.0.0][2.0.0t]
|
149
193
|
### Added
|
150
194
|
- CHANGELOG to maintain a history of changes.
|
151
195
|
- Include mongoid-rspec gem.
|
@@ -162,7 +206,11 @@ and this project adheres to [Semantic Versioning v2](https://semver.org/spec/v2.
|
|
162
206
|
- Gemfile.lock file
|
163
207
|
- MongoMapper support; unable to satisfy dependencies of both MongoMapper and Mongoid now that MongoMapper is no longer actively maintained.
|
164
208
|
|
165
|
-
[Unreleased]: https://github.com/omniauth/omniauth-identity/compare/v3.1.
|
209
|
+
[Unreleased]: https://github.com/omniauth/omniauth-identity/compare/v3.1.3...HEAD
|
210
|
+
[3.1.3]: https://github.com/omniauth/omniauth-identity/compare/v3.1.2...v3.1.3
|
211
|
+
[3.1.3t]: https://github.com/omniauth/omniauth-identity/tags/v3.1.3
|
212
|
+
[3.1.2]: https://github.com/omniauth/omniauth-identity/compare/v3.1.1...v3.1.2
|
213
|
+
[3.1.2t]: https://github.com/omniauth/omniauth-identity/tags/v3.1.2
|
166
214
|
[3.1.1]: https://github.com/omniauth/omniauth-identity/compare/v3.1.0...v3.1.1
|
167
215
|
[3.1.1t]: https://github.com/omniauth/omniauth-identity/tags/v3.1.1
|
168
216
|
[3.1.0]: https://github.com/omniauth/omniauth-identity/compare/v3.0.9...v3.1.0
|
data/CODE_OF_CONDUCT.md
CHANGED
@@ -7,8 +7,8 @@ We as members, contributors, and leaders pledge to make participation in our
|
|
7
7
|
community a harassment-free experience for everyone, regardless of age, body
|
8
8
|
size, visible or invisible disability, ethnicity, sex characteristics, gender
|
9
9
|
identity and expression, level of experience, education, socio-economic status,
|
10
|
-
nationality, personal appearance, race, religion, or sexual
|
11
|
-
and orientation.
|
10
|
+
nationality, personal appearance, race, caste, color, religion, or sexual
|
11
|
+
identity and orientation.
|
12
12
|
|
13
13
|
We pledge to act and interact in ways that contribute to an open, welcoming,
|
14
14
|
diverse, inclusive, and healthy community.
|
@@ -23,17 +23,17 @@ community include:
|
|
23
23
|
* Giving and gracefully accepting constructive feedback
|
24
24
|
* Accepting responsibility and apologizing to those affected by our mistakes,
|
25
25
|
and learning from the experience
|
26
|
-
* Focusing on what is best not just for us as individuals, but for the
|
27
|
-
|
26
|
+
* Focusing on what is best not just for us as individuals, but for the overall
|
27
|
+
community
|
28
28
|
|
29
29
|
Examples of unacceptable behavior include:
|
30
30
|
|
31
|
-
* The use of sexualized language or imagery, and sexual attention or
|
32
|
-
|
31
|
+
* The use of sexualized language or imagery, and sexual attention or advances of
|
32
|
+
any kind
|
33
33
|
* Trolling, insulting or derogatory comments, and personal or political attacks
|
34
34
|
* Public or private harassment
|
35
|
-
* Publishing others' private information, such as a physical or email
|
36
|
-
|
35
|
+
* Publishing others' private information, such as a physical or email address,
|
36
|
+
without their explicit permission
|
37
37
|
* Other conduct which could reasonably be considered inappropriate in a
|
38
38
|
professional setting
|
39
39
|
|
@@ -53,7 +53,7 @@ decisions when appropriate.
|
|
53
53
|
|
54
54
|
This Code of Conduct applies within all community spaces, and also applies when
|
55
55
|
an individual is officially representing the community in public spaces.
|
56
|
-
Examples of representing our community include using an official
|
56
|
+
Examples of representing our community include using an official email address,
|
57
57
|
posting via an official social media account, or acting as an appointed
|
58
58
|
representative at an online or offline event.
|
59
59
|
|
@@ -61,7 +61,7 @@ representative at an online or offline event.
|
|
61
61
|
|
62
62
|
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
63
63
|
reported to the community leaders responsible for enforcement at
|
64
|
-
[
|
64
|
+
[![Contact BDFL][🚂bdfl-contact-img]][🚂bdfl-contact].
|
65
65
|
All complaints will be reviewed and investigated promptly and fairly.
|
66
66
|
|
67
67
|
All community leaders are obligated to respect the privacy and security of the
|
@@ -83,15 +83,15 @@ behavior was inappropriate. A public apology may be requested.
|
|
83
83
|
|
84
84
|
### 2. Warning
|
85
85
|
|
86
|
-
**Community Impact**: A violation through a single incident or series
|
87
|
-
|
86
|
+
**Community Impact**: A violation through a single incident or series of
|
87
|
+
actions.
|
88
88
|
|
89
89
|
**Consequence**: A warning with consequences for continued behavior. No
|
90
90
|
interaction with the people involved, including unsolicited interaction with
|
91
91
|
those enforcing the Code of Conduct, for a specified period of time. This
|
92
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
|
94
|
-
|
93
|
+
like social media. Violating these terms may lead to a temporary or permanent
|
94
|
+
ban.
|
95
95
|
|
96
96
|
### 3. Temporary Ban
|
97
97
|
|
@@ -107,27 +107,29 @@ Violating these terms may lead to a permanent ban.
|
|
107
107
|
### 4. Permanent Ban
|
108
108
|
|
109
109
|
**Community Impact**: Demonstrating a pattern of violation of community
|
110
|
-
standards, including sustained inappropriate behavior,
|
110
|
+
standards, including sustained inappropriate behavior, harassment of an
|
111
111
|
individual, or aggression toward or disparagement of classes of individuals.
|
112
112
|
|
113
|
-
**Consequence**: A permanent ban from any sort of public interaction within
|
114
|
-
|
113
|
+
**Consequence**: A permanent ban from any sort of public interaction within the
|
114
|
+
community.
|
115
115
|
|
116
116
|
## Attribution
|
117
117
|
|
118
118
|
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
|
119
|
-
version 2.
|
120
|
-
[https://www.contributor-covenant.org/version/2/
|
119
|
+
version 2.1, available at
|
120
|
+
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
|
121
121
|
|
122
122
|
Community Impact Guidelines were inspired by
|
123
123
|
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
|
124
124
|
|
125
125
|
For answers to common questions about this code of conduct, see the FAQ at
|
126
|
-
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available
|
127
|
-
|
126
|
+
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
|
127
|
+
[https://www.contributor-covenant.org/translations][translations].
|
128
128
|
|
129
129
|
[homepage]: https://www.contributor-covenant.org
|
130
|
-
[v2.
|
130
|
+
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
|
131
131
|
[Mozilla CoC]: https://github.com/mozilla/diversity
|
132
132
|
[FAQ]: https://www.contributor-covenant.org/faq
|
133
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,53 +1,58 @@
|
|
1
1
|
# Contributing
|
2
2
|
|
3
|
-
Bug reports and pull requests are welcome on GitHub at [https://github.com/omniauth/omniauth-identity][🚎src-main]
|
4
|
-
|
3
|
+
Bug reports and pull requests are welcome on GitHub at [https://github.com/omniauth/omniauth-identity][🚎src-main].
|
4
|
+
This project should be a safe, welcoming space for collaboration, so contributors agree to adhere to
|
5
5
|
the [code of conduct][🤝conduct].
|
6
6
|
|
7
|
-
To submit a patch, please fork the project
|
8
|
-
Once you're happy with it send a pull request.
|
7
|
+
To submit a patch, please fork the project, create a patch with tests, and send a pull request.
|
9
8
|
|
10
|
-
|
9
|
+
Remember to [![Keep A Changelog][📗keep-changelog-img]][📗keep-changelog].
|
10
|
+
|
11
|
+
## Help out!
|
11
12
|
|
12
13
|
Take a look at the `reek` list which is the file called `REEK` and find something to improve.
|
13
14
|
|
14
|
-
|
15
|
+
Follow these instructions:
|
15
16
|
|
16
17
|
1. Fork the repository
|
17
|
-
2. Create
|
18
|
+
2. Create a feature branch (`git checkout -b my-new-feature`)
|
18
19
|
3. Make some fixes.
|
19
|
-
4. Commit
|
20
|
+
4. Commit changes (`git commit -am 'Added some feature'`)
|
20
21
|
5. Push to the branch (`git push origin my-new-feature`)
|
21
|
-
6. Make sure to add tests for it. This is important so
|
22
|
+
6. Make sure to add tests for it. This is important, so it doesn't break in a future release.
|
22
23
|
7. Create new Pull Request.
|
23
24
|
|
24
|
-
##
|
25
|
-
|
26
|
-
Your picture could be here!
|
25
|
+
## Appraisals
|
27
26
|
|
28
|
-
|
27
|
+
From time to time the appraisal gemfiles in `gemfiles/` will need to be updated.
|
29
28
|
|
30
|
-
|
29
|
+
NOTE: The `eval_gemfile` feature comes from a [fork][🚎appraisal-fork] of Appraisal.
|
31
30
|
|
32
|
-
|
31
|
+
Please upvote the PR for `eval_gemfile` [support][🚎appraisal-eval-gemfile-pr]
|
33
32
|
|
34
|
-
|
33
|
+
Create or update them with the commands:
|
35
34
|
|
36
|
-
```
|
37
|
-
bundle
|
35
|
+
```shell
|
36
|
+
BUNDLE_GEMFILE=Appraisal.root.gemfile bundle
|
37
|
+
BUNDLE_GEMFILE=Appraisal.root.gemfile bundle exec appraisal update
|
38
|
+
bundle exec rake rubocop_gradual:autocorrect
|
38
39
|
```
|
39
40
|
|
40
|
-
|
41
|
+
When adding an appraisal to CI, check the [runner tool cache][🏃♂️runner-tool-cache] to see which runner to use.
|
41
42
|
|
42
|
-
|
43
|
+
## The Reek List
|
44
|
+
|
45
|
+
Take a look at the `reek` list which is the file called `REEK` and find something to improve.
|
46
|
+
|
47
|
+
To refresh the `reek` list:
|
43
48
|
|
44
49
|
```bash
|
45
|
-
|
50
|
+
bundle exec reek > REEK
|
46
51
|
```
|
47
52
|
|
48
53
|
## Run Tests
|
49
54
|
|
50
|
-
NOTE:
|
55
|
+
NOTE: To run *all* tests have the following databases installed, configured, and running.
|
51
56
|
|
52
57
|
1. [RethinkDB](https://rethinkdb.com), an open source, real-time, web database, [installed](https://rethinkdb.com/docs/install/) and [running](https://rethinkdb.com/docs/start-a-server/), e.g.
|
53
58
|
```bash
|
@@ -86,7 +91,7 @@ To run all tests on all databases (except RethinkDB):
|
|
86
91
|
bundle exec rake spec:orm:all
|
87
92
|
```
|
88
93
|
|
89
|
-
To run all tests that do not require any additional services,
|
94
|
+
To run all tests that do not require any additional services, i.e. excluding MongoDB, CouchDB, & RethinkDB:
|
90
95
|
```bash
|
91
96
|
bundle exec rake test
|
92
97
|
```
|
@@ -118,41 +123,54 @@ bundle exec rake
|
|
118
123
|
```
|
119
124
|
|
120
125
|
Or just run the linter.
|
126
|
+
|
121
127
|
```bash
|
122
|
-
bundle exec rubocop_gradual:autocorrect
|
128
|
+
bundle exec rake rubocop_gradual:autocorrect
|
123
129
|
```
|
124
130
|
|
125
|
-
##
|
131
|
+
## Contributors
|
132
|
+
|
133
|
+
[![Contributors][🖐contributors-img]][🖐contributors]
|
134
|
+
|
135
|
+
Made with [contributors-img][🖐contrib-rocks].
|
136
|
+
|
137
|
+
## For Maintainers
|
126
138
|
|
127
139
|
### One-time, Per-maintainer, Setup
|
128
140
|
|
129
|
-
**IMPORTANT**:
|
130
|
-
|
131
|
-
|
141
|
+
**IMPORTANT**: To sign a build,
|
142
|
+
a public key for signing gems will need to be picked up by the line in the
|
143
|
+
`gemspec` defining the `spec.cert_chain` (check the relevant ENV variables there).
|
144
|
+
All releases to RubyGems.org are signed releases.
|
132
145
|
See: [RubyGems Security Guide][🔒️rubygems-security-guide]
|
133
146
|
|
147
|
+
NOTE: To build without signing the gem set `SKIP_GEM_SIGNING` to any value in the environment.
|
148
|
+
|
134
149
|
### To release a new version:
|
135
150
|
|
136
|
-
1. Run `bin/setup && bin/rake` as a
|
137
|
-
2. Update the version number in `version.rb`
|
151
|
+
1. Run `bin/setup && bin/rake` as a "test, coverage, & linting" sanity check
|
152
|
+
2. Update the version number in `version.rb`, and ensure `CHANGELOG.md` reflects changes
|
138
153
|
3. Run `bin/setup && bin/rake` again as a secondary check, and to update `Gemfile.lock`
|
139
154
|
4. Run `git commit -am "🔖 Prepare release v<VERSION>"` to commit the changes
|
140
|
-
5. Run `git push` to trigger the final CI pipeline before release,
|
141
|
-
|
155
|
+
5. Run `git push` to trigger the final CI pipeline before release, and merge PRs
|
156
|
+
- NOTE: Remember to [check the build][🧪build].
|
142
157
|
6. Run `export GIT_TRUNK_BRANCH_NAME="$(git remote show origin | grep 'HEAD branch' | cut -d ' ' -f5)" && echo $GIT_TRUNK_BRANCH_NAME`
|
143
158
|
7. Run `git checkout $GIT_TRUNK_BRANCH_NAME`
|
144
|
-
8. Run `git pull origin $GIT_TRUNK_BRANCH_NAME` to ensure
|
159
|
+
8. Run `git pull origin $GIT_TRUNK_BRANCH_NAME` to ensure latest trunk code
|
145
160
|
9. Set `SOURCE_DATE_EPOCH` so `rake build` and `rake release` use same timestamp, and generate same checksums
|
146
|
-
|
147
|
-
|
148
|
-
|
149
|
-
|
161
|
+
- Run `export SOURCE_DATE_EPOCH=$EPOCHSECONDS && echo $SOURCE_DATE_EPOCH`
|
162
|
+
- If the echo above has no output, then it didn't work.
|
163
|
+
- Note: `zsh/datetime` module is needed, if running `zsh`.
|
164
|
+
- In older versions of `bash` you can use `date +%s` instead, i.e. `export SOURCE_DATE_EPOCH=$(date +%s) && echo $SOURCE_DATE_EPOCH`
|
150
165
|
10. Run `bundle exec rake build`
|
151
|
-
11. Run `bin/
|
152
|
-
-
|
166
|
+
11. Run `bin/gem_checksums` (more context [1][🔒️rubygems-checksums-pr], [2][🔒️rubygems-guides-pr])
|
167
|
+
to create SHA-256 and SHA-512 checksums. This functionality is provided by the `stone_checksums`
|
168
|
+
[gem][💎stone_checksums].
|
169
|
+
- The script automatically commits but does not push the checksums
|
153
170
|
12. Run `bundle exec rake release` which will create a git tag for the version,
|
154
171
|
push git commits and tags, and push the `.gem` file to [rubygems.org][💎rubygems]
|
155
172
|
|
173
|
+
13. [🚎src-main]: https://github.com/omniauth/omniauth-identity
|
156
174
|
[🧪build]: https://github.com/omniauth/omniauth-identity/actions
|
157
175
|
[🤝conduct]: https://github.com/omniauth/omniauth-identity/blob/main/CODE_OF_CONDUCT.md
|
158
176
|
[🖐contrib-rocks]: https://contrib.rocks
|
@@ -160,5 +178,11 @@ See: [RubyGems Security Guide][🔒️rubygems-security-guide]
|
|
160
178
|
[🖐contributors-img]: https://contrib.rocks/image?repo=omniauth/omniauth-identity
|
161
179
|
[💎rubygems]: https://rubygems.org
|
162
180
|
[🔒️rubygems-security-guide]: https://guides.rubygems.org/security/#building-gems
|
163
|
-
[🔒️rubygems-checksums-pr]: https://github.com/rubygems/
|
164
|
-
[
|
181
|
+
[🔒️rubygems-checksums-pr]: https://github.com/rubygems/rubygems/pull/6022
|
182
|
+
[🔒️rubygems-guides-pr]: https://github.com/rubygems/guides/pull/325
|
183
|
+
[💎stone_checksums]: https://github.com/pboling/stone_checksums
|
184
|
+
[📗keep-changelog]: https://keepachangelog.com/en/1.0.0/
|
185
|
+
[📗keep-changelog-img]: https://img.shields.io/badge/keep--a--changelog-1.0.0-FFDD67.svg?style=flat
|
186
|
+
[🚎appraisal-eval-gemfile-pr]: https://github.com/thoughtbot/appraisal/pull/248
|
187
|
+
[🚎appraisal-fork]: https://github.com/pboling/appraisal/tree/galtzo
|
188
|
+
[🏃♂️runner-tool-cache]: https://github.com/ruby/ruby-builder/releases/tag/toolcache
|
data/LICENSE.txt
CHANGED
@@ -1,6 +1,6 @@
|
|
1
1
|
MIT License
|
2
2
|
|
3
|
-
Copyright (c) 2021, 2024 Peter H. Boling, and
|
3
|
+
Copyright (c) 2021, 2024-2025 Peter H. Boling, and omniauth-identity contributors
|
4
4
|
Copyright (c) 2020 Peter H. Boling, Andrew Roberts, and Jellybooks Ltd.
|
5
5
|
Copyright (c) 2010-2015 Michael Bleigh, and Intridea, Inc.
|
6
6
|
|