From e106787927d9043aad0e636cdfbcb60e94224c7f Mon Sep 17 00:00:00 2001 From: Muhammad Faraz Maqsood Date: Tue, 23 Jan 2024 14:36:48 +0500 Subject: [PATCH] doc: update steps to release a new version close #983 --------- Co-authored-by: Muhammad Faraz Maqsood --- docs/tutor.rst | 15 ++++++++++++--- 1 file changed, 12 insertions(+), 3 deletions(-) diff --git a/docs/tutor.rst b/docs/tutor.rst index c4f9381..350726f 100644 --- a/docs/tutor.rst +++ b/docs/tutor.rst @@ -68,9 +68,18 @@ You can then browse the documentation with:: Releasing a new version ~~~~~~~~~~~~~~~~~~~~~~~ -- Bump the ``__version__`` value in ``tutor/__about__.py``. (see :ref:`versioning` below) -- Collect changelog entries with ``make changelog``. -- Create a commit with the version changelog. +Releasing a version includes two phases: + +1. Add changes and generate individual changelog entries: + +- run ``make changelog-entry``(or ``scriv create``) command - It will create changelog entries in a folder named changelog.d for the changes user has done for releasing a new version. +- Commit and merge all the changes including the changelog entries. e.g this `commit `__. + +2. Update version and compile changelogs: + +- Now bump the ``__version__`` value in ``tutor/__about__.py``. (see :ref:`versioning` below). +- Collect changelog entries with ``make changelog``(or ``scriv collect``) command - It will delete all previous changelog entries from changelog.d folder and will add records of those entries to CHANGELOG.md file. +- Create a commit with the version changelog e.g. this `commit `__. - Run tests with ``make test``. - Push your changes to the upstream repository.