cljdoc

tengstrand 2023-08-13T16:04:53.477309Z

I'm preparing support for snapshot releases. I have added a cljdoc badge to the https://github.com/polyfy/polylith/blob/issue-318/readme.adoc. When I run cljdoc locally (http://localhost:8000/d/polylith/clj-poly/0.2.18-SNAPSHOT/doc/readme) it shows me three different versions: • 0.2.18-SNAPSHOT at the top. • The message "Current release is 0.2.18-issue-318-02". • 0.2.17-alpha in my badge, that takes it from CURRENT in the page. Questions: • Do I need to hard code 0.2.18-SNAPSHOT in the badge instead of using CURRENT? • Where does 0.2.18-issue-318-02 come from? Is it possible to change it to 0.2.18-SNAPSHOT ?

lread 2023-08-13T20:45:43.804739Z

> • 0.2.18-SNAPSHOT at the top. This is the current version you are viewing > • The message "Current release is 0.2.18-issue-318-02". This is the latest known non-SNAPSHOT release (and because you are previewing, this is from your local cljdoc database) > • 0.2.17-alpha in my badge, that takes it from CURRENT in the page. This draws from cljdoc production and is the current release available release on http://cljdoc.org > Questions: > • Do I need to hard code 0.2.18-SNAPSHOT in the badge instead of using CURRENT? There is currently no badge support for SNAPSHOT releases > • Where does 0.2.18-issue-318-02 come from? Is it possible to change it to 0.2.18-SNAPSHOT ? This is the latest known non-SNAPSHOT release (drawn from your locally running cljdoc in this case). And nope, no current support for SNAPSHOT release for badges. See also: https://github.com/cljdoc/cljdoc/blob/master/doc/userguide/for-library-authors.adoc#snapshot-builds The note on scm tag for SNAPSHOT builds is important and a thing folks often get wrong.

lread 2023-08-13T20:51:47.459999Z

I think clojars supports snapshot badges. We could consider that for cljdoc. Could have sworn there was an issue for this already but cannot seem to locate it at the moment.

tengstrand 2023-08-13T21:11:31.539819Z

Okay, thanks. I'm setting :scm https://github.com/polyfy/polylith/blob/1c93ae1c95c4d69682b4fa6a086d5586af79b644/build.clj#L173-L177. Do you think this should be enough?

lread 2023-08-14T04:51:24.278099Z

Yeah, that check seems good to me!

👍 1