Add verbose information to version generation logic #844
Conversation
| @@ -47,10 +57,16 @@ Result pickTaggedCommit( | |||
| for (String tag : tags) { | |||
| boolean isNextVersion = nextVersionTagPattern.matcher(tag).matches(); | |||
| if (isNextVersion && (ignoreNextVersionTags || ignoreNextVersionOnHead)) { | |||
| if (verbose) { | |||
There was a problem hiding this comment.
Instead of using IFs we should just do logger.debug()
https://docs.gradle.org/current/userguide/logging.html
There was a problem hiding this comment.
yes, I was thinking about it, but either we'll have to enable debug everywhere, which will probably clutter the logs a lot, but maybe that's ok? or we'll have to indicate for which class we want to change the logging level, which is also probably doable, but maybe less user friendly? What do you think?
There was a problem hiding this comment.
but what verbose actually means? Some random google definition:
using or expressed in more words than are needed.
So I would not be worried about that. Also currently there seems to be only 4 more debug logs:
https://github.com/search?q=repo%3Aallegro%2Faxion-release-plugin%20logger.debug&type=code
There was a problem hiding this comment.
I'm more afraid of debug logs from the entire gradel tool + everything else we call at the same time. But I haven't checked what the result would look like now with debug turned on, I can check it so we don't guess
There was a problem hiding this comment.
I did fast test number o lines:
./gradlew release -Prelease.dryRun -d > debug.log
6877 debug.log
./gradlew release -Prelease.dryRun > standart.log
27 standart.log
There was a problem hiding this comment.
but maybe it's still ok, maybe it's better than complicating the code, and if someone needs additional information, they will somehow dig through these thousands of lines of logs?
There was a problem hiding this comment.
I did a quick research and checked in a few other plugins if someone uses the verbose flag or rather the login level. From what I see, however, the login level is used, so I will choose this option. It will be much much simpler
src/main/java/pl/allegro/tech/build/axion/release/domain/VersionSorter.java
Outdated
Show resolved
Hide resolved
|
|
||
| for (TagsOnCommit tagsEntry : taggedCommits.getCommits()) { | ||
| List<String> tags = tagsEntry.getTags(); | ||
| tagsFound = tagsFound || !tags.isEmpty(); |
There was a problem hiding this comment.
When this will happen? Since we are iterating through taggedCommits I would assume that each commit has at least 1 tag otherwise it would NOT be tagged 🤔
There was a problem hiding this comment.
I think that currently in the code there is actually no way for this class to have an empty tag collection, but there is also nothing in this class that would prevent the creation of such an instance. This class even has a special method for such an occasion ;) TagsOnCommit.empty() which creates an instance with an empty list of tags.
This code, I hope, will work correctly in both cases:
- if taggedCommits.getCommits() is empty tagsFound==false
- if the list of tags in taggedCommits.getCommits() is empty then tagsFound==false
The advantage is that we don't have to wonder if someone really thought it was a great idea to pass an empty list to the TagsOnCommit constructor.
You can also set a contract for TagsOnCommit, the list of tags cannot be and then we throw an exception otherwise. Then you can easily simplify this code as you say.
But I'm not insisting, if you feel that this is an unnecessary complication then I'll let you convince me.
There was a problem hiding this comment.
Yeah but TaggedCommits != TagsOnCommit. So either name of the variable is wrong or the logic for filling the TaggedCommits class is wrong. But if TaggedCommits does not contain the check for problematic it would be nice to have it there.
I personally would not check for it like this, but I am not insisting on it.
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #844 +/- ##
============================================
+ Coverage 63.74% 63.80% +0.05%
- Complexity 442 448 +6
============================================
Files 82 82
Lines 1633 1652 +19
Branches 161 167 +6
============================================
+ Hits 1041 1054 +13
- Misses 523 525 +2
- Partials 69 73 +4 ☔ View full report in Codecov by Sentry. |
| @@ -68,14 +84,13 @@ Result pickTaggedCommit( | |||
|
|
|||
| } | |||
| } | |||
| if (!tagsFound) { | |||
| logger.quiet("No tags were found in git history"); | |||
Fix for #826
Adding information about missing tags