Fix #262, #259, #248

.github/workflows/code-review.yml

@@ -1,61 +1,51 @@
 ---
-name: Code Review
+name: Code Review - Linting & Link Checks
 
-##########################################
-# Start the job on push for all branches #
-##########################################
 on:
   pull_request:
     branches:
-    - main
+      - main
   workflow_dispatch: {}
 
-###############
-# Set the Job #
-###############
 jobs:
-
   lint:
     name: Lint code base
     runs-on: ubuntu-latest
 
     steps:
-
-    - name: Checkout code
-      uses: actions/checkout@v2
-      with:
-        fetch-depth: 0
-
-    - name: Run github/super-linter
-      uses: github/super-linter@v4
-      env:
-        # Lint all code
-        VALIDATE_ALL_CODEBASE: true
-        # Need to define main branch as default is set to master in super-linter
-        DEFAULT_BRANCH: main
-        # Enable setting the status of each individual linter run in the Checks section of a pull request
-        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        # The following linter types will be enabled:
-        VALIDATE_JSON: true
-        VALIDATE_MARKDOWN: true
-        VALIDATE_POWERSHELL: true
-        VALIDATE_YAML: true
+      - name: Checkout code
+        uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+
+      - name: Run github/super-linter
+        uses: github/super-linter@v4
+        env:
+          # Lint all code - disabled in as part of #262
+          VALIDATE_ALL_CODEBASE: false
+          # Need to define main branch as default is set to master in super-linter
+          DEFAULT_BRANCH: main
+          # Enable setting the status of each individual linter run in the Checks section of a pull request
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          # The following linter types will be enabled:
+          VALIDATE_JSON: true
+          VALIDATE_MARKDOWN: true
+          VALIDATE_POWERSHELL: true
+          VALIDATE_YAML: true
 
   markdown-link-check:
     name: Markdown Link Check
     runs-on: ubuntu-latest
 
     steps:
-
-    - name: Checkout code
-      uses: actions/checkout@master
-      with:
-        fetch-depth: 0
-
-    - name: Check links in markdown files 
-      uses: gaurav-nelson/[email protected]
-      with:
-        config-file: '.github/actions-config/mlc_config.json'
-        use-verbose-mode: 'yes'
-        use-quiet-mode: 'yes'
-
+      - name: Checkout code
+        uses: actions/checkout@master
+        with:
+          fetch-depth: 0
+
+      - name: Check links in markdown files
+        uses: gaurav-nelson/[email protected]
+        with:
+          config-file: ".github/actions-config/mlc_config.json"
+          use-verbose-mode: "yes"
+          use-quiet-mode: "yes"

docs/wiki/FAQ.md

@@ -10,6 +10,7 @@ Some FAQ questions that relate more to the architecture are based over in the CA
 
 ## List of Frequently Asked Questions
 
+- [Why isn't `ALZ-Bicep` v1.x.x yet?](#why-isnt-alz-bicep-v1xx-yet)
 - [Why are some linter rules disabled via the `#disable-next-line` Bicep function?](#why-are-some-linter-rules-disabled-via-the-disable-next-line-bicep-function)
 
 ---
@@ -26,6 +27,17 @@ As we use GitHub releases and tags you can clone and pin to a specific version i
 
 In summary, `ALZ-Bicep` will go v1.x.x when Bicep itself goes v1.x.x, give or take a few weeks for us to make any changes required in `ALZ-Bicep` upon the release of Bicep v1.x.x 👍
 
+## How do I get notified of the latest releases in `ALZ-Bicep`?
+
+There are a couple of ways you can ensure you get notified of the latest releases on the `ALZ-Bicep` repo.
+
+1. Configure your "Watch" settings on the repo to notify you on "Releases"
+    - See GitHub Docs on how to do this [here](https://docs.github.com/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/configuring-notifications#configuring-your-watch-settings-for-an-individual-repository)
+
+![GIF showing how to configure watch notification settings](media/alz-bicep-watch-demo.gif)
+
+2. Sign-up to and use [newreleases.io](https://newreleases.io), add this repo `Azure/ALZ-Bicep` and select your email frequency.
+
 ## Why are some linter rules disabled via the `#disable-next-line` Bicep function?
 
 In some of the ALZ-Bicep modules some of linter rules are disabled using the `#disable-next-line` Bicep feature. Today, this is primarily for disabling the [no-loc-expr-outside-params linter rule](https://docs.microsoft.com/azure/azure-resource-manager/bicep/linter-rule-no-loc-expr-outside-params) for the, optional, telemetry module as we want to ensure this telemetry deployment is stored in the same location as specified by the `location` input when deploying the Bicep module, instead of in the same location as specified by `parLocation` as this may be different from the region targeted by the deployment to ARM.