Merge pull request #221 from requests-cache/release-notes

Add notes about releases to contributing guide

Author: alessio-locatelli

.github/workflows/deploy.yml

@@ -14,7 +14,7 @@ on:
         required: false
         default: ''
 env:
-  LATEST_PY_VERSION: '3.11'
+  LATEST_PY_VERSION: '3.12'
 
 jobs:
   # Deploy stable builds on tags only, and pre-release builds from manual trigger ("workflow_dispatch")

.pre-commit-config.yaml

@@ -8,7 +8,7 @@ repos:
       - id: mixed-line-ending
       - id: trailing-whitespace
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.1.13
+    rev: v0.2.1
     hooks:
       - id: ruff
         args: [ --fix ]

CONTRIBUTING.md

@@ -6,7 +6,7 @@ To set up for local development (requires [poetry](https://python-poetry.org/doc
 ```bash
 $ git clone https://github.com/requests-cache/aiohttp-client-cache
 $ cd aiohttp-client-cache
-$ poetry install -E backends -E docs
+$ poetry install -E all -E docs
 ```
 
 ## Pre-commit hooks
@@ -115,12 +115,27 @@ Here are some general guidelines for submitting a pull request:
 - If your changes add or modify user-facing behavior, add documentation describing those changes
 - Submit the PR to be merged into the `main` branch.
 
-## Releases
-Releases are built and published to pypi based on **git tags.**
-[Milestones](https://github.com/requests-cache/aiohttp-client-cache/milestones) will be used to track
+## Notes for Maintainers
+
+### Releases
+* Releases are built and published to PyPI based on **git tags.**
+* [Milestones](https://github.com/requests-cache/aiohttp-client-cache/milestones) will be used to track
 progress on major and minor releases.
+* GitHub Actions will build and deploy packages to PyPI on tagged commits
+on the `main` branch.
+
+Release steps:
+* Update the version in both `pyproject.toml` and `aiohttp_client_cache/__init__.py`
+* Make sure the release notes in `HISTORY.md` are up to date
+* Push a new tag, e.g.: `git tag v0.1 && git push origin --tags`
+* This will trigger a deployment. Verify that this completes successfully and that the new version can be installed from pypi with `pip install`
+* A [readthedocs build](https://readthedocs.org/projects/aiohttp-client-cache/builds/) will be triggered by the new tag. Verify that this completes successfully.
+
+Downstream builds:
+* We also maintain a [Conda package](https://anaconda.org/conda-forge/aiohttp-client-cache), which is automatically built and published by conda-forge whenever a new release is published to PyPI. The [feedstock repo](https://github.com/conda-forge/aiohttp-client-cache-feedstock) only needs to be updated manually if there are changes to dependencies.
+* For reference: [repology](https://repology.org/project/python:aiohttp-client-cache) lists additional downstream packages maintained by other developers.
 
-## Code Layout
+### Code Layout
 Here is a brief overview of the main classes and modules. See [API Reference](https://aiohttp-client-cache.readthedocs.io/en/latest/reference.html) for more complete documentation.
 * `session.CacheMixin`, `session.CachedSession`: A mixin and wrapper class, respectively, for `aiohttp.ClientSession`. There is little logic  here except wrapping `ClientSession._request()` with caching behavior.
 * `response.CachedResponse`: A wrapper class built from an `aiohttp.ClientResponse`, with additional cache-related info. This is what is serialized and persisted to the cache.

HISTORY.md

@@ -1,6 +1,6 @@
 # History
 
-## (Unreleased)
+## 0.11.0
 
 Features
 --------