Skip to content

Commit

Permalink
docs: add migration guide for docs deploy index action (#586)
Browse files Browse the repository at this point in the history
Co-authored-by: Jorge Martínez <[email protected]>
  • Loading branch information
Revathyvenugopal162 and jorgepiloto authored Sep 30, 2024
1 parent f7cee48 commit 6ecbe8a
Showing 1 changed file with 26 additions and 13 deletions.
39 changes: 26 additions & 13 deletions doc/source/migrations/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,26 +9,21 @@ have been updated.

Development version
-------------------

**New features:**

- Added an optional input to the ``ansys/actions/build-library`` action to disable library build
validation on demand using the ``validate-build: false`` argument. This is useful when you want to
skip the library build validation step in the action.
- Incorporated the usage of `Trusted Publisher <https://docs.pypi.org/trusted-publishers/>`_ in the
``ansys/actions/release-pypi-*`` actions. This is useful when you want to sign the package before
uploading it to PyPI.

**Breaking changes:**

- Use secrets for commit and push credentials within ``ansys/actions/doc-changelog``,
``ansys/actions/doc-deploy-changelog``, ``ansys/actions/doc-deploy-dev``, and
``ansys/actions/doc-deploy-stable``.

**Migration steps:**
**Deprecated features:**

- To set up your repository to use the ``ansys/actions/release-pypi-*`` action with the `Trusted Publisher`_ approach,
see the :ref:`release_pypi_trusted_publisher`.
- The ``ansys/actions/doc-deploy-index`` action has been deprecated and will be removed in the next release.
With the deprecation of ``pymeilisearch`` and the adoption of a static search index via the ``ansys-sphinx-theme``,
the ``ansys/actions/doc-deploy-index`` action is no longer necessary.

- The ``ansys/actions/commit-style`` action has been renamed to ``ansys/actions/check-pr-title``.

**Migration steps:**

- Add the following required inputs to ``ansys/actions/doc-changelog``, ``ansys/actions/doc-deploy-changelog``,
``ansys/actions/doc-deploy-dev``, and ``ansys/actions/doc-deploy-stable``:
Expand All @@ -38,6 +33,24 @@ Development version
bot-user: ${{ secrets.PYANSYS_CI_BOT_USERNAME }}
bot-email: ${{ secrets.PYANSYS_CI_BOT_EMAIL }}
Version ``v7``
--------------

**New features:**

- Added an optional input to the ``ansys/actions/build-library`` action to disable library build
validation on demand using the ``validate-build: false`` argument. This is useful when you want to
skip the library build validation step in the action.

- Incorporated the usage of `Trusted Publisher <https://docs.pypi.org/trusted-publishers/>`_ in the
``ansys/actions/release-pypi-*`` actions. This is useful when you want to sign the package before
uploading it to PyPI.

**Migration steps:**

- To set up your repository to use the ``ansys/actions/release-pypi-*`` action with the `Trusted Publisher`_ approach,
see the :ref:`release_pypi_trusted_publisher`.

Version ``v6``
--------------

Expand Down

0 comments on commit 6ecbe8a

Please sign in to comment.