Skip to content

fix: ignore dependencies versions bump when parsing version from commit logs #476

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 24, 2022
Merged

fix: ignore dependencies versions bump when parsing version from commit logs #476

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 8 additions & 3 deletions semantic_release/history/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,14 +29,19 @@ def get_prerelease_pattern():
return f"-{config.get('prerelease_tag')}\.\d+"


def get_pattern_with_commit_subject(pattern):
escaped_commit_subject = re.escape(config.get("commit_subject"))
return escaped_commit_subject.replace("\{version\}", pattern)


def get_version_pattern():
prerelease_pattern = get_prerelease_pattern()
return f"(\d+\.\d+\.\d+({prerelease_pattern})?)"
return get_pattern_with_commit_subject(f"(\d+\.\d+\.\d+({prerelease_pattern})?)")


def get_release_version_pattern():
prerelease_pattern = get_prerelease_pattern()
return f"(\d+\.\d+\.\d+(?!.*{prerelease_pattern}))"
return get_pattern_with_commit_subject(f"v?(\d+\.\d+\.\d+(?!.*{prerelease_pattern}))")


class VersionDeclaration(ABC):
Expand Down Expand Up @@ -401,7 +406,7 @@ def get_current_release_version_by_commits() -> str:

for commit_hash, commit_message in get_commit_log():
logger.debug(f"Checking commit {commit_hash}")
match = release_version_re.search(commit_message)
match = release_version_re.match(commit_message)
if match:
logger.debug(f"Version matches regex {commit_message}")
return match.group(1).strip()
Expand Down
2 changes: 1 addition & 1 deletion semantic_release/vcs_helpers.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ def version_finder(tag):

match = re.search(pattern, i.name)
if match:
return match.group(0).strip()
return match.group(1).strip()

return None

Expand Down
20 changes: 20 additions & 0 deletions tests/history/test_version.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -163,6 +163,26 @@ def test_should_return_correct_version_without_prerelease(self):
assert get_current_release_version_by_commits() == "7.28.0"


@mock.patch(
"semantic_release.history.get_commit_log",
lambda: [("222", "chore(deps): bump random lib to 7.29.0"), ("211", "7.28.0"), ("13", "7.27.0")],
)
def test_should_return_correct_version_ignoring_dependency_bumps(self):
assert get_current_release_version_by_commits() == "7.28.0"


@mock.patch(
"semantic_release.history.get_commit_log",
lambda: [("222", "7.29.0"), ("211", "chore(release): 7.28.0"), ("13", "7.27.0")],
)

def test_should_return_correct_version_with_commit_subject(self):
with mock.patch(
"semantic_release.history.config.get", wrapped_config_get(commit_subject="chore(release): {version}")
):
assert get_current_release_version_by_commits() == "7.28.0"


class TestGetNewVersion:
def test_major_bump(self):
assert get_new_version("0.0.0", "0.0.0", "major") == "1.0.0"
Expand Down
6 changes: 3 additions & 3 deletions tests/test_vcs_helpers.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -359,9 +359,9 @@ def test_checkout_should_checkout_correct_branch(mock_git):
@pytest.mark.parametrize(
"pattern, skip_tags,expected_result",
[
("\d+.\d+.\d+", None, "2.0.0"),
("\d+.\d+.\d+", ["v2.0.0"], "1.1.0"),
("\d+.\d+.\d+", ["v0.1.0", "v1.0.0", "v1.1.0", "v2.0.0"], None),
("(\d+.\d+.\d+)", None, "2.0.0"),
("(\d+.\d+.\d+)", ["v2.0.0"], "1.1.0"),
("(\d+.\d+.\d+)", ["v0.1.0", "v1.0.0", "v1.1.0", "v2.0.0"], None),
],
)
def test_get_last_version(pattern, skip_tags, expected_result):
Expand Down