Apache Sling Commiter CLI

Clone this repo:
  1. 6c20c44 SLING-12150 - Update to parent pom 52 (#25) by Robert Munteanu · 6 months ago master
  2. cb4348f SLING-12148 - Fixing CI Validation Failure (#26) by Dan Klco · 6 months ago
  3. 8bb5533 chore: fix javadoc by Robert Munteanu · 7 months ago
  4. bd12f44 SLING-12140 - Creating new jira version fails: No releases found in 'Parent 60 (Java 11)' by Robert Munteanu · 7 months ago
  5. 0af6d82 SLING-12146 - Committer CLI build fails on Windows (#24) by Robert Munteanu · 6 months ago

Apache Sling

Build Status Test Status Coverage Sonarcloud Status License

Apache Sling Committer CLI tool

This module is part of the Apache Sling project.

This module provides a command-line tool which automates various Sling development tasks. The tool is packaged as a docker image.


To make various credentials and configurations available to the docker image it is recommended to use a docker env file. A sample file is stored at docker-env.sample. Copy this file to docker-env and fill in your own information.


The image is built using mvn package. Afterwards it may be run with

docker run --env-file=./docker-env apache/sling-cli

This invocation produces a list of available commands.


The commands can be executed in 3 different modes:

  • DRY_RUN (default mode) - commands only list their output without performing any actions on the user's behalf
  • INTERACTIVE - commands list their output but ask for user confirmation when it comes to performing an action on the user's behalf
  • AUTO - commands list their output and assume that all questions are provided the default answers when it comes to performing an action on the user's behalf

To select a non-default execution mode provide the mode as an argument to the command:

docker run -it --env-file=./docker-env apache/sling-cli release prepare-email --repository=$STAGING_REPOSITORY 

Note that for running commands in the INTERACTIVE mode you need to run the Docker container in interactive mode with a pseudo-tty attached (e.g. docker run -it ...).

Listing active releases

docker run --env-file=./docker-env apache/sling-cli release list

Generating a release vote email

docker run --env-file=./docker-env apache/sling-cli release prepare-email --repository=$STAGING_REPOSITORY_ID

Generating a release vote result email

docker run --env-file=./docker-env apache/sling-cli release tally-votes --repository=$STAGING_REPOSITORY_ID

Generating the website update (only diff for now)

docker run --env-file=docker-env apache/sling-cli release update-local-site --repository=$STAGING_REPOSITORY_ID


This tool assumes that the name of the staging repository matches the one of the version in Jira. For instance, the staging repositories are usually named Apache Sling Foo 1.2.0. It is then expected that the Jira version is named Foo 1.2.0. Otherwise the link between the staging repository and the Jira release can not be found.

It is allowed for staging repository names to have an RC suffix, which may include a number, so that RC, RC1, RC25 are all valid suffixes.