New Doc: docs/devguide/release.rst (#262)

Author: Nusnus

docs/devguide/index.rst

@@ -20,3 +20,4 @@ are used and how to set up a local development environment.
     local-development-environment
     tox
     sphinx
+    release

docs/devguide/release.rst

@@ -0,0 +1,114 @@
+.. _release:
+
+==============================
+ How to release a new version
+==============================
+
+:Release: |version|
+:Date: |today|
+
+The following guide will describe the steps to release a new version of the :pypi:`pytest-celery <pytest-celery>` plugin.
+It will explain how does the CI/CD pipeline work and how to trigger a new release.
+
+.. contents::
+    :local:
+    :depth: 3
+
+CI/CD Pipeline
+==============
+
+Continuous Integration
+~~~~~~~~~~~~~~~~~~~~~~
+
+.. versionadded:: 1.0.0
+
+The `CI <https://github.com/celery/pytest-celery/actions>`_ platform is based on GitHub Actions and it is triggered on every push to the repository,
+and on every pull request, according to the changes made.
+
+The configuration files for the CI pipeline are located in the `.github/workflows <https://github.com/celery/pytest-celery/tree/main/.github/workflows>`_
+directory of the repository.
+
+CI Tests
+--------
+
+Unit, Integration and Smoke tests.
+
+.. literalinclude:: ../../.github/workflows/python-package.yml
+    :language: yaml
+    :caption: .github/workflows/python-package.yml
+
+Parallel Tests
+--------------
+
+These are the :ref:`tox_parallel` and :ref:`tox_xdist` tox environments. The purpose
+of this CI pipeline is to make sure that the plugin is compatible with parallel running, both
+in terms of supporting :pypi:`pytest-xdist <pytest-xdist>` and functionally (i.e. that the plugin
+does not break when running in parallel).
+
+.. literalinclude:: ../../.github/workflows/parallel-support.yml
+    :language: yaml
+    :caption: .github/workflows/python-package.yml
+
+Linting
+-------
+
+Standard linting checks.
+
+.. literalinclude:: ../../.github/workflows/linter.yml
+    :language: yaml
+    :caption: .github/workflows/linting.yml
+
+Examples
+--------
+
+The official plugin examples are tested as part of the standard CI pipeline.
+
+.. literalinclude:: ../../.github/workflows/examples.yml
+    :language: yaml
+    :caption: .github/workflows/examples.yml
+
+Docker
+------
+
+This pipeline is used to to make sure the provided Dockerfiles from the plugin are built successfully.
+
+.. literalinclude:: ../../.github/workflows/docker.yml
+    :language: yaml
+    :caption: .github/workflows/docker.yml
+
+.. _continuous_deployment:
+
+Continuous Deployment
+~~~~~~~~~~~~~~~~~~~~~
+
+.. versionadded:: 1.0.0
+
+The `CD <https://github.com/celery/pytest-celery/actions/workflows/deploy.yml>`_ is configured to deploy a new
+release to the `PyPI <https://pypi.org/project/pytest-celery/#history>`_ package index.
+
+The following release workflow is triggered automatically when a new released is tagged and published on GitHub.
+
+.. literalinclude:: ../../.github/workflows/deploy.yml
+    :language: yaml
+    :caption: .github/workflows/deploy.yml
+
+.. note::
+
+    The ``poetry version`` command should say there's nothing to change, because this should have been done in the PR that prepared the release.
+
+Release Steps
+=============
+
+To make a new release, you need to create a new PR with one of these titles.
+
+- **Official Release**: Prepare for release: vX.Y.Z
+- **Pre-release**: Prepare for (pre) release: vX.Y.Z
+
+The PR should contain the following changes:
+
+- Version bump using `poetry version <https://python-poetry.org/docs/cli#version>`_ command.
+- Changelog update.
+
+This PR will be used as a double check for the CI to make sure everything passes successfully before releasing the new version.
+Once this PR is merged, the last step is to `release a version on GitHub <https://github.com/celery/pytest-celery/releases/new>`_.
+This will trigger the :ref:`CD pipeline <continuous_deployment>` to deploy the new release to PyPI automatically.

docs/devguide/tox.rst

@@ -103,6 +103,8 @@ To run this environment, use::
 
     tox -e xdist
 
+.. _tox_parallel:
+
 parallel
 ========
 
@@ -171,6 +173,8 @@ To run **just the pre-commit** locally (without tox, without doc), use::
 
     pre-commit run --show-diff-on-failure --color=always --all-files
 
+.. _tox_clean:
+
 clean
 =====
 

docs/faq.rst

@@ -149,7 +149,7 @@ The Docker environment should be install normally, regardless of the plugin.
 How can I clean up Docker artifacts left after a test run?
 ----------------------------------------------------------
 
-**Answer:** You may use this snippet from the ``tox -e clean`` environment.
+**Answer:** You may use this snippet from the :ref:`tox_clean` tox environment.
 
 .. literalinclude:: ../tox.ini
    :language: ini