Add Periphery errors as Buildkite annotation

Author: AliSoftware

.buildkite/commands/run-periphery.sh

@@ -12,10 +12,14 @@ tar -xf build-products.tar
 
 ### Run the Tests
 
+PERIPHERY_OUTPUT_FILE="periphery-errors.txt"
+
 echo '+++ :periphery: Detecting unused code'
 set +e
 # This is the script in the root.
-./Scripts/Periphery/setup-and-run-periphery.sh --strict --quiet --skip-build --index-store-path 'DerivedData/Index.noindex/DataStore/'
+./Scripts/Periphery/setup-and-run-periphery.sh \
+  --strict --quiet --skip-build --index-store-path 'DerivedData/Index.noindex/DataStore/' \
+  --write-results "$PERIPHERY_OUTPUT_FILE"
 TESTS_EXIT_STATUS=$?
 set -e
 
@@ -28,8 +32,11 @@ if [[ "$TESTS_EXIT_STATUS" -ne 0 ]]; then
   echo 'If you think there is a false positive violation, please check the known issues of Periphery at https://github.com/peripheryapp/periphery/issues.'
   echo 'If you think a violation is valid but it should be surpressed for any reason, please apply the `// periphery: ignore - {your-reason-here}` comment.'
   echo ''
+  # Add the periphery errors as a Buildkite annotation
+  echo "## Periphery found unused code\n\n\`\`\`\n$(cat "$PERIPHERY_OUTPUT_FILE")\n\`\`\`" | buildkite-agent annotate --context periphery --style error
 else
   echo '😊 No unused code found.'
+  buildkite-agent annotate --context periphery --style success --append 'No unused code found by Periphery :tada:'
 fi
 
 echo '--- 🚦 Report Exit code'