Migration.md

layout	published	title	nav_order
default	true	Migration	5

Migration - v2 to v3

With v3 not only new features were added, but following behaviour changed or was completely removed.

Remove of "level up"

Since Bridgecrew standalone edition will be shutting down at the end of 2023 we removed the "level up" flow, which is triggered by just running checkov without any flag.

Python custom checks

If you are still using the old syntax of running your custom code

from __future__ import annotations

from typing import Any

from checkov.common.models.enums import CheckResult
from checkov.terraform.checks.resource.base_resource_check import BaseResourceCheck


class Example(BaseResourceCheck):
    ...

    def scan_resource_conf(self, conf: dict[str, list[Any]], entity_type: str) -> CheckResult:
        ...

then you can easily use the simplified syntax and still access entity_type, if needed

from __future__ import annotations

from typing import Any

from checkov.common.models.enums import CheckResult
from checkov.terraform.checks.resource.base_resource_check import BaseResourceCheck


class Example(BaseResourceCheck):
    ...

    def scan_resource_conf(self, conf: dict[str, list[Any]]) -> CheckResult:
        if self.entity_type == 'aws_instance':
            ...
        
        ...

Repo ID requirement

For anyone using checkov with an API key will now require to set the repo ID via flag.

checkov -d. --bc-api-key xyz --repo-id example/example

Deprecated flag removal

Following flags were deprecated a while ago and are now completely removed

• --no-guide
• --skip-suppressions
• --skip-policy-download

They were combined and replaced by the --skip-download flag.