Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Cljdocs build fails when attempting to import Git #236

Open
alysbrooks opened this issue Nov 15, 2022 · 2 comments · May be fixed by #246
Open

Cljdocs build fails when attempting to import Git #236

alysbrooks opened this issue Nov 15, 2022 · 2 comments · May be fixed by #246

Comments

@alysbrooks
Copy link

Looking at docs for the latest version, the Cljdoc build fails: https://cljdoc.org/builds/48006. I'm not seeing a Git repository listed on Clojars either, so I'm assuming it's failing to be added to your pom.xml for some reason.

@lread
Copy link

lread commented Jun 1, 2023

@zane also noted this on Slack today.

Problem

The pom published to clojars for this version of meander does not point back to meander sources on GitHub.

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  <modelVersion>4.0.0</modelVersion>
  <packaging>jar</packaging>
  <groupId>meander</groupId>
  <artifactId>epsilon</artifactId>
  <version>0.0.650</version>
  <name>epsilon</name>
  <dependencies>
    <dependency>
      <groupId>org.clojure</groupId>
      <artifactId>clojure</artifactId>
      <version>1.10.3</version>
    </dependency>
  </dependencies>
  <build>
    <sourceDirectory>src</sourceDirectory>
  </build>
  <repositories>
    <repository>
      <id>clojars</id>
      <url>https://repo.clojars.org/</url>
    </repository>
  </repositories>
</project>

Cljdoc uses <scm> info in the pom to point back to articles and source code.
Older versions of meander published to clojars do have some info so, the build process probably changed.
And meander does have a doc/cljdoc.edn to there has been historical interest in cljdoc.

The Fix

The meander build/release process needs to populate <scm> info in the pom. This will fix:

  • articles
  • links from API back to sources

I notice that meander is using tools.build.
There's more than one way to do this, but what I typically do is keep an anemic pom.xml and fill in any missing blanks with build.clj. Example from rewrite-clj: pom.xml, and build.clj.

@lread
Copy link

lread commented Jun 1, 2023

Related: I noticed you are no longer version tagging on release. Could be interesting to add this back in at the same time. This way the <scm> <tag> could specify your git version tag. But you can also use a git sha for <scm> <tag> if you wish.

jlesquembre added a commit to jlesquembre/meander that referenced this issue Sep 8, 2023
@jlesquembre jlesquembre linked a pull request Sep 8, 2023 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants