Merge pull request #45 from GitGuardian/agateau/setup-scriv

Add a CHANGELOG

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'

.github/workflows/test-lint.yml

@@ -41,20 +41,26 @@ jobs:
         python-version: ['3.7', '3.8', '3.9', '3.10', '3.11']
     steps:
       - uses: actions/checkout@v3
+
       - name: Set up Python ${{ matrix.python-version }}
         uses: actions/setup-python@v1
         with:
           python-version: ${{ matrix.python-version }}
+
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
           python -m pip install --upgrade pipenv==2022.10.4
           pipenv install --system --dev --skip-lock
+
       - name: Test with pytest
         run: |
           pipenv run coverage run --source pygitguardian -m pytest --disable-pytest-warnings
           pipenv run coverage report --fail-under=80
           pipenv run coverage xml
+        env:
+          GITGUARDIAN_API_KEY: ${{ secrets.GITGUARDIAN_API_KEY }}
+
       - uses: codecov/codecov-action@v1
         with:
           file: ./coverage.xml
@@ -70,21 +76,31 @@ jobs:
       - uses: actions/checkout@v3
         with:
           fetch-depth: 0
+
       - name: Set up Python
         uses: actions/setup-python@v2
         with:
           python-version: '3.x'
+
       - name: Install dependencies
         run: python -m pip install --upgrade pip setuptools wheel
       - name: Build distribution
         run: >-
           python setup.py sdist bdist_wheel
+
       - name: Publish distribution 📦 to PyPI
         uses: pypa/gh-action-pypi-publish@master
         with:
           user: __token__
           password: ${{ secrets.pypi_password }}
-      - name: Release Notary Action
-        uses: docker://aevea/release-notary:0.9.1
+
+      - name: Create Release
+        id: create_release
+        uses: actions/create-release@master
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          tag_name: ${{ steps.tags.outputs.tag }}
+          release_name: ${{ steps.tags.outputs.tag }}
+          draft: true
+          prerelease: false

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/20230327_152427_aurelien.gateau_setup_scriv.md

@@ -0,0 +1,41 @@
+<!--
+A new scriv changelog fragment.
+
+Uncomment the section that is right (remove the HTML comment wrapper).
+-->
+
+<!--
+### Removed
+
+- A bullet item for the Removed category.
+
+-->
+<!--
+### Added
+
+- A bullet item for the Added category.
+
+-->
+<!--
+### Changed
+
+- A bullet item for the Changed category.
+
+-->
+<!--
+### Deprecated
+
+- A bullet item for the Deprecated category.
+
+-->
+
+### 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).
+
+<!--
+### Security
+
+- A bullet item for the Security category.
+
+-->

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"