Fix subdirectory tagging

[sloede]

Fixes #281.

Note that this uses the suggestion by @ericphanson in #281 (comment) to proceed with tagging if the corresponding commit could be identified from the registry PR and if the subdirectory hash of that commit matches the Julia package version tree hash.

cc @bgeihe

[ericphanson]

Is this something that we could easily add a test for? Or would that be a big effort?

[sloede]

Is this something that we could easily add a test for? Or would that be a big effort?

I am not sure how I would easily add a test for it, to be honest.

Any test would probably need to go into

TagBot/test/action/test_repo.py

Lines 209 to 226 in 7ac5878

	def test_commit_sha_from_registry_pr(logger):
	r = _repo()
	r._registry_pr = Mock(return_value=None)
	assert r._commit_sha_from_registry_pr("v1.2.3", "abc") is None
	logger.info.assert_called_with("Did not find registry PR")
	r._registry_pr.return_value = Mock(body="")
	assert r._commit_sha_from_registry_pr("v2.3.4", "bcd") is None
	logger.info.assert_called_with("Registry PR body did not match")
	r._registry_pr.return_value.body = f"foo\n- Commit: {'a' * 32}\nbar"
	r._repo.get_commit = Mock()
	r._repo.get_commit.return_value.commit.tree.sha = "def"
	r._repo.get_commit.return_value.sha = "sha"
	assert r._commit_sha_from_registry_pr("v3.4.5", "cde") is None
	r._repo.get_commit.assert_called_with("a" * 32)
	logger.warning.assert_called_with(
	"Tree SHA of commit from registry PR does not match"
	)
	assert r._commit_sha_from_registry_pr("v4.5.6", "def") == "sha"

What is hard to mock, however, is the _git.command(...). I checked other functions that directly run git commands, and, e.g., _versions_clone is also not tested explicitly as far as I can tell (since it would require a mock git repo somewhere with all the right ingredients. Beside this call to git, there is not really much else that could be checked.

Do have any other suggestions?

[ericphanson]

No, I am unfortunately not familiar with the code either, but I totally believe it's hard to test. In that case since the feature is totally broken currently I think it makes sense to fix it still without adding a test. However it would be great if someone more familiar w/ the code could give it a review.

[sloede]

@christopher-dG it would be great if you could review this. I tested the code manually with our repo that originally caused this error to surface, and it seems like everything has been fixed. As stated above, adding tests for this is hard, since we would have to mock an entire git repo.

[christopher-dG]

Seems good 👍

[sloede]

Thanks a lot for for bearing with me, with TagBot v1.16.1 we finally have our first successful, TagBot-created release for the subdirectory package LibTrixi.jl (which is part of https://github.com/trixi-framework/libtrixi).

[ericphanson]

Awesome! FYI, you can now configure Documenter to build stable docs based on tag prefixes, if you want to: https://documenter.juliadocs.org/dev/man/hosting/#Deploying-from-a-monorepo (another subdir feature thanks to @hannahilea!). Although I see you aren't using prefixes on your tags, so maybe that's irrelevant in this case.

[sloede]

You're right, we don't use prefixes, but thanks for letting me know 👍