Skip to content

Commit ce97532

Browse files
committed
📝 Document 0.6.1 release
1 parent dd2db13 commit ce97532

File tree

3 files changed

+55
-5
lines changed

3 files changed

+55
-5
lines changed

CHANGELOG.md

+21-3
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
1313

1414
### Removed
1515

16-
## [0.6.1] 2022-08-24
16+
## [0.6.1] 2022-08-23
1717
### Changed
1818
* Fixed documentation in SECURITY.md
1919
* Change references to master => main
2020

21+
### Added
22+
* Post install note about v0.6.x EOL approaching in April, 2024
23+
2124
## [0.6.0] 2022-08-23
2225
### Added
2326
* New option `body_hash_enabled` which defaults to true to maintain backward compatibility with prior releases. Setting to `false` disables generation of a `oauth_body_hash` component as part of the signature computation.
@@ -32,11 +35,23 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
3235
### Removed
3336
* Ruby 2.0, 2.1, 2.2, and 2.3 are no longer valid install targets
3437

38+
## [0.5.13] 2022-08-23
39+
The "I think I caught 'em all!" Release
40+
41+
### Fixed
42+
* Typo oauth2 => oauth as gem name in one more place.
43+
44+
## [0.5.12] 2022-08-23
45+
The "Typoes are just the worst!" Release
46+
47+
### Fixed
48+
* Typo oauth2 => oauth as gem name in a couple places.
49+
3550
## [0.5.11] 2022-08-23
3651
The "Is this the last release with a silly name?" Release
3752

3853
### Added
39-
* Post install note about EOL approaching in April, 2023
54+
* Post install note about v0.5.x EOL approaching in April, 2023
4055

4156
### Changed
4257
* Improved documentation
@@ -416,8 +431,11 @@ but please have a look at the unit tests.
416431
* Moved all non-Rails functionality from the Rails plugin:
417432
http://code.google.com/p/oauth-plugin/
418433

419-
[Unreleased]: https://github.com/oauth-xx/oauth-ruby/compare/v0.6.0...v0.6-maintenance
434+
[Unreleased]: https://github.com/oauth-xx/oauth-ruby/compare/v0.6.1...v0.6-maintenance
435+
[0.6.1]: https://github.com/oauth-xx/oauth-ruby/releases/tag/v0.6.1
420436
[0.6.0]: https://github.com/oauth-xx/oauth-ruby/releases/tag/v0.6.0
437+
[0.5.13]: https://github.com/oauth-xx/oauth-ruby/releases/tag/v0.5.13
438+
[0.5.12]: https://github.com/oauth-xx/oauth-ruby/releases/tag/v0.5.12
421439
[0.5.11]: https://github.com/oauth-xx/oauth-ruby/releases/tag/v0.5.11
422440
[0.5.10]: https://github.com/oauth-xx/oauth-ruby/releases/tag/v0.5.10
423441
[0.5.9]: https://github.com/oauth-xx/oauth-ruby/releases/tag/v0.5.9

README.md

+8-2
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,12 @@ See the sibling `oauth2` gem for OAuth 2.0 implementations in Ruby.
2020
[oauth1-spec]: http://oauth.net/core/1.0/
2121
[sibling-gem]: https://github.com/oauth-xx/oauth-ruby
2222

23+
**NOTE**
24+
25+
This README, on branch `v0.6-maintenance`, targets 0.6.x series releases.
26+
The v0.6.x series of releases will be EOL no later than April, 2024.
27+
For later releases please see the `main` branch README.
28+
2329
## Status
2430

2531
<!--
@@ -188,7 +194,7 @@ The `main` branch now targets 1.0.x releases.
188194
See `v0.6-maintenance` branch for Ruby >= 2.4.
189195
See `v0.5-maintenance` branch for Ruby >= 2.0.
190196

191-
NOTE: No further releases of the 0.5.x series are anticipated.
197+
NOTE: No further releases of version < 1.0.x are anticipated.
192198

193199
<details>
194200
<summary>Ruby Engine Compatibility Policy</summary>
@@ -241,7 +247,7 @@ gem. After extraction that gem was made to depend on this gem.
241247

242248
Unfortunately, this gem does have some Rails related bits that are
243249
**optional** to load. You don't need Rails! The Rails bits may be pulled out
244-
into a separate gem after the release of version 1.0 of this gem.
250+
into a separate gem with the release of version 1.0 of this gem.
245251

246252
## Usage
247253

oauth.gemspec

+26
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,34 @@ Gem::Specification.new do |spec|
2727
spec.files = Dir.glob("lib/**/*.rb") + ["LICENSE", "README.md", "CHANGELOG.md", "CODE_OF_CONDUCT.md", "SECURITY.md", "CONTRIBUTING.md"]
2828
spec.extra_rdoc_files = ["TODO"]
2929

30+
# This gem will work with Ruby 2.4 or greater...
3031
spec.required_ruby_version = ">= 2.4"
32+
spec.post_install_message = "
33+
You have installed oauth version #{OAuth::Version::VERSION}, congratulations!
3134
35+
Non-commercial support for the 0.6.x series will end in April, 2024. Please upgrade to 1.0.x as soon as possible!
36+
The only breaking change will be dropped support for Ruby 2.4, 2.5, and 2.6.
37+
38+
Please see:
39+
• https://github.com/oauth-xx/oauth/blob/main/SECURITY.md
40+
41+
Note also that I, and this project, am in the process of leaving Github.
42+
I wrote about some of the reasons here:
43+
• https://dev.to/galtzo/im-leaving-github-50ba
44+
45+
If you are a human, please consider a donation as I move toward supporting myself with Open Source work:
46+
• https://liberapay.com/pboling
47+
• https://ko-fi.com/pboling
48+
• https://patreon.com/galtzo
49+
50+
If you are a corporation, please consider supporting this project, and open source work generally, with a TideLift subscription.
51+
• https://tidelift.com/funding/github/rubygems/oauth
52+
• Or hire me. I am looking for a job!
53+
54+
Please report issues, and support the project!
55+
56+
Thanks, |7eter l-|. l3oling
57+
"
3258
spec.add_development_dependency("em-http-request", "~> 1.1.7")
3359
spec.add_development_dependency("iconv")
3460
spec.add_development_dependency("minitest", "~> 5.15.0")

0 commit comments

Comments
 (0)