Skip to content

Policy file documentation is incomplete #854

Description

@andy-maier

Checklist

  • I agree to the terms within the Safety Code of Conduct.
  • I have searched existing issues to ensure this bug hasn't been reported before.

Safety version

The documentation of the version 3.0 policy files at https://docs.safetycli.com/safety-docs/administration/safety-policy-files is incomplete:

  • It misses report:dependency-vulnerabilities:auto-ignore-in-report:vulnerabilities, e.g.
    report:
      . . .
      dependency-vulnerabilities:
        . . .
        auto-ignore-in-report:
          . . .
          vulnerabilities:
            51457:
              reason: Py package is no longer being fixed (latest version 1.11.0)
              expires: '2099-01-01'
    
  • It misses installation, e.g.
    installation:
      default-action: allow
      audit-logging:
        enabled: true
      allow:
        packages: []
        vulnerabilities: {}
      deny:
        packages: {}
        vulnerabilities:
          warning-on-any-of:
            cvss-severity: []
            block-on-any-of:
            cvss-severity: []
    

Python version

3.12

Operating System

macOS 15

Bug description

Documentation bug - see above

Steps to reproduce

Read https://docs.safetycli.com/safety-docs/administration/safety-policy-files

Command and output

N/A

Additional context

N/A

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugIndicates a problem that needs to be resolved.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions