Skip to content

Commit

Permalink
docs: reduce readthedocs formats and add entries to migration from v7…
Browse files Browse the repository at this point in the history
… guide
  • Loading branch information
bernardcooke53 committed Jul 17, 2023
1 parent 5fbd52d commit 9b6ddfe
Show file tree
Hide file tree
Showing 2 changed files with 47 additions and 9 deletions.
10 changes: 9 additions & 1 deletion .readthedocs.yml
Original file line number Diff line number Diff line change
@@ -1,12 +1,20 @@
---
version: 2

sphinx:
configuration: docs/conf.py
formats: all
builder: html
formats:
- htmlzip

python:
install:
- method: pip
path: .
extra_requirements:
- docs

build:
os: "ubuntu-22.04"
tools:
python: "3"
46 changes: 38 additions & 8 deletions docs/migrating_from_v7.rst
Original file line number Diff line number Diff line change
Expand Up @@ -187,6 +187,23 @@ You should run::
With steps 1-5 being handled by the :ref:`cmd-version` command, and steps 6 and 7
handled by the :ref:`cmd-publish` command.

.. _breaking-removed-define-option:

Removal of `-D/--define` command-line option
""""""""""""""""""""""""""""""""""""""""""""

It is no longer possible to override arbitrary configuration values using the `-D`/
`--define` option. You should provide the appropriate values via a configuration
file using :ref:`cmd-main-option-config` or via the available command-line options.

This simplifies the command-line option parsing significantly and is less error-prone,
which has resulted in previous issues (e.g. `#600`_) with overriddes on the command-line.
Some of the configuration values expected by Python Semantic Release use complex data
types such as lists or nested structures, which would be tedious and error-prone to
specify using just command-line options.

.. _#600: https://github.com/python-semantic-release/python-semantic-release/issues/600

.. _breaking-commands-no-verify-ci:

Removal of CI verifications
Expand Down Expand Up @@ -513,14 +530,6 @@ needs.
.. _pip issue: https://github.com/pypa/pip/issues/8437#issuecomment-805313362


.. _breaking-configuration-undeprecating-pypi-token:

``pypi_token`` is un-deprecated
"""""""""""""""""""""""""""""""

As this is passed directly to `twine upload`_, the configuration option has been
un-deprecated for consistency and to avoid confusion.

.. _breaking-commit-parser-options:

Commit parser options
Expand Down Expand Up @@ -556,6 +565,27 @@ for a project and store this in an environment variable like so::

export VERSION=$(semantic-release version --print)

.. _breaking-version-toml-type:

``version_toml``
""""""""""""""""

This option will no longer accept a string or comma-separated string of version
locations to be updated in TOML files. Instead, you must supply a ``List[str]``.
For existing configurations using a single location in this option, you can
simply wrap the value in ``[]``:

.. code-block:: toml
# Python Semantic Release v7 configuration
[tool.semantic_release]
version_toml = "tool.poetry.version:{version}"
# Python Semantic Release v8 configuration
[tool.semantic_release]
version_toml = ["tool.poetry.version:{version}"]
.. _breaking-tag-format-validation:

``tag_format``
Expand Down

0 comments on commit 9b6ddfe

Please sign in to comment.