[sling-whiteboard] branch feature/SLING-8311 updated: SLING-8311 - Investigate creating a Sling CLI tool for development task automation

[ro...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

rombert pushed a commit to branch feature/SLING-8311
in repository https://gitbox.apache.org/repos/asf/sling-whiteboard.git


The following commit(s) were added to refs/heads/feature/SLING-8311 by this push:
     new 733afde  SLING-8311 - Investigate creating a Sling CLI tool for development task automation
733afde is described below

commit 733afdedd3eb13c82e7b242a5175b0285911a65e
Author: Robert Munteanu <ro...@apache.org>
AuthorDate: Fri Mar 8 14:06:42 2019 +0200

    SLING-8311 - Investigate creating a Sling CLI tool for development task automation
    
    Document assumptions.
---
 cli/README.md | 11 ++++++++++-
 1 file changed, 10 insertions(+), 1 deletion(-)

diff --git a/cli/README.md b/cli/README.md
index eaa6d43..af04f3f 100644
--- a/cli/README.md
+++ b/cli/README.md
@@ -20,4 +20,13 @@ This invocation produces a list of available subcommands.
 
 Currently the only implemented command is generating the release vote email, for instance
 
-    docker run --env-file=./docker-env apache/sling-cli release prepare-email $STAGING_REPOSITORY_ID
\ No newline at end of file
+    docker run --env-file=./docker-env apache/sling-cli release prepare-email $STAGING_REPOSITORY_ID
+    
+## Assumptions
+
+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.  
\ No newline at end of file