Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Indicate what MFA means in Gemspec/RequireMFA doc #10445

Merged
merged 1 commit into from Mar 7, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion config/default.yml
Expand Up @@ -262,7 +262,7 @@ Gemspec/OrderedDependencies:
- '**/*.gemspec'

Gemspec/RequireMFA:
Description: 'Checks that the gemspec has metadata to require MFA from RubyGems.'
Description: 'Checks that the gemspec has metadata to require Multi-Factor Authentication from RubyGems.'
Enabled: pending
VersionAdded: '1.23'
Reference:
Expand Down
7 changes: 4 additions & 3 deletions docs/modules/ROOT/pages/cops_gemspec.adoc
Expand Up @@ -195,9 +195,10 @@ spec.add_dependency 'rspec'

Requires a gemspec to have `rubygems_mfa_required` metadata set.

This setting tells RubyGems that MFA is required for accounts to
be able perform privileged operations, such as (see
RubyGems' documentation for the full list of privileged operations):
This setting tells RubyGems that MFA (Multi-Factor Authentication) is
required for accounts to be able perform privileged operations, such as
(see RubyGems' documentation for the full list of privileged
operations):

* `gem push`
* `gem yank`
Expand Down
7 changes: 4 additions & 3 deletions lib/rubocop/cop/gemspec/require_mfa.rb
Expand Up @@ -5,9 +5,10 @@ module Cop
module Gemspec
# Requires a gemspec to have `rubygems_mfa_required` metadata set.
#
# This setting tells RubyGems that MFA is required for accounts to
# be able perform privileged operations, such as (see
# RubyGems' documentation for the full list of privileged operations):
# This setting tells RubyGems that MFA (Multi-Factor Authentication) is
# required for accounts to be able perform privileged operations, such as
# (see RubyGems' documentation for the full list of privileged
# operations):
#
# * `gem push`
# * `gem yank`
Expand Down