leiningen-semantic-release
semantic-release plugin to publish a leiningen project.
| Step | Description |
|---|---|
verifyConditions |
Checks the project.clj is syntactically valid. |
prepare |
Update the project.clj version and package the output jar file. |
publish |
Publish the jar (and generated Maven metadata) to a maven repository (or clojars). |
Install
$ npm install leiningen-semantic-release -DUsage
The plugin can be configured in the semantic-release configuration file:
Configuration
Registry authentication
Authenticating with the registry is configured using the :deploy-repositories map in project.clj.
The recommended way to pass these variables in is by using environment variables.
Environment variables
| Variable | Description |
|---|---|
LEIN_USERNAME |
The username for the maven repository you are publishing to (or clojars). |
LEIN_PASSWORD |
The password for the maven repository you are publishing to (or clojars). |
LEIN_PASSPHRASE |
A gpg passphrase to retreive the username and password with. (if retreiving credentials from gpg) |
As mentioned in the leiningen documentation,
your :deploy-repositories section of project.clj should be set up to use environment variables.
For example to use LEIN_USERNAME and LEIN_PASSWORD your config might look like this.
:deploy-repositories [["releases" {:url "https://oss.sonatype.org/service/local/staging/deploy/maven2/"
:username :env
:password :env}
"snapshots" {:url "https://oss.sonatype.org/content/repositories/snapshots/"
:username :env
:password :env}]]
If you want retrieve the username and password from gpg, you can set the LEIN_PASSPHRASE environment variable
and use config like the following.
:deploy-repositories [["releases" {:url "https://oss.sonatype.org/service/local/staging/deploy/maven2/"
:creds :gpg
:passphrase :env}
"snapshots" {:url "https://oss.sonatype.org/content/repositories/snapshots/"
:creds :gpg
:passphrase :env}]]
The example project shows an example of how to get signing working properly using environment variables on CircleCI.
It techniques used there should apply to most build environments running on Linux.
Options
| Options | Description | Default |
|---|---|---|
skipDeploy |
Whether to publish the package to a respository with lein deploy. If true the project.clj version will still be updated. |
true |
pkgRoot |
Directory path to publish. | . |
uberJar |
Whether to package the project as an uber jar (include dependencies in the jar) | false |
Note: The pkgRoot directory must contains a project.clj. The version will be updated only in the project.clj within the pkgRoot directory.
Note: If you use a shareable configuration that defines one of these options you can set it to false in your semantic-release configuration in order to use the default value.
Example
There is an example project at: https://github.com/NoxHarmonium/leiningen-semantic-release-test-clojars