Sign upLogin

RasaHQ/rasa

View on GitHub
Star
scripts/publish_gh_release_notes.py

Summary

Maintainability
A
2 hrs
Test Coverage

Function parse_changelog has a Cognitive Complexity of 11 (exceeds 5 allowed). Consider refactoring.
Open

def parse_changelog(tag_name: Text) -> Text:
    """Read the changelog and extract the most recently release entry."""

    p = Path(__file__).parent.parent / "CHANGELOG.mdx"
    changelog_lines = p.read_text(encoding="UTF-8").splitlines()
Severity: Minor
Found in scripts/publish_gh_release_notes.py - About 1 hr to fix

Cognitive Complexity

Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

A method's cognitive complexity is based on a few simple rules:

  • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
  • Code is considered more complex for each "break in the linear flow of the code"
  • Code is considered more complex when "flow breaking structures are nested"

Further reading

Function main has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
Open

def main():
    tag_name = os.environ.get("GITHUB_TAG")
    if not tag_name:
        print("environment variable GITHUB_TAG not set", file=sys.stderr)
        return 1
Severity: Minor
Found in scripts/publish_gh_release_notes.py - About 35 mins to fix

Cognitive Complexity

Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

A method's cognitive complexity is based on a few simple rules:

  • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
  • Code is considered more complex for each "break in the linear flow of the code"
  • Code is considered more complex when "flow breaking structures are nested"

Further reading

Avoid too many return statements within this function.
Open

    return 0
Severity: Major
Found in scripts/publish_gh_release_notes.py - About 30 mins to fix

    Avoid too many return statements within this function.
    Open

            return 5
    Severity: Major
    Found in scripts/publish_gh_release_notes.py - About 30 mins to fix

      There are no issues that match your filters.

      Category
      Status