Skip to content

Commit b19d904

Browse files
pbolingpboling
committed
🚨 Linting (Damnit)
rubocop/rubocop-md#14
1 parent 1c74c6b commit b19d904

File tree

5 files changed

+101
-102
lines changed

5 files changed

+101
-102
lines changed

‎.rubocop.yml

+2-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,8 @@ inherit_gem:
44
rubocop-lts: rubocop-lts.yml
55

66
require:
7-
- 'rubocop-md'
7+
# See: https://github.com/rubocop/rubocop-md/issues/14
8+
# - 'rubocop-md'
89
- 'rubocop-minitest'
910
- 'rubocop-packaging'
1011
- 'rubocop-performance'

‎CONTRIBUTING.md

+64-64
Original file line numberDiff line numberDiff line change
@@ -1,64 +1,64 @@
1-
#<--rubocop/md-->## Contributing
2-
#<--rubocop/md-->
3-
#<--rubocop/md-->Bug reports and pull requests are welcome on GitLab at [https://gitlab.com/oauth-xx/oauth][🚎src-main]. This project is
4-
#<--rubocop/md-->intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to
5-
#<--rubocop/md-->the [code of conduct][🚎code-conduct].
6-
#<--rubocop/md-->
7-
#<--rubocop/md-->Everyone interacting in the OAuth::TTY project's codebases, issue trackers, chat
8-
#<--rubocop/md-->rooms and mailing lists is expected to follow the [code of conduct][🚎code-conduct].
9-
#<--rubocop/md-->
10-
#<--rubocop/md-->To submit a patch, please fork the project and create a patch with
11-
#<--rubocop/md-->tests. Once you're happy with it send a pull request and post a message to the
12-
#<--rubocop/md-->[google group][mailinglist] or on the [gitter chat][🏘chat].
13-
#<--rubocop/md-->
14-
#<--rubocop/md-->## Create a Patch
15-
#<--rubocop/md-->
16-
#<--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.
17-
#<--rubocop/md-->
18-
#<--rubocop/md-->To install this gem onto your local machine, run `bundle exec rake install`.
19-
#<--rubocop/md-->
20-
#<--rubocop/md-->## Run tests
21-
#<--rubocop/md-->
22-
#<--rubocop/md-->### Against Rails 6
23-
#<--rubocop/md-->
24-
#<--rubocop/md-->```bash
25-
#<--rubocop/md-->BUNDLE_GEMFILE=gemfiles/a6.gemfile bundle install
26-
#<--rubocop/md-->BUNDLE_GEMFILE=gemfiles/a6.gemfile bundle exec rake
27-
#<--rubocop/md-->```
28-
#<--rubocop/md-->
29-
#<--rubocop/md-->### Against Rails 7
30-
#<--rubocop/md-->
31-
#<--rubocop/md-->```bash
32-
#<--rubocop/md-->BUNDLE_GEMFILE=gemfiles/a7.gemfile bundle install
33-
#<--rubocop/md-->BUNDLE_GEMFILE=gemfiles/a7.gemfile bundle exec rake
34-
#<--rubocop/md-->```
35-
#<--rubocop/md-->
36-
#<--rubocop/md-->## Release
37-
#<--rubocop/md-->
38-
#<--rubocop/md-->To release a new version:
39-
#<--rubocop/md-->
40-
#<--rubocop/md-->1. update the version number in `version.rb`
41-
#<--rubocop/md-->2. run `bundle exec rake build:checksum`
42-
#<--rubocop/md-->3. move the built gem to project root
43-
#<--rubocop/md-->4. run `bin/checksum` to create the missing SHA256 checksum
44-
#<--rubocop/md-->5. move the built gem back to `pkg/`
45-
#<--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).
46-
#<--rubocop/md-->
47-
#<--rubocop/md-->NOTE: You will need to have a public key in `certs/`, and list your cert in the
48-
#<--rubocop/md-->`gemspec`, in order to sign the new release.
49-
#<--rubocop/md-->See: [RubyGems Security Guide][rubygems-security-guide]
50-
#<--rubocop/md-->
51-
#<--rubocop/md-->## Contributors
52-
#<--rubocop/md-->
53-
#<--rubocop/md-->[![Contributors][🖐contributors-img]][🖐contributors]
54-
#<--rubocop/md-->
55-
#<--rubocop/md-->[comment]: <> (Following links are used by README, CONTRIBUTING, Homepage)
56-
#<--rubocop/md-->
57-
#<--rubocop/md-->[🚎code-conduct]: https://gitlab.com/oauth-xx/oauth/-/blob/main/CODE_OF_CONDUCT.md
58-
#<--rubocop/md-->[🖐contributors]: https://gitlab.com/oauth-xx/oauth/-/graphs/main
59-
#<--rubocop/md-->[🖐contributors-img]: https://img.shields.io/github/contributors-anon/oauth-xx/oauth-ruby
60-
#<--rubocop/md-->[mailinglist]: http://groups.google.com/group/oauth-ruby
61-
#<--rubocop/md-->[🚎src-main]: https://gitlab.com/oauth-xx/oauth/-/tree/main
62-
#<--rubocop/md-->[🏘chat]: https://gitter.im/oauth-xx/oauth-ruby
63-
#<--rubocop/md-->[rubygems-security-guide]: https://guides.rubygems.org/security/#building-gems
64-
#<--rubocop/md-->[rubygems]: https://rubygems.org
1+
## Contributing
2+
3+
Bug reports and pull requests are welcome on GitLab at [https://gitlab.com/oauth-xx/oauth][🚎src-main]. This project is
4+
intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to
5+
the [code of conduct][🚎code-conduct].
6+
7+
Everyone interacting in the OAuth::TTY project's codebases, issue trackers, chat
8+
rooms and mailing lists is expected to follow the [code of conduct][🚎code-conduct].
9+
10+
To submit a patch, please fork the project and create a patch with
11+
tests. Once you're happy with it send a pull request and post a message to the
12+
[google group][mailinglist] or on the [gitter chat][🏘chat].
13+
14+
## Create a Patch
15+
16+
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.
17+
18+
To install this gem onto your local machine, run `bundle exec rake install`.
19+
20+
## Run tests
21+
22+
### Against Rails 6
23+
24+
```bash
25+
BUNDLE_GEMFILE=gemfiles/a6.gemfile bundle install
26+
BUNDLE_GEMFILE=gemfiles/a6.gemfile bundle exec rake
27+
```
28+
29+
### Against Rails 7
30+
31+
```bash
32+
BUNDLE_GEMFILE=gemfiles/a7.gemfile bundle install
33+
BUNDLE_GEMFILE=gemfiles/a7.gemfile bundle exec rake
34+
```
35+
36+
## Release
37+
38+
To release a new version:
39+
40+
1. update the version number in `version.rb`
41+
2. run `bundle exec rake build:checksum`
42+
3. move the built gem to project root
43+
4. run `bin/checksum` to create the missing SHA256 checksum
44+
5. move the built gem back to `pkg/`
45+
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).
46+
47+
NOTE: You will need to have a public key in `certs/`, and list your cert in the
48+
`gemspec`, in order to sign the new release.
49+
See: [RubyGems Security Guide][rubygems-security-guide]
50+
51+
## Contributors
52+
53+
[![Contributors][🖐contributors-img]][🖐contributors]
54+
55+
[comment]: <> (Following links are used by README, CONTRIBUTING, Homepage)
56+
57+
[🚎code-conduct]: https://gitlab.com/oauth-xx/oauth/-/blob/main/CODE_OF_CONDUCT.md
58+
[🖐contributors]: https://gitlab.com/oauth-xx/oauth/-/graphs/main
59+
[🖐contributors-img]: https://img.shields.io/github/contributors-anon/oauth-xx/oauth-ruby
60+
[mailinglist]: http://groups.google.com/group/oauth-ruby
61+
[🚎src-main]: https://gitlab.com/oauth-xx/oauth/-/tree/main
62+
[🏘chat]: https://gitter.im/oauth-xx/oauth-ruby
63+
[rubygems-security-guide]: https://guides.rubygems.org/security/#building-gems
64+
[rubygems]: https://rubygems.org

‎Gemfile

+2-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,8 @@ gem "pry", platforms: %i[mri]
1313
platforms :mri do
1414
gem "codecov", "~> 0.6" # For CodeCov
1515
gem "overcommit", "~> 0.58"
16-
gem "rubocop-md"
16+
# See: https://github.com/rubocop/rubocop-md/issues/14
17+
# gem "rubocop-md"
1718
gem "rubocop-minitest"
1819
gem "rubocop-packaging"
1920
gem "rubocop-performance"

‎Gemfile.lock

-3
Original file line numberDiff line numberDiff line change
@@ -95,8 +95,6 @@ GEM
9595
parser (>= 3.1.1.0)
9696
rubocop-lts (18.0.1)
9797
rubocop-ruby2_7 (~> 1.0.6)
98-
rubocop-md (1.0.1)
99-
rubocop (>= 1.0)
10098
rubocop-minitest (0.22.0)
10199
rubocop (>= 0.90, < 2.0)
102100
rubocop-packaging (0.5.1)
@@ -164,7 +162,6 @@ DEPENDENCIES
164162
redcarpet
165163
rest-client
166164
rubocop-lts (~> 18.0)
167-
rubocop-md
168165
rubocop-minitest
169166
rubocop-packaging
170167
rubocop-performance

‎SECURITY.md

