cljdoc

https://cljdoc.org/ & https://github.com/cljdoc/cljdoc
seancorfield 2021-02-14T06:15:13.025800Z

OK, this is a new one for me:

exception-during-import

java.lang.Exception: Could not read contents of doc/difference-from-1-x.md
 at cljdoc.doc_tree$process_toc_entry$slurp_BANG___24864.invoke (doc_tree.clj:95)
    cljdoc.doc_tree$process_toc_entry.invokeStatic (doc_tree.clj:102)
    cljdoc.doc_tree$process_toc_entry.invoke (doc_tree.clj:86)
    clojure.core$partial$fn__5839.invoke (core.clj:2624)
    clojure.core$mapv$fn__8445.invoke (core.clj:6912)
    clojure.lang.PersistentVector.reduce (PersistentVector.java:343)
    clojure.core$reduce.invokeStatic (core.clj:6827)
    clojure.core$mapv.invokeStatic (core.clj:6903)
    clojure.core$mapv.invoke (core.clj:6903)
    cljdoc.doc_tree$process_toc.invokeStatic (doc_tree.clj:137)
    cljdoc.doc_tree$process_toc.invoke (doc_tree.clj:127)
    cljdoc.analysis.git$analyze_git_repo$fn__26198.invoke (git.clj:83)
    cljdoc.analysis.git$analyze_git_repo.invokeStatic (git.clj:55)
    cljdoc.analysis.git$analyze_git_repo.invoke (git.clj:43)
    cljdoc.server.ingest$ingest_git_BANG_.invokeStatic (ingest.clj:43)
    cljdoc.server.ingest$ingest_git_BANG_.invoke (ingest.clj:38)
    cljdoc.server.api$kick_off_build_BANG_$fn__27955.invoke (api.clj:69)
This is https://cljdoc.org/builds/40328 (from the v2 branch of seancorfield/honeysql -- what did I do wrong?)

seancorfield 2021-02-14T18:28:12.026500Z

@martinklepsch Here's the pom.xml on the v2 branch: https://github.com/seancorfield/honeysql/blob/v2/pom.xml#L24-L29

seancorfield 2021-02-14T18:32:06.026800Z

And I confirmed that pom.xml file is present in the JAR (and has the same contents). Here's the tree at the tag https://github.com/seancorfield/honeysql/tree/v2.0.0-alpha1 and that all seems consistent.

seancorfield 2021-02-14T18:42:12.027300Z

Fixed that and then moved the tag and kicking off a rebuild on cljdoc -- and now I have docs! https://cljdoc.org/d/seancorfield/honeysql/2.0.0-alpha1/doc/readme

martinklepsch 2021-02-14T20:47:10.027700Z

adding this to CI might help detecting this kind of issue: curl -fsSL <https://raw.githubusercontent.com/cljdoc/cljdoc/master/script/verify-cljdoc-edn> | bash -s doc/cljdoc.edn

seancorfield 2021-02-14T20:49:11.027900Z

Oh, nice!

martinklepsch 2021-02-14T07:55:26.026Z

Hey Sean! My quick guess is that the POM doesn’t have and scm.tag property and the build falls back to master where the file is probably not present. See this for some additional information on how to expose the SHA through POM https://github.com/cljdoc/cljdoc/blob/master/doc/userguide/faq.md#how-do-i-set-scm-info-for-my-project

martinklepsch 2021-02-14T07:59:56.026300Z

Also if anyone happens to know I’d like to extend the docs to include some guidance around deps.edn but AFAIK there’s no standard approach for creating POM files that would allow this?