Skip to content

Discrepencies between main README and custom_rule_development.md #635

@rcolombo

Description

@rcolombo

The "Distribution of Custom Rules" in the main README states:

Any custom rules should derive from CfnNag::BaseRule in cfn-nag/base_rule (not cfn-nag/custom-rules/base)

The custom rule development doc states the following for storing custom rules in a directory of my choice

You'll need to modify the import of the BaseRule class from require_relative 'base' to require 'cfn-nag/custom_rules/base'.

In order to get custom rules to work, I either needed to:

  1. Place them in cfn-nags defined custom rule directory, using require relative 'base' and extending the BaseRule class
  2. Place them in the directory of my choosing, use require 'cfn-nag/custom_rules/base' and extend the BaseRule class (extending CfnNag::BaseRule did not work).

Neither of these solutions seem to align with the text in the base README.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions