Parent Project for Nuvla Clojure(Script) Modules

A parent project.clj file to centrally manage repositories and dependencies for Nuvla Clojure(Script) modules.

Artifacts

• sixsq.nuvla/parent jar file: Jar file containing common dependencies for Clojure(Script) components. Available from clojars.

Release Process

Setup

To build and release this project.clj file to clojars, you must setup your environment correctly.

First, set the username and password of your clojars account as environmental variables:

export CLOJARS_USERNAME=username
export CLOJARS_PASSWORD=password

These will be used when pushing the artifacts to clojars. For the SixSq release account, the username and password are in 1Password.

Non-snapshot releases of artifacts also must be signed with a GPG key when uploading to clojars. You must install GPG and then import the SixSq Release GPG keys. The public key, private key, and password are all in 1Password.

For GPG, set the environmental variable:

export GPG_TTY=$(tty)

This should then allow GPG to prompt for the password for the private key. If you run into an error like the following:

gpg: signing failed: Inappropriate ioctl for device

The problem is with the TTY that GPG is trying to use and usually means that the above environmental variable is not set.

Publishing to Clojars

Before creating the release:

• Be sure that you've done all of the setup in the previous section!

• Decide what semantic version to use for this release and change the version in project.clj. (It should still have the "-SNAPSHOT" suffix.)

• Update the changelog.

In general, use the following guidelines when choosing how to change the version:

• :patch for changes that are strictly backwards-compatible, e.g. adding new dependencies
• :minor for changes that change the versions of existing dependencies or delete dependencies
• :major for major changes such as changing repository definitions

Again, be sure to set the version before tagging the release.

To tag the code and release the jar to clojars, just run the command:

lein release :patch

This will do everything necessary and will bump the patch version of the artifact at the end of the process. You will be prompted for the passphrase of the GPG key.

After releasing a new version on clojars, you should check that the jar is available from clojars and then communicate the availability of the new release to the coordinators of dependent components.

Contributing

Before adding new dependencies or removing existing ones, discuss with other developers, especially from those that depend on this project.clj file. Generally try to minimize the number of dependencies and choose a single library for a given functionality.

When updating versions, use your best judgement on whether the change is likely to cause an issue with other components. If there is a doubt, then discuss the changes. In any case, test changes with other components when possible.

Please keep the dependencies in the project.clj file alphabetized. Ensure that the file uses the standard clojure formatting (with aligned maps) provided by the IntelliJ Cursive plugin.

Copyright

Copyright © 2019, SixSq Sàrl

License

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.