Release script for downstream OTP forks

[t2gran]

Summary

This PR contain two scripts custom-release.py and changelog-diff.py to make a release in a DOWNSTREAM fork of OTP. These scripts are not intended for releasing the main OTP repository.

See the (CUSTOM_RELEASE_README)[script/CUSTOM_RELEASE_README.md] for documentation of custom-release.py.

The changelog-diff.py can be used to diff the changelog.md file for any two versions of OTP.

Issue

🟥 There is not issue for this. But, these scripts is requested from time to time. This PR provides a common place to maintain them. At Entur we now run the custom-release.py as the first step in our OTP CI/CD Pipeline.

Unit tests

🟥 No tests provided.

Documentation

✅ The scripts are documented in the readme, se above.

Changelog

✅ This is relevant for advanced deplyments.

Bumping the serialization version id

🟥 Not relevant.

[t2gran]

I will add a check on the environment to the prepare_release - that the git repo is named correct. Other than that this is ready for review. The bash script is replaced with a pyton script with much better error handling.

[optionsome]

There are formatting issues.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 70.35%. Comparing base (e26cbb5) to head (2b03d81).
Report is 79 commits behind head on dev-2.x.

Additional details and impacted files

@@              Coverage Diff              @@
##             dev-2.x    #6345      +/-   ##
=============================================
+ Coverage      70.31%   70.35%   +0.03%     
- Complexity     18158    18170      +12     
=============================================
  Files           2058     2062       +4     
  Lines          76942    76931      -11     
  Branches        7773     7763      -10     
=============================================
+ Hits           54101    54123      +22     
+ Misses         20086    20051      -35     
- Partials        2755     2757       +2     

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

[t2gran]

I have improved the error handling in the scripts and simplified a bit. Ready for review.

[optionsome]

I would prefer if there was a directory under the script directory for these files so you can have just a regular README for it.

[t2gran]

At Entur we use this this in the GitHub workflow. You may copy the workflow scripts if you want. Here is how we want to set up our pipeline - we have a data pipeline as well, but that is not shown.

[tkalvas]

Someone will come up with an error situation where they want the entire output.

[t2gran]

Improvements are always welcome. For example dumping everything to a custom-release.log file and crop terminal output is fine with me. The script potentially print the 20 versions of the root pom.xml in addition to running Maven, so the log can be long - I prefer cropping some of it, so it is easier to find the important stuff. I have also modified the script to print everything a couple of times to debug.

[tkalvas]

Yes, I guess it's best to crop the log which is going to stdout, and write the full log to a file in /tmp

[t2gran]

Thank you for a good review @tkalvas, I renamed and rewrote a lot to make it generic (not Entur specific) - sorry for all the misstakes.

I have tested the script after my changes - it still works.