chore(release): add CHANGELOG.md, setup scriv to maintain it

Author: agateau-gg

.github/workflows/changelog-check.yml

@@ -0,0 +1,27 @@
+# This workflow only accepts PRs if they either contain a changelog fragment,
+# or have been applied the `skip-changelog` label.
+name: Changelog check
+
+on:
+  pull_request:
+    types:
+      # On by default if you specify no types.
+      - 'opened'
+      - 'reopened'
+      - 'synchronize'
+      # For `skip-changelog` only.
+      - 'labeled'
+      - 'unlabeled'
+
+jobs:
+  check-changelog:
+    runs-on: ubuntu-22.04
+    steps:
+      - name: 'Check for changelog fragment'
+        uses: brettcannon/[email protected]
+        with:
+          file-pattern: |
+            changelog.d/*.md
+            CHANGELOG.md
+          skip-label: 'skip-changelog'
+          failure-message: 'Missing a changelog fragment in ${file-pattern}. Please add one using `scriv create` or apply the `${skip-label}` label to the pull request'

CHANGELOG.md

@@ -0,0 +1,9 @@
+# Changelog
+
+<a id='changelog-1.5.0'></a>
+
+## 1.5.0 - 2022-11-28
+
+### Added
+
+- `Client` can now run IaC scans (gitguardian/ggshield#405).

CONTRIBUTING.md

@@ -45,3 +45,9 @@ Line length in the one enforced by Black: 88 characters.
 - The first sentence starts with a capital letter and ends with a point. This sentence is separated from the others by a blank line
 - Docstrings must have :params: if the function has 2 or more arguments.
 - All docstrings must state the return object and raised exception with :return: and :raise:
+
+### Changelog
+
+We use [scriv](https://github.com/nedbat/scriv) to manage our changelog. It is automatically installed by `pipenv install --dev`.
+
+All user visible changes must be documented in a changelog fragment. You can create one with `scriv create`. If your pull request only contains non-visible changes (such as refactors or fixes for regressions introduced _after_ the latest release), then apply the `skip-changelog` label to the pull request.

Pipfile

@@ -17,3 +17,4 @@ pytest = "*"
 vcrpy = "*"
 mypy = "==0.961"
 types-requests = "*"
+scriv = { version = "*", extras = ["toml"] }

changelog.d/README.md

@@ -0,0 +1 @@
+This directory holds changelog entries managed by scriv.

pyproject.toml

@@ -26,3 +26,9 @@ warn_unused_ignores = true
 [[tool.mypy.overrides]]
 module = ["tests.*", "examples.*"]
 ignore_errors = true
+
+[tool.scriv]
+version = "literal: pygitguardian/__init__.py: __version__"
+format = "md"
+md_header_level = "2"
+insert_marker = "# Changelog"