Use native Markdown for release notes and changelog history

.github/workflows/release.yml

@@ -47,27 +47,18 @@ jobs:
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
-      # towncrier writes the rendered notes to stdout (informational
-      # chatter goes to stderr), so this is the curated release body for
-      # this version, not github-tag-action's commit-derived changelog.
-      - name: Generate the GitHub release notes
+      - name: Assemble native Markdown release notes
         env:
           RELEASE: ${{ steps.calver.outputs.release }}
-        run: uv run --group=release towncrier build --draft --version "$RELEASE" >
-          release-notes.md
-
-      # Assemble the same fragments into CHANGELOG.rst under a new
-      # ``$RELEASE`` section and delete the consumed fragment files.
-      - name: Update the changelog
-        env:
-          RELEASE: ${{ steps.calver.outputs.release }}
-        run: uv run --group=release towncrier build --yes --version "$RELEASE"
+        run: |
+          uv run --group=release towncrier build --yes --version "$RELEASE"
+          cp "docs/source/changelog/$RELEASE.md" release-notes.md
 
       - uses: stefanzweifel/git-auto-commit-action@v7
         id: commit
         with:
           commit_message: Bump CHANGELOG
-          file_pattern: CHANGELOG.rst newsfragments
+          file_pattern: CHANGELOG.md docs/source/changelog newsfragments
           # Error if there are no changes.
           skip_dirty_check: true
 

CHANGELOG.md

@@ -0,0 +1,3 @@
+# Changelog
+
+Release notes are stored as [one Markdown file per version](docs/source/changelog/).

docs/source/changelog.md

@@ -0,0 +1,11 @@
+# Changelog
+
+Releases are assembled from `newsfragments/` using Towncrier.
+
+```{toctree}
+:maxdepth: 1
+:glob:
+:reversed:
+
+changelog/*
+```

docs/source/changelog/2019.11.23.0.md

@@ -0,0 +1,3 @@
+# 2019.11.23.0
+
+- Make `active_flag` and `application_metadata` required on `add_target`.

docs/source/changelog/2020.03.21.0.md

@@ -0,0 +1,3 @@
+# 2020.03.21.0
+
+- Add Windows support.

docs/source/changelog/2020.06.19.0.md

@@ -0,0 +1 @@
+# 2020.06.19.0

docs/source/changelog/2020.08.21.0.md

@@ -0,0 +1,3 @@
+# 2020.08.21.0
+
+- Change the return type of `vws_client.get_target_record` to match what is returned by the web API.

docs/source/changelog/2020.09.07.0.md

@@ -0,0 +1,5 @@
+# 2020.09.07.0
+
+- Breaking change: Move exceptions and create base exceptions.
+  It is now possible to, for example, catch `vws.exceptions.base_exceptions.VWSException` to catch many of the exceptions raised by the `VWS` client.
+  Credit to `@laymonage` for this change.

docs/source/changelog/2021.03.28.0.md

@@ -0,0 +1,5 @@
+# 2021.03.28.0
+
+- Breaking change: The `vws.exceptions.cloud_reco_exceptions.MatchProcessing` is now `vws.exceptions.custom_exceptions.ActiveMatchingTargetsDeleteProcessing`.
+- Added new exception `vws.exceptions.custom_exceptions.RequestEntityTooLarge`.
+- Add better exception handling when querying a server which does not serve the Vuforia API.

docs/source/changelog/2021.03.28.1.md

@@ -0,0 +1 @@
+# 2021.03.28.1

docs/source/changelog/2021.03.28.2.md

@@ -0,0 +1 @@
+# 2021.03.28.2

docs/source/changelog/2023.03.05.md

@@ -0,0 +1 @@
+# 2023.03.05

docs/source/changelog/2023.03.25.md

@@ -0,0 +1,3 @@
+# 2023.03.25
+
+- Support file-like objects in every method which accepts a file.

docs/source/changelog/2023.05.21.md

@@ -0,0 +1,3 @@
+# 2023.05.21
+
+- Breaking change: the `vws.exceptions.custom_exceptions.ActiveMatchingTargetsDeleteProcessing` exception has been removed as Vuforia no longer returns this error.

docs/source/changelog/2023.12.26.md

@@ -0,0 +1 @@
+# 2023.12.26

docs/source/changelog/2023.12.27.md

@@ -0,0 +1,4 @@
+# 2023.12.27
+
+- Breaking change: The `vws.exceptions.cloud_reco_exceptions.UnknownVWSErrorPossiblyBadName` is now `vws.exceptions.custom_exceptions.OopsAnErrorOccurredPossiblyBadName`.
+- `vws.exceptions.custom_exceptions.OopsAnErrorOccurredPossiblyBadName` now has a `response` parameter and attribute.

docs/source/changelog/2024.02.04.1.md

@@ -0,0 +1 @@
+# 2024.02.04.1

docs/source/changelog/2024.02.04.md

@@ -0,0 +1,3 @@
+# 2024.02.04
+
+- Return a new error (`vws.custom_exceptions.ServerError`) when the server returns a 5xx status code.

docs/source/changelog/2024.02.06.md

@@ -0,0 +1,3 @@
+# 2024.02.06
+
+- Exception response attributes are now `vws.exceptions.response.Response` instances rather than `requests.Response` objects.

docs/source/changelog/2024.02.19.md

@@ -0,0 +1,3 @@
+# 2024.02.19
+
+- Add exception response attribute to `vws.exceptions.custom_exceptions.RequestEntityTooLarge`.

docs/source/changelog/2024.09.02.md

