diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3161a5da..de95471e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -68,8 +68,12 @@ All version and release management is done via [annotated git tags](https://git- repo metadata used by the [`setuptools_scm`](https://github.com/pypa/setuptools_scm) package to generate the version string provided as `rsconnect:VERSION` and output by `rsconnect version`. +### Update CHANGELOG.md + Before releasing, replace the `Unreleased` heading in the CHANGELOG.md with the version number and date. Update CHANGELOG.md before _EACH_ release, even beta releases, in order to avoid one commit with multiple tags (https://github.com/pypa/setuptools_scm/issues/521). +### Tagging a Release + To create a new release, create and push an annotated git tag: ```bash diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md index f3d739aa..ccbb32b8 100644 --- a/docs/CHANGELOG.md +++ b/docs/CHANGELOG.md @@ -5,7 +5,13 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). -## [Unreleased] - ?? +## [1.28.2] - 2025-12-05 + +### Fixed + +- Corrected Changelog to show the correct version number of the 1.28.1 release. + +## [1.28.1] - 2025-12-05 ### Fixed