Liking cljdoc? Tell your friends :D
Clojure only.

tools-pom.tasks

Clojure tools.deps tasks related to comprehensive pom.xml files.

All of the build tasks return the opts hash map they were passed (unlike some of the functions in clojure.tools.build.api).

Clojure tools.deps tasks related to comprehensive pom.xml files.

All of the build tasks return the opts hash map they were passed
(unlike some of the functions in clojure.tools.build.api).
raw docstring

pomclj

(pom opts)

Writes out a pom file. opts includes:

:lib -- opt: a symbol identifying your project e.g. 'com.github.yourusername/yourproject :version -- opt: a string containing the version of your project e.g. "1.0.0-SNAPSHOT" :pom-file -- opt: the name of the file to write to (defaults to "./pom.xml") :write-pom -- opt: a flag indicating whether to invoke "clojure -Spom" after generating the basic pom (i.e. adding dependencies and repositories from your deps.edn file) (defaults to false) :validate-pom -- opt: a flag indicating whether to validate the generated pom.xml file after it's been constructed (defaults to false) :pom -- opt: a map containing any other POM elements (see https://maven.apache.org/pom.html for details), using standard Clojure :keyword keys

Here is an example :pom map that will generate a valid pom.xml:

:pom {:description "Description of your project e.g. your project's short description on GitHub." :url "https://github.com/yourusername/yourproject" :licenses [:license {:name "Apache License 2.0" :url "http://www.apache.org/licenses/LICENSE-2.0.html"}] ; Note first element is a tag :developers [:developer {:id "yourusername" :name "yourname" :email "youremail@emailservice.com"}] ; And here :scm {:url "https://github.com/yourusername/yourproject" :connection "scm:git:git://github.com/yourusername/yourproject.git" :developer-connection "scm:git:ssh://git@github.com/yourusername/yourproject.git"} :issue-management {:system "github" :url "https://github.com/yourusername/yourproject/issues"}}))

Writes out a pom file. opts includes:

:lib          -- opt: a symbol identifying your project e.g. 'com.github.yourusername/yourproject
:version      -- opt: a string containing the version of your project e.g. "1.0.0-SNAPSHOT"
:pom-file     -- opt: the name of the file to write to (defaults to "./pom.xml")
:write-pom    -- opt: a flag indicating whether to invoke "clojure -Spom" after generating the basic pom (i.e. adding dependencies and repositories from your deps.edn file) (defaults to false)
:validate-pom -- opt: a flag indicating whether to validate the generated pom.xml file after it's been constructed (defaults to false)
:pom          -- opt: a map containing any other POM elements (see https://maven.apache.org/pom.html for details), using standard Clojure :keyword keys

Here is an example :pom map that will generate a valid pom.xml:

:pom {:description      "Description of your project e.g. your project's short description on GitHub."
      :url              "https://github.com/yourusername/yourproject"
      :licenses         [:license   {:name "Apache License 2.0" :url "http://www.apache.org/licenses/LICENSE-2.0.html"}] ; Note first element is a tag
      :developers       [:developer {:id "yourusername" :name "yourname" :email "youremail@emailservice.com"}]         ; And here
      :scm              {:url                  "https://github.com/yourusername/yourproject"
                         :connection           "scm:git:git://github.com/yourusername/yourproject.git"
                         :developer-connection "scm:git:ssh://git@github.com/yourusername/yourproject.git"}
      :issue-management {:system "github" :url "https://github.com/yourusername/yourproject/issues"}}))
sourceraw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close