@@ -0,0 +1,5 @@
+# 2024.09.02
+
+- Breaking change: Exception names now end with `Error`.
+- Use a timeout (30 seconds) when making requests to the VWS API.
+- Type hint changes: images are now `io.BytesIO` instances or `io.BufferedRandom`.

docs/source/changelog/2024.09.03.md

@@ -0,0 +1,3 @@
+# 2024.09.03
+
+- Make `VWS.make_request` a public method.

docs/source/changelog/2024.09.04.1.md

@@ -0,0 +1 @@
+# 2024.09.04.1

docs/source/changelog/2024.09.04.md

@@ -0,0 +1,4 @@
+# 2024.09.04
+
+- Move `Response` from `vws.exceptions.response` to `vws.types`.
+- Add `raw` field to `Response`.

docs/source/changelog/2024.09.21.md

@@ -0,0 +1 @@
+# 2024.09.21

docs/source/changelog/2025.03.10.1.md

@@ -0,0 +1 @@
+# 2025.03.10.1

docs/source/changelog/2025.03.10.md

@@ -0,0 +1,3 @@
+# 2025.03.10
+
+- Removed `vws.exceptions.custom_exceptions.OopsAnErrorOccurredPossiblyBadName` which now does not occur in VWS.

docs/source/changelog/2026.02.15.md

@@ -0,0 +1,5 @@
+# 2026.02.15
+
+- Add `request_timeout_seconds` parameter to `VWS` and `CloudRecoService`, allowing customization of the request timeout.
+  This accepts a float or a `(connect, read)` tuple, matching the `requests` library's timeout interface.
+  The default remains 30 seconds.

docs/source/changelog/2026.02.21.md

@@ -0,0 +1 @@
+# 2026.02.21

docs/source/changelog/2026.02.22.md

@@ -0,0 +1 @@
+# 2026.02.22

docs/source/changelog/2026.02.23.md

@@ -0,0 +1 @@
+# 2026.02.23

docs/source/changelog/2026.02.24.md

@@ -0,0 +1 @@
+# 2026.02.24

docs/source/changelog/2026.02.25.1.md

@@ -0,0 +1 @@
+# 2026.02.25.1

docs/source/changelog/2026.02.25.md

@@ -0,0 +1 @@
+# 2026.02.25

docs/source/changelog/2026.08.14.md

@@ -0,0 +1,13 @@
+# 2026.08.14
+
+- Drop Python 3.13 support, update VWS Python Mock, and test quota and project-state error responses against the mock.
+- Add `QuotaExceededError`, `LicenseCheckFailedError`, and `AuthorizationFailedError` for documented VuMark Generation API result codes.
+- Fix `target_id` on target exceptions when `base_vws_url` includes a path prefix.
+- Retain explicitly provided falsy custom transports instead of replacing them with defaults.
+- Raise a response-carrying `CloudRecoError` when Cloud Query returns a documented empty or non-JSON 4xx response instead of leaking `JSONDecodeError`.
+- Add support for the Model Target Web API.
+  `ModelTargetService` and `AsyncModelTargetService` create standard and advanced Model Target datasets, wait for them to be generated, download them and delete them.
+- Map the `ProjectHasNoApiAccess` result code, as spelled in Vuforia's result codes table, to `ProjectHasNoAPIAccessError`.
+  The previously mapped `ProjectHasNoAPIAccess` casing, which Vuforia does not document, is no longer mapped.
+- Add support for the Database Reco Counts report.
+  `VWS` and `AsyncVWS` take an optional `database_id`, and have new `request_database_reco_counts_report`, `download_reco_counts_report` and `wait_for_reco_counts_report` methods.

docs/source/changelog/2026.08.26.md

@@ -0,0 +1,3 @@
+# 2026.08.26
+
+- Test synchronous and asynchronous Model Target error responses through the public mock API, and include rate-limit and server-error branches in coverage.

docs/source/changelog/2026.09.07.md

@@ -0,0 +1,5 @@
+# 2026.09.07
+
+- Add `HTTPX2Transport` and `AsyncHTTPX2Transport`, which make requests with `httpx2`, the continuation of `httpx` maintained by Pydantic.
+  The `requests` and `httpx` transports are unchanged.
+  `httpx` and `httpx2` objects are never mixed: the `httpx` transports raise `httpx` exceptions and the `httpx2` transports raise `httpx2` exceptions.

docs/source/conf.py

@@ -17,6 +17,7 @@
 author = _pyproject_config.author
 
 extensions = [
+    "myst_parser",
     "sphinx_copybutton",
     "sphinx.ext.autodoc",
     "sphinx.ext.intersphinx",
@@ -27,15 +28,15 @@
 ]
 
 # Render the unreleased ``newsfragments/`` entries into
-# ``docs/source/unreleased.rst`` so the Sphinx spelling, doc-build and
+# ``docs/source/unreleased.md`` so the Sphinx spelling, doc-build and
 # link-checking gates cover the prose before it is assembled into
-# CHANGELOG.rst at release time.
+# the versioned Markdown notes at release time.
 towncrier_draft_autoversion_mode = "draft"
 towncrier_draft_include_empty = True
 towncrier_draft_working_directory = f"{_pyproject_file.parent}"
 
 templates_path = ["_templates"]
-source_suffix = ".rst"
+source_suffix = {".rst": "restructuredtext", ".md": "markdown"}
 master_doc = "index"
 
 project_copyright = f"%Y, {author}"

docs/source/contributing.rst

@@ -77,3 +77,10 @@ Performing a release
 --------------------
 
 See :doc:`release-process`.
+
+Release notes
+-------------
+
+Write user-facing changes as Markdown in ``newsfragments/<issue>.change.md``.
+Towncrier writes one Markdown file per version, used directly for GitHub release notes.
+Invalid fragment names fail release assembly.