Skip to content

Commit

Permalink
docs: add PYTHONPATH mention for commit parser
Browse files Browse the repository at this point in the history
  • Loading branch information
bernardcooke53 committed Oct 20, 2023
1 parent 78f6387 commit 3284258
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
4 changes: 3 additions & 1 deletion docs/commit-parsing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -193,7 +193,9 @@ from the file ``custom_parser.py`` at the root of your repository, you should sp
you can ensure that the module containing your parser class is installed in the same
virtual environment as semantic-release.
If you can run ``python -c "from $MODULE import $CLASS"`` successfully, specifying
``commit_parser="$MODULE:$CLASS"`` is sufficient.
``commit_parser="$MODULE:$CLASS"`` is sufficient. You may need to set the
``PYTHONPATH`` environment variable to the directory containing the module with
your commit parser.

Python Semantic Release provides several building blocks to help you write your parser.
To maintain compatibility with how Python Semantic Release will invoke your parser, you
Expand Down
4 changes: 1 addition & 3 deletions tests/command_line/conftest.py
Original file line number Diff line number Diff line change
@@ -1,9 +1,7 @@
from typing import Generator

import pytest
from click.testing import CliRunner


@pytest.fixture
def cli_runner() -> Generator[CliRunner, None, None]:
def cli_runner() -> CliRunner:
return CliRunner(mix_stderr=False)

0 comments on commit 3284258

Please sign in to comment.