This page is not created by, affiliated with, or supported by Slack Technologies, Inc.
2022-07-07
Channels
- # aleph (10)
- # announcements (6)
- # architecture (23)
- # atom-editor (2)
- # beginners (35)
- # biff (5)
- # cljdoc (22)
- # clojure (14)
- # clojure-europe (18)
- # clojure-hungary (26)
- # clojure-nl (6)
- # clojure-uk (6)
- # clojurescript (39)
- # core-async (1)
- # data-science (14)
- # datascript (20)
- # datomic (4)
- # graalvm (18)
- # jobs-discuss (5)
- # keechma (1)
- # leiningen (4)
- # malli (3)
- # nbb (11)
- # nextjournal (2)
- # off-topic (1)
- # parinfer (1)
- # releases (1)
- # remote-jobs (3)
- # shadow-cljs (7)
- # sql (2)
- # xtdb (4)
With https://github.com/technomancy/leiningen/issues/2800, is there anything specific on cljdoc’s side that should be modified/updated to support Codeberg as code hosting site? I’m thinking link generation and that sort of stuff, if anything.
Dunno @U8SFC8HLP, good question. Codeberg is new to me. We have explicit tests for github, gitlab, and sourcehut.
Has there been any movement on looking for cljdoc-prefixed tags before the "normal" ones? If not it seems like that would be a relatively easy entrypoint for me to contribute.
There’s a bit of discussion around it here: https://github.com/cljdoc/cljdoc/issues/31 I think the tag approach makes sense but maybe float a proposal there and get some feedback + code pointers there if you like?
Fair enough. I actually think that the git tag version is better as it doesn't rely on any specific branch naming scheme or that the default branch be the one that all releases are made to. But people've spoken about that at some length there, I don't have much to add.
That sounds great. I think one open question with the git tag might be: how does cljdoc know to rebuild documentation. When a git tag is added or changed cljdoc will rely on some sort of mechanism for that.
I'd just figure it'd only rebuild if you click the rebuild button
and as an author you'd know if you force push that tag to change it you need to go to the site and click it
Then we’ll need a well visible rebuild button…. which we can have but I’ve sort of avoided adding it because it might increase unnecessary/spam builds.
I mean it's already established in the "for library developers" documentation that you need to click there, I don't think it needs to be any more visible, since git tagging like this is only relevant to library authors anyway.
Like there's basically already support for moving tags and rebuilding documentation, the only actual problem with the existing implementation is that for source-based libraries you basically have to have two different tags, one of them in your pom for cljdoc to find, and one "real" one for you to note in your docs.
I didn’t realize it’s documented now! In that case I think I’m ok with that reasoning and just looking up a specific tag 👍
I'm just thinking that when you look at the tag in the pom you prefix it with cljdoc/
and check that tag first when you rebuild.
Feels like a step in the right direction!
Should I make note of this in the issue? I thought this was the same as what had been suggested before, but maybe that's not true and it needs documented.
Yeah, I think especially if you intend to start working on it maybe just briefly flag that and the approach you’ll follow
There we go, I wrote up my thoughts and posted them there.
As mentioned in github comment we did some thinking around this in https://github.com/cljdoc/cljdoc/issues/459 and I think it matches what you are proposing @U5NCUG8NR.
Yeah I was originally thinking of this idea as it related to source-based libs, or dual-release libs, and I think that yeah, looking at the issue there it aligns with what I was thinking of very well.
There is a small nuance that I dug out of of my tattered old brain. Cljdoc assumes that the sources in the jar are in sync with the sources on git. It provides links to the sources on scm (usually github) from the API docs. So if the sources on git change enough, those links might not be exactly right after a rebuild. It might be enough to simply mention this when updating to the docs.