diff --git a/.githooks/pre-commit b/.githooks/pre-commit new file mode 100755 index 0000000..4c8bebc --- /dev/null +++ b/.githooks/pre-commit @@ -0,0 +1,57 @@ +#!/bin/sh +# +# An example hook script to verify what is about to be committed. +# Called by "git commit" with no arguments. The hook should +# exit with non-zero status after issuing an appropriate message if +# it wants to stop the commit. +# +# To enable this hook, rename this file to "pre-commit". + +if git rev-parse --verify HEAD >/dev/null 2>&1 +then + against=HEAD +else + # Initial commit: diff against an empty tree object + against=$(git hash-object -t tree /dev/null) +fi + +# If you want to allow non-ASCII filenames set this variable to true. +allownonascii=$(git config --type=bool hooks.allownonascii) + +# Redirect output to stderr. +exec 1>&2 + +# Cross platform projects tend to avoid non-ASCII filenames; prevent +# them from being added to the repository. We exploit the fact that the +# printable range starts at the space character and ends with tilde. +if [ "$allownonascii" != "true" ] && + # Note that the use of brackets around a tr range is ok here, (it's + # even required, for portability to Solaris 10's /usr/bin/tr), since + # the square bracket bytes happen to fall in the designated range. + test $(git diff --cached --name-only --diff-filter=A -z $against | + LC_ALL=C tr -d '[ -~]\0' | wc -c) != 0 +then + cat <<\EOF +Error: Attempt to add a non-ASCII file name. + +This can cause problems if you want to work with people on other platforms. + +To be portable it is advisable to rename the file. + +If you know what you are doing you can disable this check using: + + git config hooks.allownonascii true +EOF + exit 1 +fi + +# Check if config.yaml has been modified and add a message +git diff --cached --name-only | if grep -q "conf/config.yaml" +then + cat <<\EOF +It seems that you have modified the config.yaml file, consider checking 'SPECIFIC UPDATE STEPS' section of .github/workflows/updater.sh and update there as well if needed" +EOF +fi + +# If there are whitespace errors, print the offending file names and fail. +exec git diff-index --check --cached $against -- diff --git a/.github/workflows/updater.sh b/.github/workflows/updater.sh index ace22df..6b66e32 100755 --- a/.github/workflows/updater.sh +++ b/.github/workflows/updater.sh @@ -19,6 +19,7 @@ repo=$(cat manifest.json | jq -j '.upstream.code|split("https://github.com/")[1] # Some jq magic is needed, because the latest upstream release is not always the latest version (e.g. security patches for older versions) version=$(curl --silent "https://api.github.com/repos/$repo/releases" | jq -r '.[] | select( .prerelease != true ) | .tag_name' | sort -V | tail -1) assets=($(curl --silent "https://api.github.com/repos/$repo/releases" | jq -r '[ .[] | select(.tag_name=="'$version'").assets[].browser_download_url ] | join(" ") | @sh' | tr -d "'")) +tarball=$(curl --silent "https://api.github.com/repos/$repo/releases" | jq -r '[ .[] | select(.tag_name=="'$version'").tarball_url ] | join(" ") | @sh' | tr -d "'") # Later down the script, we assume the version has only digits and dots # Sometimes the release name starts with a "v", so let's filter it out. @@ -86,11 +87,9 @@ tempdir="$(mktemp -d)" # Download sources and calculate checksum filename=${asset_url##*/} curl --silent -4 -L $asset_url -o "$tempdir/$filename" +curl --silent -4 -L $tarball -o "$tempdir/$version" checksum=$(sha256sum "$tempdir/$filename" | head -c 64) -# Delete temporary directory -rm -rf $tempdir - # Rewrite source file cat < conf/$src.src SOURCE_URL=$asset_url @@ -115,6 +114,47 @@ done # Any action on the app's source code can be done. # The GitHub Action workflow takes care of committing all changes after this script ends. +echo "Update latest version of conf/config.yaml" +# Update the config.yaml with the latest version of it and add vars that will be replaced +configFilePath="conf/config-new.yaml" +newConfigFilePath=$(tar -tf "$tempdir/$version" | grep 'example-config.yaml') +tar -xf "$tempdir/$version" --directory "$tempdir" "$newConfigFilePath" +mv "$tempdir/$newConfigFilePath" "$configFilePath" + +# Replace default values with vars that will be replaced on the install script +yq -i '.homeserver.address = "https://__DOMAIN__"' $configFilePath +yq -i '.homeserver.domain = "__SERVER_NAME__"' $configFilePath +yq -i '.homeserver.async_media = "__ASYNC_MEDIA__"' $configFilePath +yq -i '.appservice.address = "http://localhost:__PORT__"' $configFilePath +yq -i '.appservice.port = "__PORT__"' $configFilePath +yq -i '.appservice.database.uri = "postgres://__APP__:__DB_PWD__@localhost:5432/__DB_NAME__"' $configFilePath +yq -i '.appservice.id = "__APPSERVICEID__"' $configFilePath +yq -i '.appservice.bot.username = "__BOTNAME__"' $configFilePath +yq -i '.appservice.bot.displayname = "__DISPLAYNAME__"' $configFilePath +yq -i '.appservice.bot.avatar = "__AVATAR__"' $configFilePath +yq -i '.appservice.ephemeral_events = "__EPHEMERAL_EVENTS__"' $configFilePath +yq -i '.metrics.enabled = "__ENABLE_METRICS__"' $configFilePath +yq -i '.metrics.listen = "__LISTEN_PORT__"' $configFilePath +yq -i '.whatsapp.os_name = "__OS_NAME__"' $configFilePath +yq -i '.whatsapp.browser_name = "__BROWSER_NAME__"' $configFilePath +yq -i '.bridge.username_template = "__USERNAME_TEMPLATE__"' $configFilePath +yq -i '.bridge.personal_filtering_spaces = "__PERSONAL_FILTERING_SPACES__"' $configFilePath +yq -i '.bridge.delivery_receipts = "__DELIVERY_RECEIPTS__"' $configFilePath +yq -i '.bridge.send_presence_on_typing = "__SEND_PRESENCE_ON_TYPING__"' $configFilePath +yq -i '.bridge.url_previews = "__URL_PREVIEWS__"' $configFilePath +yq -i '.bridge.encryption.allow = "__ENCRYPTION__"' $configFilePath +yq -i '.bridge.encryption.default = "__ENCRYPTION_DEFAULT__"' $configFilePath +yq -i '.bridge.encryption.require = "__ENCRYPTION_REQUIRE__"' $configFilePath +yq -i 'with(.bridge.permissions ; . = { "__LISTRELAY__": "relay", "__LISTUSER__": "user", "__LISTADMIN__": "admin" } | ... style="double")' $configFilePath +yq -i '.bridge.relay.enabled = "__ENABLE_RELAYBOT__"' $configFilePath +yq -i '.bridge.relay.admin_only = "__ADMIN_ONLY__"' $configFilePath +yq -i '.logging.directory = "/var/log/__APP__"' $configFilePath +yq -i '.logging.print_level = "__PRINT_LEVEL__"' $configFilePath + +## Keep some default options turned off +yq -i '.logging.file_name_format = "null"' $configFilePath + + #================================================= # GENERIC FINALIZATION #================================================= @@ -122,6 +162,9 @@ done # Replace new version in manifest echo "$(jq -s --indent 4 ".[] | .version = \"$version~ynh1\"" manifest.json)" > manifest.json +# Delete temporary directory +rm -rf $tempdir + # No need to update the README, yunohost-bot takes care of it # The Action will proceed only if the PROCEED environment variable is set to true diff --git a/doc/DISCLAIMER.md b/doc/DISCLAIMER.md index 735b94b..aed5895 100644 --- a/doc/DISCLAIMER.md +++ b/doc/DISCLAIMER.md @@ -92,3 +92,12 @@ In case you need to upload your logs somewhere, be aware that they contain your ``| sed -r 's/[0-9]{10,}/📞/g' `` * "Mautrix-WhatsApp" bridge is based on the [Rhymen/go-whatsapp](https://github.com/Rhymen/go-whatsapp) implementation of the [sigalor/whatsapp-web-reveng](https://github.com/sigalor/whatsapp-web-reveng) project. +## Development code quality + +The `.github/workflows/updater.sh` script needs to be synced with changes in `conf/config.yaml` therefore a `pre-commit` +hook is used to display a reminder to update `.github/workflows/updater.sh` (if needed) when `conf/config.yaml` has been modified. + +Please enable Git hooks using following command to ensure code quality and stability. +``` bash +git config --local core.hooksPath .githooks +``` \ No newline at end of file diff --git a/doc/DISCLAIMER_fr.md b/doc/DISCLAIMER_fr.md index cd9208c..5c4a5ad 100644 --- a/doc/DISCLAIMER_fr.md +++ b/doc/DISCLAIMER_fr.md @@ -74,3 +74,14 @@ update-ca-certificates Si vous devez téléverser vos fichiers log quelque-part, soyez avertis qu'ils contiennent des informations sur vos contacts et vos numéros de téléphone. Effacez-les avec ``| sed -r 's/[0-9]{10,}/📞/g' `` * La passerelle "Mautrix-WhatsApp" repose sur l'implémentation [Rhymen/go-whatsapp](https://github.com/Rhymen/go-whatsapp) du projet [sigalor/whatsapp-web-reveng](https://github.com/sigalor/whatsapp-web-reveng). + +## Development code quality + +Le script `.github/workflows/updater.sh` doit être synchronisé avec les changements dans `conf/config.yaml`, +donc un hook `pre-commit` est utilisé pour afficher un rappel pour mettre à jour +`.github/workflows/updater.sh` (si nécessaire) lorsque `conf/config.yaml` a été modifié. + +Veuillez activer les hooks Git en utilisant la commande suivante pour assurer la qualité et la stabilité du code. +``` bash +git config --local core.hooksPath .githooks +``` \ No newline at end of file