From b5d190d394cbe2d508685100ffb3c509953ab6e8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Julian=20K=C3=B6nig?= Date: Wed, 3 Jan 2024 09:48:46 +0100 Subject: [PATCH] chore: formatting --- README.md | 18 ++++++++++++------ 1 file changed, 12 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 8ecae55..59af89d 100644 --- a/README.md +++ b/README.md @@ -16,37 +16,43 @@ npm install @js-soft/codemagic-tools ### Teams Messaging #### Build Messages + ```bash jscm teams-develop --platform --projectName ``` + This command will inform about a new build and additionally provide a link to the build. In case of a failed build it will also provide a link to the build log. ### Production Messages + ```bash jscm teams-publish --platform --projectName ``` + This command will inform about a newly released version. It aditionally provides a link to the build logs. ## Testing + For testing a JSON like created in Codemagic is provided. Additionally a bash-script, which can be used to test the command is provided. Upon execution the test script will ask you to specify the following variables: -* webhook - webhook url you want to send to / or just some valid https-address -* BuildId - a string -* ProjectId - a string -* buildNumber - a number +- webhook - webhook url you want to send to / or just some valid https-address +- BuildId - a string +- ProjectId - a string +- buildNumber - a number After preparation of your local environment the script will execute the jscm command. It will execute both possible command: -* teams-develop (in failed/successful state) -* teams-production (in failed/successful state) +- teams-develop (in failed/successful state) +- teams-production (in failed/successful state) → This will result in 4 messages being sent to the specified teams channel ### Calling the test script + ```bash ./test/test_teams_messaging.sh ```