From 4bb87bf330ab65808828ae5d108e1cbac9048292 Mon Sep 17 00:00:00 2001 From: Muhammad Faraz Maqsood Date: Tue, 23 Jan 2024 13:27:35 +0500 Subject: [PATCH 1/2] doc: update steps to release a new version close #983 --- docs/tutor.rst | 15 ++++++++++++--- 1 file changed, 12 insertions(+), 3 deletions(-) diff --git a/docs/tutor.rst b/docs/tutor.rst index 4036ff8678..07034a6568 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. From 8cdd6b2d88f929b699b41d751cc2992d25b6907b Mon Sep 17 00:00:00 2001 From: Muhammad Faraz Maqsood Date: Tue, 23 Jan 2024 14:27:31 +0500 Subject: [PATCH 2/2] use anonymous links to avoid build tests to fail --- docs/tutor.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/tutor.rst b/docs/tutor.rst index 07034a6568..7c9c34a25e 100644 --- a/docs/tutor.rst +++ b/docs/tutor.rst @@ -73,13 +73,13 @@ 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 `_. +- 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 `_. +- Create a commit with the version changelog e.g. this `commit `__. - Run tests with ``make test``. - Push your changes to the upstream repository.