juxt.pro - Deploying libraries with deps.edn

JUXT: Blog: Deploying libraries with deps.edn

Juxt.pro Spined HTML

JUXT: Blog: Deploying libraries with deps.edn ☰ Services Home Delivery Training Compliance Resources Blog Why JUXT? Why Clojure? Clojure In Tech Radar Library Tech crux whet tick yadaWell-nighAbout Us Clients Team Careers Community Contact By Dominic Monroe Deploying libraries with deps.edn I’ve had a number of questions well-nigh uploading libraries to maven and clojars with pack. This is a tutorial on how to go well-nigh that. Generate a pom.xml Generate a pom.xml using clojure -Spom. You must update this file with coordinates and an towardly version. To update your coordinates in the pom.xml, you need to update the existing groupId, artifactId and version tags to match. This example is equivalent to {com.acme/anvil {:mvn/version "0.1.0"}} in deps.edn. <groupId>com.acme</groupId> <artifactId>anvil</artifactId> <version>0.1.0</version> You should add repository information. This will enable tools like https://cljdoc.org/ to generate documentation for your library. Put this inside the <project> tags and update the links. Example from cljdoc’s documentation <scm> <connection>scm:git:git://github.com/laforge49/aatree.git</connection> <developerConnection>scm:git:ssh://git@github.com/laforge49/aatree.git</developerConnection> <tag>edb7cefa9a01852b101ed742b278aaba8d832b02</tag> <url>https://github.com/laforge49/aatree</url> </scm> Install the pack plume Run this writ to add the pack plume to your deps.edn. $ clojure -Sdeps '{:deps {pack/pack.alpha {:git/url "https://github.com/juxt/pack.alpha.git" :sha "dccf2134bcf03726a9465d2b9997c42e5cd91bff"}}}' -m mach.pack.alpha.inject 'd9023b24c3d589ba6ebc66c5a25c0826ed28ead5' You may want to retread the formatting afterwards. Build your JAR Pack provides a mode named "skinny jar". This was originally designed for companies who deploy by uploading their classpath separately from their project. But it has a flag to not output the classpath at all, just a jar containing your project files. This separation can be used to create a jar that is suitable for upload to clojars. $ clojure -A:pack \ (1) mach.pack.alpha.skinny \ (2) --no-libs \ (3) --project-path anvil.jar \ (4) 1 Load the pack alias, which will run the selected pack mode 2 Select the skinny mode of pack 3 Don’t output libs 4 Specify the name of your jar. Here, I selected "anvil.jar". Release the JAR You have 2 options at this point, mvn or deps-deploy. mvn has a sometimes largest story virtually encryption of credentials, and is well established. deps-deploy avoids having to install mvn, but is still very new. Jump to deps deploy mvn tideway You will need to set up your ~/.m2/settings.xml in order to add hallmark information for your upload destination. Example settings.xml for Clojars <settings xmlns="http://maven.apache.org/SETTINGS/1.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0 https://maven.apache.org/xsd/settings-1.0.0.xsd"> <servers> <server> <id>clojars</id> <username>wil_e_coyote</username> <password>r04drunn3R$</password> </server> </servers> </settings> The whilom example leaves your password in plaintext on your filesystem. I highly recommend utilising maven’s password encryption. Now you are ready to upload your JAR and pom.xml to upstream using mvn deploy:deploy-file. Upload to clojars $ mvn deploy:deploy-file \ -Dfile=anvil.jar \ (1) -DrepositoryId=clojars \ -Durl=https://clojars.org/repo \ -DpomFile=pom.xml [INFO] Scanning for projects... [INFO] [INFO] ------------------------------------------------------------------------ [INFO] Building anvil 0.1.6 [INFO] ------------------------------------------------------------------------ [INFO] [INFO] --- maven-deploy-plugin:2.7:deploy-file (default-cli) @ anvil --- Uploading: https://clojars.org/repo/com/acme/anvil/0.1.6/anvil-0.1.6.jar Uploaded: https://clojars.org/repo/com/acme/anvil/0.1.6/anvil-0.1.6.jar (780 B at 0.3 KB/sec) Uploading: https://clojars.org/repo/com/acme/anvil/0.1.6/anvil-0.1.6.pom Uploaded: https://clojars.org/repo/com/acme/anvil/0.1.6/anvil-0.1.6.pom (980 B at 0.4 KB/sec) Downloading: https://clojars.org/repo/com/acme/anvil/maven-metadata.xml Downloaded: https://clojars.org/repo/com/acme/anvil/maven-metadata.xml (439 B at 0.8 KB/sec) Uploading: https://clojars.org/repo/com/acme/anvil/maven-metadata.xml Uploaded: https://clojars.org/repo/com/acme/anvil/maven-metadata.xml (470 B at 0.2 KB/sec) [INFO] ------------------------------------------------------------------------ [INFO] BUILD SUCCESS [INFO] ------------------------------------------------------------------------ [INFO] Total time: 8.475 s [INFO] Finished at: 2018-11-18T13:18:06+00:00 [INFO] Final Memory: 12M/317M [INFO] ------------------------------------------------------------------------ 1 Replace this with the name of your jar. Deps Deploy slipset has made a wonderful clojure library named deps-deploy. You can add an plume for it in your deps.edn: {:aliases {:pack {…} :deploy {:extra-deps {deps-deploy {:mvn/version "RELEASE"}} :main-opts ["-m" "deps-deploy.deps-deploy" "deploy" "anvil.jar"]}} Then you can invoke it: $ export HISTFILE=/dev/null (1) $ CLOJARS_USERNAME=wil_e_coyote CLOJARS_PASSWORD='r04drunn3R$' clojure -A:deploy SLF4J: Failed to load matriculation "org.slf4j.impl.StaticLoggerBinder". SLF4J: Defaulting to no-operation (NOP) logger implementation SLF4J: See http://www.slf4j.org/codes.html#StaticLoggerBinder for remoter details. Deploying com.acme/anvil-0.1.4 to clojars as Smeagol done. 1 This is to disable history from storing your username & password in plaintext. Example There’s an example at https://github.com/SevereOverfl0w/super-duper-octo-barnacle. You can update the groupId in the pom.xml and deploy it as a test to your own groupId. Published: 2018-11-27 Sign up to the JUXT newsletter Submit Privacy policy javadoc from the repl How to launch javadoc in your REPL by Malcolm Sparks Published: 2015-10-06 Building a City of London mobile rewards app Delivering rewards to the Cheapside Business District Published: 2018-06-29 Writing a Neural Network A Neural Network writes a Neural Network - Netception by Rickesh Bedia Published: 2017-08-11 Copyright © JUXT LTD 2012-2018 Technology House, 151 Silbury Blvd., Milton Keynes MK9 1LH United Kingdom Company registration: 08457399 Home Software Clojure In Clojure Radar Open Source Software Services TrainingWell-nighUs Team Careers Community Contact In London Library Blog GitHub @juxtpro Login