Skip to content

Commit

Permalink
📝 Document 0.6.1 release
Browse files Browse the repository at this point in the history
  • Loading branch information
pboling committed Aug 23, 2022
1 parent dd2db13 commit ce97532
Show file tree
Hide file tree
Showing 3 changed files with 55 additions and 5 deletions.
24 changes: 21 additions & 3 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

### Removed

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

### Added
* Post install note about v0.6.x EOL approaching in April, 2024

## [0.6.0] 2022-08-23
### Added
* 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.
Expand All @@ -32,11 +35,23 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
### Removed
* Ruby 2.0, 2.1, 2.2, and 2.3 are no longer valid install targets

## [0.5.13] 2022-08-23
The "I think I caught 'em all!" Release

### Fixed
* Typo oauth2 => oauth as gem name in one more place.

## [0.5.12] 2022-08-23
The "Typoes are just the worst!" Release

### Fixed
* Typo oauth2 => oauth as gem name in a couple places.

## [0.5.11] 2022-08-23
The "Is this the last release with a silly name?" Release

### Added
* Post install note about EOL approaching in April, 2023
* Post install note about v0.5.x EOL approaching in April, 2023

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

[Unreleased]: https://github.com/oauth-xx/oauth-ruby/compare/v0.6.0...v0.6-maintenance
[Unreleased]: https://github.com/oauth-xx/oauth-ruby/compare/v0.6.1...v0.6-maintenance
[0.6.1]: https://github.com/oauth-xx/oauth-ruby/releases/tag/v0.6.1
[0.6.0]: https://github.com/oauth-xx/oauth-ruby/releases/tag/v0.6.0
[0.5.13]: https://github.com/oauth-xx/oauth-ruby/releases/tag/v0.5.13
[0.5.12]: https://github.com/oauth-xx/oauth-ruby/releases/tag/v0.5.12
[0.5.11]: https://github.com/oauth-xx/oauth-ruby/releases/tag/v0.5.11
[0.5.10]: https://github.com/oauth-xx/oauth-ruby/releases/tag/v0.5.10
[0.5.9]: https://github.com/oauth-xx/oauth-ruby/releases/tag/v0.5.9
Expand Down
10 changes: 8 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,12 @@ See the sibling `oauth2` gem for OAuth 2.0 implementations in Ruby.
[oauth1-spec]: http://oauth.net/core/1.0/
[sibling-gem]: https://github.com/oauth-xx/oauth-ruby

**NOTE**

This README, on branch `v0.6-maintenance`, targets 0.6.x series releases.
The v0.6.x series of releases will be EOL no later than April, 2024.
For later releases please see the `main` branch README.

## Status

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

NOTE: No further releases of the 0.5.x series are anticipated.
NOTE: No further releases of version < 1.0.x are anticipated.

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

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

## Usage

Expand Down
26 changes: 26 additions & 0 deletions oauth.gemspec
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,34 @@ Gem::Specification.new do |spec|
spec.files = Dir.glob("lib/**/*.rb") + ["LICENSE", "README.md", "CHANGELOG.md", "CODE_OF_CONDUCT.md", "SECURITY.md", "CONTRIBUTING.md"]
spec.extra_rdoc_files = ["TODO"]

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

0 comments on commit ce97532

Please sign in to comment.