Skip to content

Instantly share code, notes, and snippets.

@adiii717
Last active August 29, 2023 07:13
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save adiii717/a5428c0f91cb56521d7d5f2f834c7309 to your computer and use it in GitHub Desktop.
Save adiii717/a5428c0f91cb56521d7d5f2f834c7309 to your computer and use it in GitHub Desktop.
convert rover json to mark down
#!/bin/bash
function generate_markdown (){
COMMAND="${1}"
CHECK_OUTPUT=$($COMMAND)
CHECK_SUCCESS=$(echo $CHECK_OUTPUT | jq '.data.success')
echo "" > readme.md
if [ $CHECK_SUCCESS = "true" ]; then
echo "### Check Success" > readme.md
echo " ✅ " >> readme.md
echo "#### Change Details" >> readme.md
echo "" >> readme.md
fi
CHANGES=$(echo "${CHECK_OUTPUT}" | jq '.data.changes')
if [ "$CHANGES" != "null" ]; then
CHANGE_SIZE=$(echo "${CHECK_OUTPUT}" | jq -r '.data.changes | length')
if [ "$CHANGE_SIZE" = "0" ]; then
echo " ✅ " >> readme.md
echo "No changes" >> readme.md
fi
if [ "$CHANGE_SIZE" != "0" ]; then
echo "| Severity | Code | Description |" >> readme.md
echo "| -------- | ---- | ----------- |" >> readme.md
jq -c '.[]' <<< $CHANGES | while read change; do
CHANGE_SEVERITY=$(echo "$change" | jq -r '.severity')
CHANGE_DESCRIPTION=$(echo "$change" | jq -r '.description')
CHANGE_CODE=$(echo "$change" |jq -r '.code')
echo "| $CHANGE_SEVERITY | $CHANGE_CODE | $CHANGE_DESCRIPTION |" >> readme.md
done
fi
echo "" >> readme.md
fi
if [ $CHECK_SUCCESS = "false" ]; then
echo "### Check Failure" >> readme.md
echo $CHECK_OUTPUT | jq -r '.error.message' >> readme.md
echo "" >> readme.md
echo "### Status: ❌" >> readme.md
StatusCode=$(jq -r '.error.code' <<< "$CHECK_OUTPUT" )
ErrorMessage=$(jq -r '.error.message' <<< "$CHECK_OUTPUT" )
BuildErrorMessage=$(jq -r '.error.details.build_errors' <<< "$CHECK_OUTPUT" )
OperationChanges=$(jq -r '.data.tasks.operations.changes' <<< "$CHECK_OUTPUT")
.error.details.build_errors
if [[ $StatusCode != "null" ]]; then
echo "StatusCode: $StatusCode" >> readme.md
else
echo -n "StatusCode: UNKNOWN"
fi
echo "Error Message: $ErrorMessage" >> readme.md
if [ "$BuildErrorMessage" != "null" ]; then
echo "### Build Error Message:" >> readme.md
echo '```json' >> readme.md
echo "$BuildErrorMessage" >> readme.md
echo '```' >> readme.md
fi
if [ "$OperationChanges" != "null" ]; then
echo "### Operation Changes:" >> readme.md
echo '```json' >> readme.md
echo "$OperationChanges" >> readme.md
echo '```' >> readme.md
fi
fi
CHECK_URL=$(echo $CHECK_OUTPUT | jq -r '.data.target_url')
if [ $CHECK_URL != null ]; then
echo "" >> readme.md
echo "See more details in [Apollo Studio]($CHECK_URL)" >> readme.md
fi
echo "" >> readme.md
cat readme.md
}
if [ -z "$1" ]; then
echo "command required"
echo "./rover_check_markdown.sh \"rover subgraph check demo@develop -s demo.gql --name demo --output json\""
else
echo "$(generate_markdown "${1}")"
fi
@adiii717
Copy link
Author

if you need this in the GitLab MR as a comment, the GitLab MR pipeline has some default env so we will use that env to comment in the relevant MR, You just need to change the params "rover subgraph check demo@develop -s apollo-check.gql --name demo --output json"

  script:
    - export RESULT=$(curl -s https://gist.githubusercontent.com/adiii717/a5428c0f91cb56521d7d5f2f834c7309/raw/77ab4077617f252ba1a675e77fb67cd284655d93/rover_check_markdown.sh | bash -s -- "rover subgraph check demo@develop -s apollo-check.gql --name demo --output json")
    - echo "${RESULT}" > result.md && export MD_RESULT=$(awk 'ORS="\n\n"' result.md)
    - curl --request POST --header "Content-Type:multipart/form-data" --header "PRIVATE-TOKEN:${GITLAB_TOKEN}" "https://gitlab.com/api/v4/projects/${CI_MERGE_REQUEST_PROJECT_ID}/merge_requests/${CI_MERGE_REQUEST_IID}/notes?body"  -d  "body=$MD_RESULT"
  rules:
    - if: '$CI_PIPELINE_SOURCE == "merge_request_event"'

image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment