Skip to content

CHANGELOG.md

Latest commit

 

History

History
271 lines (137 loc) · 5.96 KB

CHANGELOG.md

File metadata and controls

271 lines (137 loc) · 5.96 KB

Changelog

1.29.0 — 2026-01-27

Added

  • Capture secret incident custom_tags dictionaries when calling retrieve_secret_incident.

1.28.0 — 2025-12-29

Fixed

  • MembersParameters, TeamInvitationParameters, and TeamMembershipParameters now properly apply pagination and search queries.

1.27.0 — 2025-11-14

Changed

  • Changed the following fields to str: visibility, kind, presence status, ignore_reason, tag.

1.26.0 — 2025-10-27

Fixed

  • Missing scope leading to validation errors

1.25.0 — 2025-08-26

Changed

  • Updated Client.scan_and_create_incidents() to match server-side API changes.

1.24.0 — 2025-07-28

Added

  • Added GGClient.scan_and_create_incidents() function to scan content for secrets and automatically create incidents.

  • Added vault_type, vault_name, vault_path and vault_path_count fields to PolicyBreak.

1.23.0 — 2025-06-23

Changed

  • Set PolicyBreak's detector_name and detector_group_name fields as optional to fix backwards compatibility with the GitGuardian API

1.22.0 — 2025-05-26

Added

  • Added is_vaulted field to PolicyBreak.

1.21.0 — 2025-04-29

Added

  • Added extra information to scan results: detector name, detector group name, and documentation URL.

Fixed

  • Added missing scopes to the TokenScope enum.

1.20.0 — 2025-02-25

Removed

  • Removed support for the deprecated SCA and IaC endpoints.

1.19.0 — 2025-01-07

Added

  • Added support for members and teams endpoints.
  • Added support for invitations endpoints.
  • Added support for sources endpoints.

1.18.0 — 2024-11-25

Added

  • Added the is_diff attribute to ScanResult.

  • Added the following attributes to PolicyBreak: diff_kind, is_excluded and exclude_reason.

  • GGClient now provides a api_tokens() method to retrieve API token details (see https://api.gitguardian.com/docs#tag/API-Tokens).

Changed

  • GGClient.content_scan() and GGClient.multi_content_scan() now accept an all_secrets parameter.

Fixed

  • Add missing value info to Severity model (#120).

1.17.0 — 2024-09-23

Added

1.16.0 — 2024-07-29

Added

  • GGClient now contains remediation messages obtained from the API /metadata endpoint.

1.15.2 — 2024-06-24

Changed

  • The project now uses pdm instead of pipenv.

Fixed

  • GGClient no longer crashes when it receives a server response with no Content-Type header.

1.15.1 — 2024-06-24

Yanked: release process issue.

1.15.0 — 2024-06-24

Yanked: release process issue.

1.14.0 — 2024-02-26

Added

  • Add GGClient.create_honeytoken_with_context() method.

  • Export scan schemas in addition to dataclasses for sca.

1.13.0 — 2024-01-30

Added

  • Added maximum payload size as a property of GGClient.

Changed

  • Set minimum Python version to >=3.8.

1.12.0 — 2024-01-08

Added

  • GGClient now obeys rate-limits and can notify callers when hitting one.

  • Added the following attributes to IaCVulnerability: url, status, ignored_until, ignore_reason, ignore_comment.

  • Added the source_found attribute to IaCScanParameters and IaCDiffScanEntities.

1.11.0 — 2023-10-16

Added

  • Added extra_headers to SCA diff scans.

1.10.0 — 2023-09-26

Fixed

  • Remove potential_siblings from models.

1.9.0 — 2023-08-10

Added

  • Added the GGClient.iac_diff_scan() method. This allows scanning two directories for IaC vulnerabilities and categorizing incidents as new, unchanged or deleted.

Fixed

  • Fixed a bug where py-gitguardian would sometimes increase the length of a document when preparing it to be sent to the secret scan API.

1.8.0 — 2023-06-26

Added

  • Added GGClient.create_jwt() method. This is only used to interact with HasMySecretLeaked for now.

  • py-gitguardian is now fully type-hinted (#49).

Changed

  • All HTTP requests are now logged using Python logger. The log message includes the HTTP method, endpoint, status code and duration.

Fixed

  • GGClient.iac_directory_scan() was not correctly sending the files to scan.

1.7.0 — 2023-05-29

Added

  • Added GGClient.create_honeytoken() method.

  • Added GGClient.read_metadata() to read metadata from the server. The metadata is then used by further secret scan calls and is available in a new GGClient.secret_scan_preferences attribute.

1.6.0 — 2023-04-20

Added

  • The PolicyBreak class now includes the URL of the policy break if the dashboard already knows about it.

1.5.1 — 2023-03-29

Fixed

  • Python dependencies were not correctly defined: py-gitguardian was using marshmallow-dataclass and click without depending on them. The package now explicitly depends on marshmallow-dataclass and does not use click anymore (#43).

1.5.0 — 2022-11-28

Added