CLOUDP-317123 change markup for code blocks in Atlas CLI generated docs (#4006)

Author: fmenezes

.github/workflows/code-health.yml

@@ -268,8 +268,25 @@ jobs:
         with:
           config: ${{ vars.PERMISSIONS_CONFIG }}
       - uses: actions/checkout@v4
+      - name: Install ShellCheck
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y shellcheck
       - name: Run ShellCheck
-        uses: bewuethr/shellcheck-action@d01912909579c4b1a335828b8fca197fbb8e0aa4
+        run: |
+          # Find all shell scripts excluding specific patterns or directories
+          # Add exclusions by adding more -not -path patterns as needed
+          find . -name "*.sh" \
+            -not -path "./.git/*" \
+            -not -path "./docs/*" \
+            -print0 | xargs -0 shellcheck --format=gcc
+          
+          # Also check for shell scripts without .sh extension
+          find . -type f -exec grep -l '^#!/bin/\(ba\)\?sh' {} \; \
+            | grep -v '\.sh$' \
+            | grep -v './.git/' \
+            | grep -v './docs/' \
+            | xargs -r shellcheck --format=gcc
   tidy:
     runs-on: ubuntu-latest
     steps:

build/ci/check-licenses.sh

@@ -20,6 +20,7 @@ find_files() {
 	find . -not \( \
 		\( \
 		-wholename '*mock*' \
+		-o -wholename '*docs*' \
 		-o -wholename '*third_party*' \
 		\) -prune \
 		\) \

build/ci/copy.bara.sky.template

@@ -23,9 +23,10 @@ core.workflow(
         integrates = [],
     ),
     origin_files = glob(["docs/command/**"], exclude = ["docs/command/atlas-completion**"]),
-    destination_files = glob(["source/includes/command/**"], exclude=["source/includes/command/atlas-kubernetes**"]),
+    destination_files = glob(["source/includes/command/**" ,"source/includes/examples/**"], exclude=["source/includes/command/atlas-kubernetes**"]),
     authoring = authoring.pass_thru(author),
     transformations = [
+        core.move("docs/command/includes", "source/includes/examples"),
         core.move("docs/command", "source/includes/command"),
         core.rename(".txt", ".rst", suffix = True)
     ],
@@ -46,9 +47,10 @@ core.workflow(
         integrates = [],
     ),
     origin_files = glob(["docs/command/**"]),
-    destination_files = glob(["content/atlas-cli/current/source/command/**"], exclude=["content/atlas-cli/current/source/command/atlas-api", "content/atlas-cli/current/source/command/atlas-kubernetes**"]),
+    destination_files = glob(["content/atlas-cli/current/source/command/**", "content/atlas-cli/current/source/includes/examples/**"], exclude=["content/atlas-cli/current/source/command/atlas-api", "content/atlas-cli/current/source/command/atlas-kubernetes**"]),
     authoring = authoring.pass_thru(author),
     transformations = [
+        core.move("docs/command/includes", "content/atlas-cli/current/source/includes/examples"),
         core.move("docs/command", "content/atlas-cli/current/source/command"),
     ],
 )

build/ci/evergreen.yml

@@ -499,9 +499,15 @@ functions:
         shell: bash
         script: |
           set -Eeou pipefail
+          if [[ -z "${triggered_by_git_tag}" ]]; then
+            REF="${github_commit}"
+          else
+            REF="${triggered_by_git_tag}"
+          fi
           cat <<EOF > expansions.yaml
           home: $HOME
           tag: $(git tag --list 'atlascli/v*' --sort=-taggerdate | head -1)
+          ref: $REF
           version: $(git tag --list 'atlascli/v*' --sort=-taggerdate | head -1 | cut -d 'v' -f 2)
           EOF
     - command: expansions.update

build/ci/release.yml

@@ -323,7 +323,7 @@ functions:
         <<: *go_options
         env:
           <<: *go_env
-          TAG: ${tag}
+          TAG: ${ref}
           GH_TOKEN: ${gh_token}
           WORKFLOW: ${workflow}
           EVERGREEN_USER: ${evergreen_user}
@@ -529,7 +529,10 @@ buildvariants:
       - name: package_goreleaser
   - name: copybara
     display_name: "Copybara"
-    git_tag_only: true
+    depends_on:
+      - name: package_goreleaser
+        variant: release_atlascli_github
+        patch_optional: true
     tags:
       - foliage_health
     run_on:

build/ci/run-copybara.sh

@@ -65,17 +65,18 @@ docker run \
     -v "${PWD}/.gitconfig:/root/.gitconfig" \
     -v "${PWD}/.git-credentials:/root/.git-credentials" \
     -e "COPYBARA_WORKFLOW=$WORKFLOW" \
-    -e "COPYBARA_OPTIONS=--github-api-bearer-auth true" \
+    -e "COPYBARA_OPTIONS=--github-api-bearer-auth true --force" \
     google/copybara
 
 PR_URL=$(docker logs copybara-container 2>&1 | grep "/pull/" | sed -E 's/^.*(https\:[^\ ]+).*$/\1/')
 
 rm -rf .git-credentials .gitconfig copy.bara.sky
 docker rm -f copybara-container
 
+echo "Created PR: $PR_URL"
+
 TARGET="$DOCS_SLACK_CHANNEL"
 MSG="Hey team :wave: ${PR_URL} is ready for review :thankyou:"
-echo "{\"target\":\"$TARGET\",\"msg\":\"$MSG\"}"
 curl --header "Api-User:${EVERGREEN_USER:?}" \
     --header "Api-Key:${EVERGREEN_API_KEY:?}" \
     --request POST "https://evergreen.mongodb.com/rest/v2/notifications/slack" \

docs/command/atlas-api-accessTracking-listAccessLogsByClusterName.txt

@@ -120,9 +120,5 @@ Inherited Options
 Examples
 --------
 
-.. code-block::
-
-   atlas api accessTracking listAccessLogsByClusterName --version 2023-01-01 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8
-
-.. Code end marker, please don't delete this comment
-
+.. literalinclude:: /includes/examples/atlas-api-accessTracking-listAccessLogsByClusterName-2023-01-01-default.sh
+   :language: shell

docs/command/atlas-api-accessTracking-listAccessLogsByHostname.txt

@@ -120,9 +120,5 @@ Inherited Options
 Examples
 --------
 
-.. code-block::
-
-   atlas api accessTracking listAccessLogsByHostname --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8 --hostname [hostname]
-
-.. Code end marker, please don't delete this comment
-
+.. literalinclude:: /includes/examples/atlas-api-accessTracking-listAccessLogsByHostname-2023-01-01-default.sh
+   :language: shell

docs/command/atlas-api-alertConfigurations-deleteAlertConfiguration.txt

@@ -103,9 +103,5 @@ Inherited Options
 Examples
 --------
 
-.. code-block::
-
-   atlas api alertConfigurations deleteAlertConfiguration --version 2023-01-01 --alertConfigId 32b6e34b3d91647abb20e7b8 --groupId 32b6e34b3d91647abb20e7b8
-
-.. Code end marker, please don't delete this comment
-
+.. literalinclude:: /includes/examples/atlas-api-alertConfigurations-deleteAlertConfiguration-2023-01-01-default.sh
+   :language: shell

docs/command/atlas-api-alertConfigurations-getAlertConfiguration.txt

@@ -103,9 +103,5 @@ Inherited Options
 Examples
 --------
 
-.. code-block::
-
-   atlas api alertConfigurations getAlertConfiguration --version 2023-01-01 --alertConfigId 32b6e34b3d91647abb20e7b8 --groupId 32b6e34b3d91647abb20e7b8
-
-.. Code end marker, please don't delete this comment
-
+.. literalinclude:: /includes/examples/atlas-api-alertConfigurations-getAlertConfiguration-2023-01-01-default.sh
+   :language: shell