Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
97 additions
and
97 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,64 +1,64 @@ | ||
| ## Contributing | ||
|
|
||
| Bug reports and pull requests are welcome on GitLab at [https://gitlab.com/oauth-xx/oauth][🚎src-main]. This project is | ||
| intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to | ||
| the [code of conduct][🚎code-conduct]. | ||
|
|
||
| Everyone interacting in the OAuth::TTY project's codebases, issue trackers, chat | ||
| rooms and mailing lists is expected to follow the [code of conduct][🚎code-conduct]. | ||
|
|
||
| To submit a patch, please fork the project and create a patch with | ||
| tests. Once you're happy with it send a pull request and post a message to the | ||
| [google group][mailinglist] or on the [gitter chat][🏘chat]. | ||
|
|
||
| ## Create a Patch | ||
|
|
||
| After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment. | ||
|
|
||
| To install this gem onto your local machine, run `bundle exec rake install`. | ||
|
|
||
| ## Run tests | ||
|
|
||
| ### Against Rails 6 | ||
|
|
||
| ```bash | ||
| BUNDLE_GEMFILE=gemfiles/a6.gemfile bundle install | ||
| BUNDLE_GEMFILE=gemfiles/a6.gemfile bundle exec rake | ||
| ``` | ||
|
|
||
| ### Against Rails 7 | ||
|
|
||
| ```bash | ||
| BUNDLE_GEMFILE=gemfiles/a7.gemfile bundle install | ||
| BUNDLE_GEMFILE=gemfiles/a7.gemfile bundle exec rake | ||
| ``` | ||
|
|
||
| ## Release | ||
|
|
||
| To release a new version: | ||
|
|
||
| 1. update the version number in `version.rb` | ||
| 2. run `bundle exec rake build:checksum` | ||
| 3. move the built gem to project root | ||
| 4. run `bin/checksum` to create the missing SHA256 checksum | ||
| 5. move the built gem back to `pkg/` | ||
| 6. run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org). | ||
|
|
||
| NOTE: You will need to have a public key in `certs/`, and list your cert in the | ||
| `gemspec`, in order to sign the new release. | ||
| See: [RubyGems Security Guide][rubygems-security-guide] | ||
|
|
||
| ## Contributors | ||
|
|
||
| [![Contributors][🖐contributors-img]][🖐contributors] | ||
|
|
||
| [comment]: <> (Following links are used by README, CONTRIBUTING, Homepage) | ||
|
|
||
| [🚎code-conduct]: https://gitlab.com/oauth-xx/oauth/-/blob/main/CODE_OF_CONDUCT.md | ||
| [🖐contributors]: https://gitlab.com/oauth-xx/oauth/-/graphs/main | ||
| [🖐contributors-img]: https://img.shields.io/github/contributors-anon/oauth-xx/oauth-ruby | ||
| [mailinglist]: http://groups.google.com/group/oauth-ruby | ||
| [🚎src-main]: https://gitlab.com/oauth-xx/oauth/-/tree/main | ||
| [🏘chat]: https://gitter.im/oauth-xx/oauth-ruby | ||
| [rubygems-security-guide]: https://guides.rubygems.org/security/#building-gems | ||
| [rubygems]: https://rubygems.org | ||
| #<--rubocop/md-->## Contributing | ||
| #<--rubocop/md--> | ||
| #<--rubocop/md-->Bug reports and pull requests are welcome on GitLab at [https://gitlab.com/oauth-xx/oauth][🚎src-main]. This project is | ||
| #<--rubocop/md-->intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to | ||
| #<--rubocop/md-->the [code of conduct][🚎code-conduct]. | ||
| #<--rubocop/md--> | ||
| #<--rubocop/md-->Everyone interacting in the OAuth::TTY project's codebases, issue trackers, chat | ||
| #<--rubocop/md-->rooms and mailing lists is expected to follow the [code of conduct][🚎code-conduct]. | ||
| #<--rubocop/md--> | ||
| #<--rubocop/md-->To submit a patch, please fork the project and create a patch with | ||
| #<--rubocop/md-->tests. Once you're happy with it send a pull request and post a message to the | ||
| #<--rubocop/md-->[google group][mailinglist] or on the [gitter chat][🏘chat]. | ||
| #<--rubocop/md--> | ||
| #<--rubocop/md-->## Create a Patch | ||
| #<--rubocop/md--> | ||
| #<--rubocop/md-->After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment. | ||
| #<--rubocop/md--> | ||
| #<--rubocop/md-->To install this gem onto your local machine, run `bundle exec rake install`. | ||
| #<--rubocop/md--> | ||
| #<--rubocop/md-->## Run tests | ||
| #<--rubocop/md--> | ||
| #<--rubocop/md-->### Against Rails 6 | ||
| #<--rubocop/md--> | ||
| #<--rubocop/md-->```bash | ||
| #<--rubocop/md-->BUNDLE_GEMFILE=gemfiles/a6.gemfile bundle install | ||
| #<--rubocop/md-->BUNDLE_GEMFILE=gemfiles/a6.gemfile bundle exec rake | ||
| #<--rubocop/md-->``` | ||
| #<--rubocop/md--> | ||
| #<--rubocop/md-->### Against Rails 7 | ||
| #<--rubocop/md--> | ||
| #<--rubocop/md-->```bash | ||
| #<--rubocop/md-->BUNDLE_GEMFILE=gemfiles/a7.gemfile bundle install | ||
| #<--rubocop/md-->BUNDLE_GEMFILE=gemfiles/a7.gemfile bundle exec rake | ||
| #<--rubocop/md-->``` | ||
| #<--rubocop/md--> | ||
| #<--rubocop/md-->## Release | ||
| #<--rubocop/md--> | ||
| #<--rubocop/md-->To release a new version: | ||
| #<--rubocop/md--> | ||
| #<--rubocop/md-->1. update the version number in `version.rb` | ||
| #<--rubocop/md-->2. run `bundle exec rake build:checksum` | ||
| #<--rubocop/md-->3. move the built gem to project root | ||
| #<--rubocop/md-->4. run `bin/checksum` to create the missing SHA256 checksum | ||
| #<--rubocop/md-->5. move the built gem back to `pkg/` | ||
| #<--rubocop/md-->6. run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org). | ||
| #<--rubocop/md--> | ||
| #<--rubocop/md-->NOTE: You will need to have a public key in `certs/`, and list your cert in the | ||
| #<--rubocop/md-->`gemspec`, in order to sign the new release. | ||
| #<--rubocop/md-->See: [RubyGems Security Guide][rubygems-security-guide] | ||
| #<--rubocop/md--> | ||
| #<--rubocop/md-->## Contributors | ||
| #<--rubocop/md--> | ||
| #<--rubocop/md-->[![Contributors][🖐contributors-img]][🖐contributors] | ||
| #<--rubocop/md--> | ||
| #<--rubocop/md-->[comment]: <> (Following links are used by README, CONTRIBUTING, Homepage) | ||
| #<--rubocop/md--> | ||
| #<--rubocop/md-->[🚎code-conduct]: https://gitlab.com/oauth-xx/oauth/-/blob/main/CODE_OF_CONDUCT.md | ||
| #<--rubocop/md-->[🖐contributors]: https://gitlab.com/oauth-xx/oauth/-/graphs/main | ||
| #<--rubocop/md-->[🖐contributors-img]: https://img.shields.io/github/contributors-anon/oauth-xx/oauth-ruby | ||
| #<--rubocop/md-->[mailinglist]: http://groups.google.com/group/oauth-ruby | ||
| #<--rubocop/md-->[🚎src-main]: https://gitlab.com/oauth-xx/oauth/-/tree/main | ||
| #<--rubocop/md-->[🏘chat]: https://gitter.im/oauth-xx/oauth-ruby | ||
| #<--rubocop/md-->[rubygems-security-guide]: https://guides.rubygems.org/security/#building-gems | ||
| #<--rubocop/md-->[rubygems]: https://rubygems.org |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,33 +1,33 @@ | ||
| # Security Policy | ||
|
|
||
| ## Supported Versions | ||
|
|
||
| | Version | Supported | EOL | Post-EOL / Enterprise | | ||
| |---------|----------|---------|---------------------------------------| | ||
| | 1.1.x | ✅ | 04/2023 | [Tidelift Subscription][tidelift-ref] | | ||
| | 1.0.x | ✅ | 04/2023 | [Tidelift Subscription][tidelift-ref] | | ||
| | 0.6.x | 🚨 | 04/2023 | [Tidelift Subscription][tidelift-ref] | | ||
| | 0.5.x | 🚨 | 04/2023 | [Tidelift Subscription][tidelift-ref] | | ||
| | <= 0.5 | ⛔ | ⛔ | ⛔ | | ||
|
|
||
| LEGEND: | ||
| ✅ - Supported | ||
| 🚨 - Will only receive critical bug and security updates. | ||
| ⛔ - No Support | ||
|
|
||
| ### EOL Policy | ||
|
|
||
| Non-commercial support for the oldest version of Ruby (which itself is going EOL) will be dropped each year in April. | ||
|
|
||
| ## Reporting a Vulnerability | ||
|
|
||
| To report a security vulnerability, please use the [Tidelift security contact](https://tidelift.com/security). | ||
| Tidelift will coordinate the fix and disclosure. | ||
|
|
||
| ## OAuth for Enterprise | ||
|
|
||
| Available as part of the Tidelift Subscription. | ||
|
|
||
| The maintainers of oauth and thousands of other packages are working with Tidelift to deliver commercial support and maintenance for the open source packages you use to build your applications. Save time, reduce risk, and improve code health, while paying the maintainers of the exact packages you use. [Learn more.][tidelift-ref] | ||
|
|
||
| [tidelift-ref]: https://tidelift.com/subscription/pkg/rubygems-oauth?utm_source=rubygems-oauth&utm_medium=referral&utm_campaign=enterprise&utm_term=repo | ||
| #<--rubocop/md--># Security Policy | ||
| #<--rubocop/md--> | ||
| #<--rubocop/md-->## Supported Versions | ||
| #<--rubocop/md--> | ||
| #<--rubocop/md-->| Version | Supported | EOL | Post-EOL / Enterprise | | ||
| #<--rubocop/md-->|---------|----------|---------|---------------------------------------| | ||
| #<--rubocop/md-->| 1.1.x | ✅ | 04/2023 | [Tidelift Subscription][tidelift-ref] | | ||
| #<--rubocop/md-->| 1.0.x | ✅ | 04/2023 | [Tidelift Subscription][tidelift-ref] | | ||
| #<--rubocop/md-->| 0.6.x | 🚨 | 04/2023 | [Tidelift Subscription][tidelift-ref] | | ||
| #<--rubocop/md-->| 0.5.x | 🚨 | 04/2023 | [Tidelift Subscription][tidelift-ref] | | ||
| #<--rubocop/md-->| <= 0.5 | ⛔ | ⛔ | ⛔ | | ||
| #<--rubocop/md--> | ||
| #<--rubocop/md-->LEGEND: | ||
| #<--rubocop/md-->✅ - Supported | ||
| #<--rubocop/md-->🚨 - Will only receive critical bug and security updates. | ||
| #<--rubocop/md-->⛔ - No Support | ||
| #<--rubocop/md--> | ||
| #<--rubocop/md-->### EOL Policy | ||
| #<--rubocop/md--> | ||
| #<--rubocop/md-->Non-commercial support for the oldest version of Ruby (which itself is going EOL) will be dropped each year in April. | ||
| #<--rubocop/md--> | ||
| #<--rubocop/md-->## Reporting a Vulnerability | ||
| #<--rubocop/md--> | ||
| #<--rubocop/md-->To report a security vulnerability, please use the [Tidelift security contact](https://tidelift.com/security). | ||
| #<--rubocop/md-->Tidelift will coordinate the fix and disclosure. | ||
| #<--rubocop/md--> | ||
| #<--rubocop/md-->## OAuth for Enterprise | ||
| #<--rubocop/md--> | ||
| #<--rubocop/md-->Available as part of the Tidelift Subscription. | ||
| #<--rubocop/md--> | ||
| #<--rubocop/md-->The maintainers of oauth and thousands of other packages are working with Tidelift to deliver commercial support and maintenance for the open source packages you use to build your applications. Save time, reduce risk, and improve code health, while paying the maintainers of the exact packages you use. [Learn more.][tidelift-ref] | ||
| #<--rubocop/md--> | ||
| #<--rubocop/md-->[tidelift-ref]: https://tidelift.com/subscription/pkg/rubygems-oauth?utm_source=rubygems-oauth&utm_medium=referral&utm_campaign=enterprise&utm_term=repo |