Fix/Refactor: Prerelease #435

jacksbox · 2022-04-07T14:16:18Z

Ready for review

Related to #434

When digging into the issue I encountered some more misalignments in my previous provided code for the prerelease feature.
With this PR I want to fix this issues and also do some normalisation work in the package.

@danth @williamluke4 @relekang
Curiously, locally all tests pass. I checked and the test fail because of methods which traverse the git log...
Locally all commits starting from the current branch are analysed (ending with the init commit) - but in the ci pipeline, there is only one commit (Some merge commit I can't find nowhere else... ). Any Idea why this is happening and how to prevent it?
Solved: The problem was, that by default githubs actions/checkout@v2 checks out a single merge commit. It has to be instructed to checkout the actual brach with its full history.

Main changes:

The way new versions are determined now utilise the semvar package
normalised the way versions are matched via regex
Better and unified way to get the current release version

Unsolved Issues:

The whole flow only works, if the same branch is issued for all releases and version bumps (possible improvement: Publish and Prerelease from multiple branches (input desired) #423). To make it work on different branches we need to change how tags are analysed (just in the current branch history)

Possible improvements:
There are now two similar methods to get the current version:
get_current_version: gets the last version, whatever is the last tag or in the config file
get_current_release_version: gets the last not-prerelease version (this is needed to determine the correct level_bump)
for ease of use (they are mostly used together) and further development, this two methods could be merged and return a tuple (current_version, current_release_version)

jacksbox · 2022-04-07T14:19:00Z

semantic_release/history/__init__.py

@@ -46,7 +54,7 @@ def from_variable(config_str: str):
        """
        path, variable = config_str.split(":", 1)
        pattern = (
-            rf'{variable} *[:=] *["\']{PatternVersionDeclaration.version_regex}["\']'
+            rf'{variable} *[:=] *["\']{version_regex}["\']'


replaced to use a single source of truth

jacksbox · 2022-04-07T14:19:05Z

semantic_release/history/__init__.py

@@ -57,7 +65,7 @@ def from_pattern(config_str: str):
        regular expression matching the version number.
        """
        path, pattern = config_str.split(":", 1)
-        pattern = pattern.format(version=PatternVersionDeclaration.version_regex)
+        pattern = pattern.format(version=version_regex)


replaced to use a single source of truth

jacksbox · 2022-04-07T14:20:06Z

semantic_release/history/__init__.py

-                continue
-            matches = re.match(r"v?(\d+.\d+.\d+)", commit_message)
-            if matches:
+            match = re.search(rf"{release_version_pattern}", commit_message)


replaced to use a single source of truth

jacksbox · 2022-04-07T14:20:33Z

semantic_release/vcs_helpers.py


+        match = re.search(rf"{pattern}", i.name)


replaced to use a single source of truth

jacksbox · 2022-04-07T14:20:47Z

setup.cfg

@@ -14,5 +14,8 @@ force_grid_wrap=0
 use_parentheses=True
 line_length=88

+[flake8]
+max-line-length = 120


should I remove this again?

jacksbox · 2022-04-07T14:23:22Z

semantic_release/history/__init__.py

+    if config.get("version_source") == "tag":
+        return get_current_release_version_by_tag()
+    else:
+        return get_current_release_version_by_commits()


get_current_release_version should give us the last not-prerelease version.
As the config file does not give us any history, we have to analyse commits here instead of just looking into the config file.

jacksbox · 2022-04-07T14:29:20Z

semantic_release/history/__init__.py

+release_version_pattern = f"(\d+.\d+.\d+(?!{prerelease_pattern}))"
+
+release_version_regex = rf"{release_version_pattern}"
+version_regex = rf"{version_pattern}"


I added this variables as single source of truth for regex version matching, for ease of use once as string and once as regex.

danth

The changes so far look good to me, although there are some conflicts which need to be fixed.

Are you still working on this or is it ready to be merged?

williamluke4

👍

jacksbox · 2022-04-25T07:52:32Z

rebased

jacksbox · 2022-05-02T12:09:57Z

@danth / @williamluke4
can you hit merge ;)

danth · 2022-05-02T15:22:10Z

@jacksbox Done!

EDIT: since merging it seems that the tests are now failing.

jacksbox · 2022-05-09T08:45:24Z

@danth probably we should rollback for now - until we decided / come up with a more secure way of parsing the commit history.

sorry for introducing this issues :(

ghost · 2022-05-27T13:57:03Z

Just picked up this change in my pipeline. Seems the negative lookback in the release version check is stripping all but the first digit of the patch version.

debug: Parsing current version: path=PosixPath('src/analytics_calc/init.py') pattern='version *[:=] *"\'["\']' num_matches=1
debug: Regex matched version: 0.0.24
debug: get_current_version_by_config_file -> 0.0.24
debug: get_current_release_version_by_commits()
debug: Checking commit 19569b7cf15c3d21c7ed45dc335a386aed4d997e
debug: Checking commit 32ae4df6ee88c31e145f5109aa89c782c1c4795c
debug: Checking commit ccee325f58b449cdce1e623313efe7e1bbe6657d
debug: Checking commit 9a951310467c011f7050efead12059a5ce8537bc
debug: Checking commit c22ae08de4193e9c450d3d24fd07722d1a10fe6f
debug: Checking commit f453ba3f1e76e6d62c5a49ddc15f475401d8d66d
debug: Version matches regex 0.0.24-beta.0
debug:
debug: Automatically generated by python-semantic-release
debug: get_current_release_version_by_commits -> 0.0.2
Current version: 0.0.24, Current release version: 0.0.2
debug: evaluate_version_bump('0.0.24', 'patch')
debug: evaluate_version_bump -> patch
debug: get_new_version('0.0.24', '0.0.2', 'patch', True)

Tested the current regex in isolation against the current version and I am indeed seeing a stripped version number returned as match[1] - (\d+.\d+.\d+(?!-beta.\d+)) matched on 0.0.24-beta.0 gives 0.0.2

Removing the "-" from before beta in the regex seems to provide the desired output 🤷

jacksbox commented Apr 7, 2022

View reviewed changes

semantic_release/vcs_helpers.py

match = re.search(rf"{pattern}", i.name)

Copy link

Contributor Author

jacksbox Apr 7, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

replaced to use a single source of truth

jacksbox commented Apr 7, 2022

View reviewed changes

jacksbox changed the title ~~WIP: Fix/Refactor: Prerelease~~ Fix/Refactor: Prerelease Apr 7, 2022

jacksbox mentioned this pull request Apr 7, 2022

The version number will be confused when use --prerelease option #434

Closed

jacksbox force-pushed the feature/prerelease-reworked branch 9 times, most recently from 6611e10 to 6ef2404 Compare April 13, 2022 06:38

danth approved these changes Apr 13, 2022

View reviewed changes

williamluke4 approved these changes Apr 23, 2022

View reviewed changes

jacksbox added 6 commits April 25, 2022 10:39

feat: improve prerelease determination and version regex

1ebfc11

feat: add method to find current release version

d8b443e

feat: correctly identify and bump new versions

3e3963b

fix: escape dots in regex

f958968

test: sanity test

5c270ea

fix: adjust gh action to use the full commit history

73059ed

jacksbox force-pushed the feature/prerelease-reworked branch from 6ef2404 to 73059ed Compare April 25, 2022 07:52

danth merged commit 94c9494 into python-semantic-release:master May 2, 2022

This was referenced May 5, 2022

Workflows with python-semantic-release broke on 03.05.22 #442

Closed

fix: get_current_release_version incorrectly parses commit message with version #444

Closed

ghost mentioned this pull request May 30, 2022

Difference between version 7.28.1 and 7.29.0 when doing semantic-release publish #450

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix/Refactor: Prerelease #435

Fix/Refactor: Prerelease #435

jacksbox commented Apr 7, 2022 •

edited

Loading

jacksbox Apr 7, 2022

jacksbox Apr 7, 2022

jacksbox Apr 7, 2022

jacksbox Apr 7, 2022

jacksbox Apr 7, 2022

jacksbox Apr 7, 2022

jacksbox Apr 7, 2022

danth left a comment

williamluke4 left a comment

jacksbox commented Apr 25, 2022

jacksbox commented May 2, 2022

danth commented May 2, 2022 •

edited

Loading

jacksbox commented May 9, 2022

ghost commented May 27, 2022 •

edited by ghost

Loading

Fix/Refactor: Prerelease #435

Fix/Refactor: Prerelease #435

Conversation

jacksbox commented Apr 7, 2022 • edited Loading

Ready for review

jacksbox Apr 7, 2022

Choose a reason for hiding this comment

jacksbox Apr 7, 2022

Choose a reason for hiding this comment

jacksbox Apr 7, 2022

Choose a reason for hiding this comment

jacksbox Apr 7, 2022

Choose a reason for hiding this comment

jacksbox Apr 7, 2022

Choose a reason for hiding this comment

jacksbox Apr 7, 2022

Choose a reason for hiding this comment

jacksbox Apr 7, 2022

Choose a reason for hiding this comment

danth left a comment

Choose a reason for hiding this comment

williamluke4 left a comment

Choose a reason for hiding this comment

jacksbox commented Apr 25, 2022

jacksbox commented May 2, 2022

danth commented May 2, 2022 • edited Loading

jacksbox commented May 9, 2022

ghost commented May 27, 2022 • edited by ghost Loading

jacksbox commented Apr 7, 2022 •

edited

Loading

danth commented May 2, 2022 •

edited

Loading

ghost commented May 27, 2022 •

edited by ghost

Loading