From 47ec9de73bbba9bbf92e8e06de0e0837661f8054 Mon Sep 17 00:00:00 2001 From: Christophe Bliard Date: Mon, 7 Mar 2022 14:47:50 +0100 Subject: [PATCH] Indicate what MFA means in Gemspec/RequireMFA cop documentation --- config/default.yml | 2 +- docs/modules/ROOT/pages/cops_gemspec.adoc | 7 ++++--- lib/rubocop/cop/gemspec/require_mfa.rb | 7 ++++--- 3 files changed, 9 insertions(+), 7 deletions(-) diff --git a/config/default.yml b/config/default.yml index ff77706e15a..6744cfaea2e 100644 --- a/config/default.yml +++ b/config/default.yml @@ -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: diff --git a/docs/modules/ROOT/pages/cops_gemspec.adoc b/docs/modules/ROOT/pages/cops_gemspec.adoc index c4f11a6c472..f312e776a37 100644 --- a/docs/modules/ROOT/pages/cops_gemspec.adoc +++ b/docs/modules/ROOT/pages/cops_gemspec.adoc @@ -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` diff --git a/lib/rubocop/cop/gemspec/require_mfa.rb b/lib/rubocop/cop/gemspec/require_mfa.rb index 5f29769e8b3..798c4d6dc57 100644 --- a/lib/rubocop/cop/gemspec/require_mfa.rb +++ b/lib/rubocop/cop/gemspec/require_mfa.rb @@ -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`