Add verbose information to version generation logic

[tomasz-pankowski-allegro]

Fix for #826

Adding information about missing tags

[ddeath]

Instead of using IFs we should just do logger.debug()
https://docs.gradle.org/current/userguide/logging.html

[tomasz-pankowski-allegro]

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?

[ddeath]

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

[tomasz-pankowski-allegro]

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

[tomasz-pankowski-allegro]

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

[tomasz-pankowski-allegro]

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?

[tomasz-pankowski-allegro]

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

[tomasz-pankowski-allegro]

I'm not sure which login level would be most appropriate

[bgalek]

quiet is default in gradle

[radoslaw-panuszewski]

No, the lifecycle log level is the default log level in Gradle (docs). If you log on quiet, it will be visible even when running with ./gradlew -q. It's not a good practice to log everything on quiet since users that explicitly want to hide the logs via the -q switch will see them anyway.

[bgalek]

my mistake, I forgot about lifecycle

[ddeath]

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 🤔

[tomasz-pankowski-allegro]

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.

[ddeath]

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]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 62.35%. Comparing base (099f892) to head (621bb85).
Report is 9 commits behind head on main.

Additional details and impacted files

@@             Coverage Diff              @@
##               main     #844      +/-   ##
============================================
- Coverage     63.74%   62.35%   -1.40%     
- Complexity      442      445       +3     
============================================
  Files            82       83       +1     
  Lines          1633     1684      +51     
  Branches        161      161              
============================================
+ Hits           1041     1050       +9     
- Misses          523      566      +43     
+ Partials         69       68       -1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

---

🚨 Try these New Features:

• Flaky Tests Detection - Detect and resolve failed and flaky tests

[ddeath]

imho this should be warning