diff --git a/CHANGELOG.md b/CHANGELOG.md index 8d2c9c1..eea05f3 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -3,6 +3,8 @@ All notable changes to this project will be documented here. ## [Unreleased] +### Fixed +- Maintainers' documentation for publishing. ## [1.0.2] - 2023-11-13 ### Added diff --git a/doc/maintaining.md b/doc/maintaining.md index 5fd2552..e4f98f4 100644 --- a/doc/maintaining.md +++ b/doc/maintaining.md @@ -142,11 +142,18 @@ See CHANGELOG.md for details. ### Publish the new version +Prerequisite: generate a API token on PyPI and save it somewhere. +This example will assume the file is saved as `token.txt`. +(PyPI no longer supports normal username/password authentication, +so this step must be performed.) + ```bash -pdm publish +pdm publish -u __token__ -P $(< token.txt) ``` -The PyPI username and password will be requested. +To use the test server, add the arguments `-r testpypi`. Note that +a separate API token will be required, generated from your account +on the test server. ### Publish the code to GitHub