Skip to content

Commit

Permalink
doc: update steps to release a new version
Browse files Browse the repository at this point in the history
close #983

---------

Co-authored-by: Muhammad Faraz  Maqsood <faraz.maqsood@a006-01130.home>
  • Loading branch information
Faraz32123 and Muhammad Faraz Maqsood committed Jan 23, 2024
1 parent a04d57f commit e106787
Showing 1 changed file with 12 additions and 3 deletions.
15 changes: 12 additions & 3 deletions docs/tutor.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://github.com/overhangio/tutor-discovery/commit/e30a78936d63439bde069aeff11960585bd81592>`__.

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 <https://github.com/overhangio/tutor-discovery/commit/18cce706a794c4968e713f0f72c6b912a2ff1e53>`__.
- Run tests with ``make test``.
- Push your changes to the upstream repository.

Expand Down

0 comments on commit e106787

Please sign in to comment.