Fork me on GitHub
#cljdoc
<
2021-03-18
>
martinklepsch09:03:26

@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

Adam Helins10:03:21

Hehe, fair enough. I'll try later and come back crying if needed. Have a nice day!

martinklepsch10:03:47

sounds good! You too 🙂

Adam Helins14:03:09

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

martinklepsch16:03:45

new release still required

seancorfield16:03:47

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?

seancorfield16:03:03

(assuming your pom.xml in the library has a tag, not a SHA)

martinklepsch16:03:17

oh true, that could work

seancorfield16:03:20

@U050TNB9F Is that where http://cljdoc.org reads the SCM info?

✔️ 3
seancorfield16:03:16

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.

martinklepsch16:03:58

That’s good too know @U04V70XH6, thanks for sharing!

lread22:03:46

Everyone is different, but personally I’m cool with just cutting another release even if only docs need updating.

Adam Helins23:03:24

Technically correct (the best kind of correct) I guess slightly moving a tag is less controversial than rebasing the main branch 😛

Alys Brooks23:03:09

Documentation is a feature, imo, so I generally agree with @UE21H2HHD. Although, if there's an embarassing typo, it's kind of nice to be able to silently fix it.

seancorfield23:03:01

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).

seancorfield23:03:59

But to each their own. At least http://cljdoc.org allows some way to redo the docs for a given tag…

lread02:03:20

True enough! Not suggesting my way is the right way, just sharing how I roll.

seancorfield03:03:24

@UE21H2HHD Wasn't meant to be a dig -- sorry if it sounded that way. There's a good case for making a new release even if it's just doc updates -- especially with the idea of major.minor.commits since there's no "semantic" implication of any specific sorts of changes when just the .commits part changes 🙂

lread14:03:44

Oh absolutely not @U04V70XH6, 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.

😊 3