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

Update clojars and leiningen deploy documentation #792

Closed
8 tasks done
tobias opened this issue Feb 24, 2021 · 10 comments
Closed
8 tasks done

Update clojars and leiningen deploy documentation #792

tobias opened this issue Feb 24, 2021 · 10 comments

Comments

@seancorfield
Copy link
Contributor

Can we get Clojure CLI documentation this time around too?

If a project is created with clj-new, it will have depstar-based JAR creation and deps-deploy-based Clojars deployment built-in.

By the time this update goes into place, clj-new will default to behavior that is compatible with the new Clojars policy and depstar will also reference the new policy.

  • Creating a new project as username/project will assume https://github.com/username/project and a group/artifact of org.clojars.username/project and a main namespace of username.project.
  • Creating a new project as com.github.username/project will assume https://github.com/username/project and a group/artifact of com.github.username/project and a main namespace of username.project.
  • Similarly for io.github.username/project, com.gitlab.username/project, and io.gitlab.username/project.
  • In addition com.acme/project will assume https://github.com/com.acme/project (and will likely need adjusting) and a group/artifact of com.acme/project and a main namespace of com.acme.project.

(this is still subject to feedback from the community once a public announcement has been made about the clojars.org policy)

@tobias
Copy link
Member Author

tobias commented Mar 2, 2021

We certainly can @seancorfield! We just haven't had it yet because no one has added it to the wiki page, and I've never deployed an artifact via Clojure CLI. I'll make sure we include it when I make updates.

@tobias
Copy link
Member Author

tobias commented Apr 11, 2021

Lein doc updates are in technomancy/leiningen#2735.

@seancorfield
Copy link
Contributor

Cool. I'll try to draft up a page in the Clojars' wiki for CLI/deps.edn projects and deployment this week.

@tobias
Copy link
Member Author

tobias commented Apr 11, 2021

Thanks @seancorfield! I added https://github.com/clojars/clojars-web/wiki/Pushing#clojure-cli, but there isn't much there. I was planning on pinging you about it since I haven't deployed with the CLI. Feel free to create a new page and link from wherever is appropriate.

@seancorfield
Copy link
Contributor

Yeah, there are potentially a lot of options. clojure -Spom can create a minimal pom.xml file but you need to edit it to fix the group/artifact at minimum and if you want your library to be compatible with cljdoc.org you need to add a lot more to it. clj-new generates library projects with a fully-fleshed pom.xml (which you can still edit, of course). depstar can update the group/artifact/version fields in pom.xml or can just ignore it. Other JAR builders have other approaches. The depstar README shows a mvn command for deployment but also recommends deps-deploy (but of course there are other options for that too!).

@seancorfield
Copy link
Contributor

(it may well be the weekend at this point)

@seancorfield
Copy link
Contributor

I created https://github.com/clojars/clojars-web/wiki/Clojure-CLI-deps.edn for you to take a look. I have not yet linked to it from anywhere.

@tobias
Copy link
Member Author

tobias commented Apr 18, 2021

This is great, thanks @seancorfield! I linked to it from the Deploying and Tutorial pages.

@tobias tobias closed this as completed Apr 18, 2021
@tobias
Copy link
Member Author

tobias commented Apr 18, 2021

I also added it to the wiki sidebar.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants