Clojurians Log v2
cljdoc
@adam678 yeah, I was afraid you’d say that you’re using deps 😄 unfortunately in this case you’ll need to manually tweak your pom.xml to add the scope fields
Hehe, fair enough. I'll try later and come back crying if needed. Have a nice day!
sounds good! You too 🙂
What is the current idiomatic way of updating docs? Does it still involve a new release or did something happened after: https://github.com/cljdoc/cljdoc/issues/31
Oh absolutely not @seancorfield, you are always so courteous, kind, generous and respectful! You set a great example for the Clojure community. FWIW, it is hard to read tone in text, but my intended tone is always free of any huff. :simple_smile:
Yeah, I was chatting with someone about using .commits count. I too feel it makes releases feel less precious. He did not see it that way, but for me it works.
new release still required
I guess you could always move the release tag on the repo to include the doc changes, and then ask http://cljdoc.org to re-analyze the release?
(assuming your pom.xml in the library has a tag, not a SHA)
oh true, that could work
@martinklepsch Is that where http://cljdoc.org reads the SCM info?
Yeah, I had to do it recently with HoneySQL: I screwed up the release tag (put it on the wrong branch) and only noticed after http://cljdoc.org generated the docs — so I moved the tag to the correct place and clicked the “invisible” button on http://cljdoc.org to re-analyze and it seemed to work. The JAR I had deployed to Clojars was correct, and the pom.xml had the right <tag> entry: v2.0.0-alpha3 — it was just in the wrong place in Git.
That’s good too know @seancorfield, thanks for sharing!
Everyone is different, but personally I’m cool with just cutting another release even if only docs need updating.
Technically correct (the best kind of correct) I guess slightly moving a tag is less controversial than rebasing the main branch 😛
Documentation is a feature, imo, so I generally agree with @lee. Although, if there's an embarassing typo, it's kind of nice to be able to silently fix it.
I think it’s “OK” to make a branch from your original release tag and make doc fixes on that branch and just move the tag (as long as you’re only changing documentation).
But to each their own. At least http://cljdoc.org allows some way to redo the docs for a given tag…