grtcdr / liaison Goto Github PK

forgecast-get-resource-url should infer the forge and slug parameters automatically (will vc work for us?), this should allow the reuse of the same format specifier and also reduce the number of parameters that the function accepts.

I was recently made aware of the confusion surrounding the choice of name for this package.

I think "Liaison" fits the bill quite nicely. As to why that is, Wiktionary defines the word as:

(Sens figuré) Rapport, suite, connexité, lien.

This means that in the figurative sense, "Liaison" is a "link", and that is exactly what this package is intended to do.

Hi Aziz! Nice work!! The manual website looks slick, and I like the package name change.

I just updated from an old commit to the latest main branch, and I noticed that urls which liaison generates for my sourcehut repo are missing the branch name.

For example, I'm getting
https://git.sr.ht/~breatheoutbreathein/ushin.org/log//item/build-site.el
when I expect
https://git.sr.ht/~breatheoutbreathein/ushin.org/log/master/item/build-site.el

Thank for this project!

URL builders internal to the library (forgecast--build-*-url) will return a broken link if the document they're being called in lives inside of a git submodule.

This is because submodules by default are in a detached HEAD state (as they check out specific commits of a specific branch), this in turn causes forgecast--get-current-branch to return a string in the form of (HEAD <commit-id>) instead of a specific branch e.g. main.

Although there have been numerous attempts to address this side effect, none have worked so far, namely:

• Pulling and merging the submodule in question with git submodule update --remote --merge as a first step of building the website at the build system level.
• Explicitly checking out the main branch of the submodule in question at the build system level.

We can't work around this issue by hardcoding a default branch, because the name of a repository's default branch can vary.