+33-33
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,33 @@
1-
#<--rubocop/md--># Security Policy
2-
#<--rubocop/md-->
3-
#<--rubocop/md-->## Supported Versions
4-
#<--rubocop/md-->
5-
#<--rubocop/md-->| Version | Supported | EOL | Post-EOL / Enterprise |
6-
#<--rubocop/md-->|---------|----------|---------|---------------------------------------|
7-
#<--rubocop/md-->| 1.1.x | ✅ | 04/2023 | [Tidelift Subscription][tidelift-ref] |
8-
#<--rubocop/md-->| 1.0.x | ✅ | 04/2023 | [Tidelift Subscription][tidelift-ref] |
9-
#<--rubocop/md-->| 0.6.x | 🚨 | 04/2023 | [Tidelift Subscription][tidelift-ref] |
10-
#<--rubocop/md-->| 0.5.x | 🚨 | 04/2023 | [Tidelift Subscription][tidelift-ref] |
11-
#<--rubocop/md-->| <= 0.5 | ⛔ | ⛔ | ⛔ |
12-
#<--rubocop/md-->
13-
#<--rubocop/md-->LEGEND:
14-
#<--rubocop/md-->✅ - Supported
15-
#<--rubocop/md-->🚨 - Will only receive critical bug and security updates.
16-
#<--rubocop/md-->⛔ - No Support
17-
#<--rubocop/md-->
18-
#<--rubocop/md-->### EOL Policy
19-
#<--rubocop/md-->
20-
#<--rubocop/md-->Non-commercial support for the oldest version of Ruby (which itself is going EOL) will be dropped each year in April.
21-
#<--rubocop/md-->
22-
#<--rubocop/md-->## Reporting a Vulnerability
23-
#<--rubocop/md-->
24-
#<--rubocop/md-->To report a security vulnerability, please use the [Tidelift security contact](https://tidelift.com/security).
25-
#<--rubocop/md-->Tidelift will coordinate the fix and disclosure.
26-
#<--rubocop/md-->
27-
#<--rubocop/md-->## OAuth for Enterprise
28-
#<--rubocop/md-->
29-
#<--rubocop/md-->Available as part of the Tidelift Subscription.
30-
#<--rubocop/md-->
31-
#<--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]
32-
#<--rubocop/md-->
33-
#<--rubocop/md-->[tidelift-ref]: https://tidelift.com/subscription/pkg/rubygems-oauth?utm_source=rubygems-oauth&utm_medium=referral&utm_campaign=enterprise&utm_term=repo
1+
# Security Policy
2+
3+
## Supported Versions
4+
5+
| Version | Supported | EOL | Post-EOL / Enterprise |
6+
|---------|----------|---------|---------------------------------------|
7+
| 1.1.x | ✅ | 04/2023 | [Tidelift Subscription][tidelift-ref] |
8+
| 1.0.x | ✅ | 04/2023 | [Tidelift Subscription][tidelift-ref] |
9+
| 0.6.x | 🚨 | 04/2023 | [Tidelift Subscription][tidelift-ref] |
10+
| 0.5.x | 🚨 | 04/2023 | [Tidelift Subscription][tidelift-ref] |
11+
| <= 0.5 | ⛔ | ⛔ | ⛔ |
12+
13+
LEGEND:
14+
✅ - Supported
15+
🚨 - Will only receive critical bug and security updates.
16+
⛔ - No Support
17+
18+
### EOL Policy
19+
20+
Non-commercial support for the oldest version of Ruby (which itself is going EOL) will be dropped each year in April.
21+
22+
## Reporting a Vulnerability
23+
24+
To report a security vulnerability, please use the [Tidelift security contact](https://tidelift.com/security).
25+
Tidelift will coordinate the fix and disclosure.
26+
27+
## OAuth for Enterprise
28+
29+
Available as part of the Tidelift Subscription.
30+
31+
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]
32+
33+
[tidelift-ref]: https://tidelift.com/subscription/pkg/rubygems-oauth?utm_source=rubygems-oauth&utm_medium=referral&utm_campaign=enterprise&utm_term=repo

0 commit comments

Comments
 (0)