René's URL Explorer Experiment

Title: Fix up checks in Makefile and make them portable by EliahKagan · Pull Request #1661 · gitpython-developers/GitPython · GitHub

Open Graph Title: Fix up checks in Makefile and make them portable by EliahKagan · Pull Request #1661 · gitpython-developers/GitPython

X Title: Fix up checks in Makefile and make them portable by EliahKagan · Pull Request #1661 · gitpython-developers/GitPython

Description: Fixes #1660 In .gitattributes: Fix checking out init-tests-after-clone.sh with LF line endings on all systems (this was broken). Add Makefile to so it is also checked out with LF line endings on all systems. (Windows ports of make will usually tolerate CRLF line endings, but \r or other representations of CR may, and often do, appear in output, giving an appearance of a problem that is hard to dismiss. So it's worth keeping it LF.) For the force_release target: Don't try to upload if building failed (#1660). Only suggest using a virtual environment to solve a failure that occurred outside of one. In a virtual environment, use python, not python3, for compatibility with Windows. (Windows may have a python3 command installed outside the virtual environment, which is the most confusing case, since it gets used even from inside, so it feels like installing packages in the venv had no effect. In contrast, some Debian and derived systems, and some macOS systems, have no python command outside a venv, or it's Python 2. So keep using python3 when no venv is detected.) For the release target: Reference the current commit as HEAD rather than head. HEAD is more portable, because git does not treat names case-insensitively by default on all systems. head works on Windows and I think macOS, but not GNU/Linux or most other Unix-like systems. Use git tag --sort=-v:refname with an appropriate versionsort.suffix to order the version tags in the specific SemVer-inspired way this project uses, and a glob to omit the non-version tags. This avoids the correctness problem with the | sort -nr approach, is portable, and is more precise for this project's versions than even nonportable sort -V tweaked for SemVer, because this project has SemVer suffixes like -pre where N-pre sorts before N, but also non-SemVer -patched where N-patched sorts after N. (Thanks to @hugovk for investigating what sort -nr was doing on macOS!) Decrease duplication of complex git commands and pipelines. Write the checks to fail if a command in $( ) fails (by extracting them to assignments), so that if a git command whose output is needed fails, this doesn't cause a check to wrongly succeed. Check for VERSION and changes.rst, against each other and also the latest tag name. Check for uncommitted changes. Do the version/tag/reference agreement check after printing out a table showing all the relevant values, so the specific problems can always be efficiently identified. The above includes checks for indications that each of the actions listed in the README.md release instructions was done, and is intended to make it so make release is correct, fully usable, and preferable to make force_release in most situations. I have tested this on Ubuntu and Windows. When testing, I pressed Ctrl+C when twine prompted for credentials. I tested both the release and force_release targets. Some of the manual tests of the release target on Ubuntu can be seen in this original gist from before that review, and this newer gist testing build-release.sh. Although not shown in those gists, I have also tested that the Makefile targets use the scripts correctly since extracting commands to them. Here's an example of output from make release showing various checks and the new version/tag/ref table and failing with an error due to an inconsistency that should block the release: (.venv) ek@Glub:~/repos-wsl/GitPython (portable-makefile=)$ make release rm -rf build/ dist/ .eggs/ .tox/ ./check-version.sh Checking current directory. Checking that VERSION and doc/source/changes.rst exist and have no uncommitted changes. Checking that ALL changes are committed. Gathering current version, latest tag, and current HEAD commit info. VERSION file = 3.1.36 changes.rst = 3.1.36 Latest tag = 3.1.36 HEAD SHA = 4b7d7028193d3a03cc20867fa534e21528886f51 Latest tag SHA = 5297f6210f185c9df9c97392ffef4da8562b58ff ./check-version.sh: Check failed. Stopping. make: *** [Makefile:10: release] Error 1 Here's an example of a failure where it doesn't get anywhere near that far: (.venv) ek@Glub:~/repos-wsl/GitPython (portable-makefile +=)$ make release rm -rf build/ dist/ .eggs/ .tox/ ./check-version.sh Checking current directory. Checking that VERSION and doc/source/changes.rst exist and have no uncommitted changes. M VERSION ./check-version.sh: Check failed. Stopping. make: *** [Makefile:10: release] Error 1

Open Graph Description: Fixes #1660 In .gitattributes: Fix checking out init-tests-after-clone.sh with LF line endings on all systems (this was broken). Add Makefile to so it is also checked out with LF line endings on a...

X Description: Fixes #1660 In .gitattributes: Fix checking out init-tests-after-clone.sh with LF line endings on all systems (this was broken). Add Makefile to so it is also checked out with LF line endings on a...

Opengraph URL: https://github.com/gitpython-developers/GitPython/pull/1661

X: @github

direct link

Domain: github.com

Links:

Viewport: width=device-width