Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

feat: add previous version to github action outputs#1302

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.

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

Already on GitHub?Sign in to your account

Merged
Show file tree
Hide file tree
Changes fromall commits
Commits
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
5 changes: 5 additions & 0 deletionsaction.yml
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -135,6 +135,11 @@ outputs:
The link to the release in the remote VCS, if a release was made. If no release was made,
this will be an empty string.

previous_version:
description: |
The previous version before the release, if a release was or will be made. If no release is detected,
this will be the current version or an empty string if no previous version exists.

released:
description: |
"true" if a release was made, "false" otherwise
Expand Down
12 changes: 12 additions & 0 deletionsdocs/configuration/automatic-releases/github-actions.rst
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -552,6 +552,18 @@ Example when no release was made: ``""``

----

.. _gh_actions-psr-outputs-previous_version:

``previous_version``
""""""""""""""""""""

**Type:** ``string``

The previous version before the release, if a release was or will be made. If no release is detected,
this will be the current version or an empty string if no previous version exists.

----

.. _gh_actions-psr-outputs-released:

``released``
Expand Down
6 changes: 6 additions & 0 deletionssrc/semantic_release/cli/commands/version.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -578,6 +578,12 @@ def version( # noqa: C901
if print_only or print_only_tag:
return

# TODO: need a better way as this is inconsistent if releasing older version patches
if last_release := last_released(config.repo_dir, tag_format=config.tag_format):
# If we have a last release, we can set the previous version for the
# GitHub Actions output
gha_output.prev_version = last_release[1]

with Repo(str(runtime.repo_dir)) as git_repo:
release_history = ReleaseHistory.from_git_history(
repo=git_repo,
Expand Down
19 changes: 17 additions & 2 deletionssrc/semantic_release/cli/github_actions_output.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -23,20 +23,22 @@ def __init__(
version: Version | None = None,
commit_sha: str | None = None,
release_notes: str | None = None,
prev_version: Version | None = None,
) -> None:
self._gh_client = gh_client
self._released = released
self._version = version
self._commit_sha = commit_sha
self._release_notes = release_notes
self._prev_version = prev_version

@property
def released(self) -> bool | None:
return self._released

@released.setter
def released(self, value: bool) -> None:
iftype(value) is notbool:
ifnot isinstance(value,bool):
raise TypeError("output 'released' is boolean")
self._released = value

Expand All@@ -46,7 +48,7 @@ def version(self) -> Version | None:

@version.setter
def version(self, value: Version) -> None:
iftype(value) is notVersion:
ifnot isinstance(value,Version):
raise TypeError("output 'released' should be a Version")
self._version = value

Expand DownExpand Up@@ -84,6 +86,18 @@ def release_notes(self, value: str) -> None:
raise TypeError("output 'release_notes' should be a string")
self._release_notes = value

@property
def prev_version(self) -> Version | None:
if not self.released:
return self.version
return self._prev_version if self._prev_version else None

@prev_version.setter
def prev_version(self, value: Version) -> None:
if not isinstance(value, Version):
raise TypeError("output 'prev_version' should be a Version")
self._prev_version = value

def to_output_text(self) -> str:
missing: set[str] = set()
if self.version is None:
Expand All@@ -106,6 +120,7 @@ def to_output_text(self) -> str:
"tag": self.tag,
"is_prerelease": str(self.is_prerelease).lower(),
"link": self._gh_client.create_release_url(self.tag) if self.tag else "",
"previous_version": str(self.prev_version) if self.prev_version else "",
"commit_sha": self.commit_sha if self.commit_sha else "",
}

Expand Down
14 changes: 7 additions & 7 deletionstests/e2e/cmd_version/test_version_github_actions.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -52,6 +52,9 @@ def test_version_writes_github_actions_output(
all_versions = get_versions_from_repo_build_def(repo_def)
latest_release_version = all_versions[-1]
release_tag = tag_format_str.format(version=latest_release_version)
previous_version = (
Version.parse(all_versions[-2]) if len(all_versions) > 1 else None
)
hvcs_client = cast("Github", get_hvcs_client_from_repo_def(repo_def))
repo_actions_per_version = split_repo_actions_by_release_tags(
repo_definition=repo_def,
Expand All@@ -66,12 +69,11 @@ def test_version_writes_github_actions_output(
"is_prerelease": str(
Version.parse(latest_release_version).is_prerelease
).lower(),
"previous_version": str(previous_version) if previous_version else "",
"release_notes": generate_default_release_notes_from_def(
version_actions=repo_actions_per_version[release_tag],
hvcs=hvcs_client,
previous_version=(
Version.parse(all_versions[-2]) if len(all_versions) > 1 else None
),
previous_version=previous_version,
license_name=EXAMPLE_PROJECT_LICENSE,
mask_initial_release=get_cfg_value_from_def(
repo_def, "mask_initial_release"
Expand DownExpand Up@@ -116,8 +118,6 @@ def test_version_writes_github_actions_output(
assert expected_gha_output["tag"] == action_outputs["tag"]
assert expected_gha_output["is_prerelease"] == action_outputs["is_prerelease"]
assert expected_gha_output["link"] == action_outputs["link"]
assert expected_gha_output["previous_version"] == action_outputs["previous_version"]
assert expected_gha_output["commit_sha"] == action_outputs["commit_sha"]
assert (
expected_gha_output["release_notes"].encode()
== action_outputs["release_notes"].encode()
)
assert expected_gha_output["release_notes"] == action_outputs["release_notes"]
33 changes: 20 additions & 13 deletionstests/unit/semantic_release/cli/test_github_actions_output.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -22,15 +22,17 @@


@pytest.mark.parametrize(
"version, is_prerelease",
"prev_version,version, released, is_prerelease",
[
("1.2.3", False),
("1.2.3-alpha.1", True),
("1.2.2", "1.2.3", True, False),
("1.2.2", "1.2.3-alpha.1", True, True),
("1.2.2", "1.2.2", False, False),
("1.2.2-alpha.1", "1.2.2-alpha.1", False, True),
(None, "1.2.3", True, False),
],
)
@pytest.mark.parametrize("released", (True, False))
def test_version_github_actions_output_format(
released: bool, version: str, is_prerelease: bool
released: bool, version: str, is_prerelease: bool, prev_version: str
):
commit_sha = "0" * 40 # 40 zeroes to simulate a SHA-1 hash
release_notes = dedent(
Expand All@@ -43,15 +45,16 @@ def test_version_github_actions_output_format(
expected_output = (
dedent(
f"""\
released={'true' if released else 'false'}
version={version}
tag=v{version}
is_prerelease={'true' if is_prerelease else 'false'}
link={BASE_VCS_URL}/releases/tag/v{version}
commit_sha={commit_sha}
"""
released={'true' if released else 'false'}
version={version}
tag=v{version}
is_prerelease={'true' if is_prerelease else 'false'}
link={BASE_VCS_URL}/releases/tag/v{version}
previous_version={prev_version or ""}
commit_sha={commit_sha}
"""
)
+ f"release_notes<<EOF\n{release_notes}EOF{os.linesep}"
+ f"release_notes<<EOF{os.linesep}{release_notes}EOF{os.linesep}"
)

with mock.patch.dict(os.environ, {}, clear=True):
Expand All@@ -61,6 +64,7 @@ def test_version_github_actions_output_format(
version=Version.parse(version),
commit_sha=commit_sha,
release_notes=release_notes,
prev_version=Version.parse(prev_version) if prev_version else None,
).to_output_text()

# Evaluate (expected -> actual)
Expand DownExpand Up@@ -106,6 +110,7 @@ def test_version_github_actions_output_writes_to_github_output_if_available(
tmp_path: Path,
):
mock_output_file = tmp_path / "action.out"
prev_version_str = "1.2.2"
version_str = "1.2.3"
commit_sha = "0" * 40 # 40 zeroes to simulate a SHA-1 hash
release_notes = dedent(
Expand All@@ -125,6 +130,7 @@ def test_version_github_actions_output_writes_to_github_output_if_available(
released=True,
commit_sha=commit_sha,
release_notes=release_notes,
prev_version=Version.parse(prev_version_str),
).write_if_possible()

with open(mock_output_file, encoding="utf-8", newline=os.linesep) as rfd:
Expand All@@ -137,6 +143,7 @@ def test_version_github_actions_output_writes_to_github_output_if_available(
assert f"{BASE_VCS_URL}/releases/tag/v{version_str}" == action_outputs["link"]
assert f"v{version_str}" == action_outputs["tag"]
assert commit_sha == action_outputs["commit_sha"]
assert prev_version_str == action_outputs["previous_version"]
assert release_notes == action_outputs["release_notes"]


Expand Down
Loading
[8]ページ先頭
©2009-2025 Movatter.jp