Merge pull request #81 from meraki/develop

new workflow

.ansible-lint-ignore

@@ -0,0 +1,7 @@
+workflows/docs.yml yaml[truthy]
+workflows/docs.yml yaml[new-line-at-end-of-file]
+workflows/docs.yml yaml[line-length]
+workflows/docs.yml yaml[new-line-at-end-of-file]
+workflows/sanity_tests.yml yaml[truthy]
+workflows/ansible-lint.yml yaml[new-line-at-end-of-file]
+.github/workflows/ansible-lint.yml yaml[new-line-at-end-of-file]

.github/workflows/ansible-lint.yml

@@ -0,0 +1,18 @@
+# .github/workflows/ansible-lint.yml
+name: ansible-lint
+on:
+  pull_request:
+    branches: ["main", "stable", "release/v*"]
+jobs:
+  build:
+    name: Ansible Lint # Naming the build is important to use it as a status check
+    runs-on: ubuntu-24.04
+    steps:
+      - uses: actions/checkout@v4
+      - name: Run ansible-lint
+        uses: ansible/ansible-lint@main
+        with:
+          args: ""
+          setup_python: "true"
+          working_directory: ""
+          requirements_file: ""

.github/workflows/docs.yml

@@ -29,13 +29,14 @@ jobs:
         run: make doc
       - name: commit docs
         run: |
-          git checkout gh-pages
+          git checkout gh-pages || git checkout -b gh-pages
           rm -rf $(basename ${GITHUB_REF})
           mv docs/_build/html $(basename ${GITHUB_REF})
           git show origin/main:docs/_gh_include/header.inc > index.html
           (echo main; dirname v*/index.html | sort --version-sort --reverse) \
             | xargs -I@@ \
-            -n1 echo '<div class="col-md-4 center"><a href="@@/" class="btn-doc btn"><i class="fa fa-newspaper-o"></i><p>@@</p></a></div>' >> index.html
+            -n1 echo '<div class="col-md-4 center"><a href="@@/" class="btn-doc btn">' \
+            '<i class="fa fa-newspaper-o"></i><p>@@</p></a></div>' >> index.html
           git show origin/main:docs/_gh_include/footer.inc >> index.html
           git add $(basename ${GITHUB_REF}) index.html
           git commit -m "update docs for $(basename ${GITHUB_REF})" || true

.github/workflows/sanity_tests.yml

@@ -1,13 +1,13 @@
 name: CI
 on:
   push:
-    branches: [ main ]
+    branches: [main]
   pull_request:
   schedule:
     - cron: '0 6 * * *'
 env:
   NAMESPACE: cisco
-  COLLECTION_NAME: meraki 
+  COLLECTION_NAME: meraki
 jobs:
   sanity:
     name: Sanity (Ⓐ${{ matrix.ansible }})
@@ -37,4 +37,4 @@ jobs:
         run: pip install https://github.com/ansible/ansible/archive/${{ matrix.ansible }}.tar.gz --disable-pip-version-check
       - name: Run sanity tests
         run: ansible-test sanity --docker -v --color
-        working-directory: ./ansible_collections/${{env.NAMESPACE}}/${{env.COLLECTION_NAME}}
+        working-directory: ./ansible_collections/${{env.NAMESPACE}}/${{env.COLLECTION_NAME}}

README.md

@@ -32,7 +32,8 @@ meraki_server
 Create a playbook `who_am_i.yml` ([example](https://github.com/meraki/dashboard-api-ansible/blob/main/playbooks/who_am_i.yml)):
 ```
 ---
-- hosts: meraki_servers
+- name: Play Name
+  hosts: meraki_servers
   gather_facts: false
   tasks:
     - name: Get my administered identities
@@ -139,10 +140,10 @@ The modules that were there before, usually with a `meraki` prefix, are maintain
 ```
   - name: Create webhook
     cisco.meraki.networks_webhooks_http_servers:
-      meraki_api_key: "{{meraki_api_key}}"
+      meraki_api_key: "{{ meraki_api_key }}"
       state: present
       name: Test_Hook
-      networkId: "{{network_id}}"
+      networkId: "{{ network_id }}"
       payloadTemplate:
         name: Slack (included)
         payloadTemplateId: wpt_00001