README: syntax, cleanup, fix path, prepare v0.5.0

fixes #3
This commit is contained in:
Thomas Gelf 2019-03-26 01:31:30 +01:00
parent b8e9f8962b
commit 3080cb4156
2 changed files with 20 additions and 18 deletions

View File

@ -5,34 +5,36 @@ This repository is an attempt to ship 3rd party libraries that might be useful
for asynchronous PHP-based Icinga Web 2 modules. Please download the latest for asynchronous PHP-based Icinga Web 2 modules. Please download the latest
release and install it like any other module. release and install it like any other module.
> **HINT**: Do NOT install the GIT master, it will not work! > **HINT**: Do NOT install the GIT master, it will not work! Checking out a
> branch like `stable/0.5.0` or a tag like `v0.5.0` is fine.
Sample Tarball installation Sample Tarball installation
--------------------------- ---------------------------
```sh ```sh
RELEASES="https://github.com/Icinga/icingaweb2-module-reactbundle/archive" \ MODULE_NAME=reactbundle
&& MODULES_PATH="/usr/share/icingaweb2/modules" \ MODULE_VERSION=v0.5.0
&& MODULE_VERSION=0.4.1 \ MODULES_PATH="/usr/share/icingaweb2/modules"
&& mkdir "$MODULES_PATH" \ MODULE_PATH="${MODULES_PATH}/${MODULE_PATH}"
&& wget -q $RELEASES/v${MODULE_VERSION}.tar.gz -O - \ RELEASES="https://github.com/Icinga/icingaweb2-module-${MODULE_NAME}/archive"
| tar xfz - -C "$MODULES_PATH" --strip-components 1 mkdir "$MODULE_PATH" \
icingacli module enable reactbundle && wget -q $RELEASES/${MODULE_VERSION}.tar.gz -O - \
| tar xfz - -C "$MODULE_PATH" --strip-components 1
icingacli module enable "${MODULE_NAME}"
``` ```
Sample GIT installation Sample GIT installation
----------------------- -----------------------
```sh ```sh
REPO="https://github.com/Icinga/icingaweb2-module-reactbundle" \ MODULE_NAME=reactbundle
&& MODULES_PATH="/usr/share/icingaweb2/modules" \ MODULE_VERSION=v0.5.0
&& MODULE_VERSION=0.4.1 \ REPO="https://github.com/Icinga/icingaweb2-module-${MODULE_NAME}"
&& mkdir -p "$MODULES_PATH" \ MODULES_PATH="/usr/share/icingaweb2/modules"
&& git clone ${REPO} "${MODULES_PATH}/reactbundle" --branch v${MODULE_VERSION} git clone ${REPO} "${MODULES_PATH}/${MODULE_NAME}" --branch "${MODULE_VERSION}"
icingacli module enable reactbundle icingacli module enable "${MODULE_NAME}"
``` ```
Developer Documentation Developer Documentation
----------------------- -----------------------
@ -46,4 +48,4 @@ Developer Documentation
e.g. e.g.
./bin/make-release.sh 0.1.0 ./bin/make-release.sh 0.5.0

View File

@ -2,7 +2,7 @@
VERSION="$1" VERSION="$1"
if [ -z $VERSION ]; then if [[ -z $VERSION ]]; then
echo "USAGE: $0 <version>" echo "USAGE: $0 <version>"
echo " e.g.: $0 0.1.0" echo " e.g.: $0 0.1.0"
exit 1 exit 1
@ -10,7 +10,7 @@ fi
TAG=$(git tag | grep -c "$VERSION") TAG=$(git tag | grep -c "$VERSION")
if [ "$TAG" -ne "0" ]; then if [[ "$TAG" -ne "0" ]]; then
echo -n "Version $VERSION has already been tagged: " echo -n "Version $VERSION has already been tagged: "
git tag | grep "$VERSION" git tag | grep "$VERSION"
exit 1 exit 1