Merge pull request #292147 from craigshoemaker/swa/cli/required-version

[Static Web Apps] Update: Add required version include

Author: v-shils

articles/static-web-apps/add-api.md

@@ -244,6 +244,8 @@ To run your frontend app and API together locally, Azure Static Web Apps provide
 
 Ensure you have the necessary command line tools installed.
 
+[!INCLUDE [Required version](includes/static-web-apps-cli-required-version.md)]
+
 ```bash
 npm install -g @azure/static-web-apps-cli
 ```

articles/static-web-apps/database-azure-cosmos-db.md

@@ -272,6 +272,8 @@ Replace the markup between the `body` tags in the *index.html* file with the fol
 
 Now you can run your website and manipulate data in the database directly.
 
+[!INCLUDE [Required version](includes/static-web-apps-cli-required-version.md)]
+
 1. Use npm to install or update the Static Web Apps CLI. Select which command is best for your situation.
 
     To install, use `npm install`.

articles/static-web-apps/database-configuration.md

@@ -104,6 +104,8 @@ The following sample configuration file shows you how to connect to an Azure SQL
 
 The [Static Web Apps CLI](https://github.com/Azure/static-web-apps-cli) allows you to generate a configuration file stub.
 
+[!INCLUDE [Required version](includes/static-web-apps-cli-required-version.md)]
+
 Use the `swa db init --database-type <YOUR_DATABASE_TYPE>` to generate a configuration file. By default, the CLI creates a new *staticwebapp.database.config.json* in a folder named *swa-db-connections*.
 
 Supported database types include:

articles/static-web-apps/includes/static-web-apps-cli-required-version.md

@@ -0,0 +1,10 @@
+---
+author: craigshoemaker
+ms.author: cshoe
+ms.service: azure-static-web-apps
+ms.topic: include
+ms.date: 12/18/2024
+---
+
+> [!IMPORTANT]
+> To improve the security of deployments from the [Static Web Apps CLI](https://www.npmjs.com/package/@azure/static-web-apps-cli), a breaking change was introduced that requires you to upgrade to the latest version (2.0.2) of the Static Web Apps CLI by Jan. 15th, 2025.

articles/static-web-apps/static-web-apps-cli-api-server.md

@@ -11,6 +11,8 @@ ms.author: cshoe
 
 # Start the API server with the Azure Static Web App CLI
 
+[!INCLUDE [Required version](includes/static-web-apps-cli-required-version.md)]
+
 In Azure Static Web Apps, you can use the [integrated managed Functions](/azure/static-web-apps/apis-functions) to add API endpoints to your application. You can run an Azure Functions app locally using [Azure Functions core tools CLI](/azure/azure-functions/functions-run-local). The core tools CLI gives you the opportunity to run and debug your API endpoints locally.
 
 You can start the core tools manually or automatically.

articles/static-web-apps/static-web-apps-cli-configuration.md

@@ -11,6 +11,8 @@ ms.author: cshoe
 
 # Configure the Azure Static Web Apps CLI
 
+[!INCLUDE [Required version](includes/static-web-apps-cli-required-version.md)]
+
 The Azure Static Web Apps (SWA) CLI gets configuration information for your static web app in one of two ways:
 
 - CLI options (passed in at runtime)

articles/static-web-apps/static-web-apps-cli-deploy.md

@@ -11,6 +11,8 @@ ms.author: cshoe
 
 # Deploy a static web app with Azure Static Web Apps CLI
 
+[!INCLUDE [Required version](includes/static-web-apps-cli-required-version.md)]
+
 The Azure Static Web Apps CLI (SWA CLI) features the `deploy` command to deploy the current project to Azure Static Web Apps.
 
 Common deployment scenarios include:

articles/static-web-apps/static-web-apps-cli-emulator.md

@@ -11,6 +11,8 @@ ms.author: cshoe
 
 # Start the Static Web Apps CLI emulator
 
+[!INCLUDE [Required version](includes/static-web-apps-cli-required-version.md)]
+
 Static Web Apps is a cloud-based platform that hosts and runs your web apps. When you run your app locally, you need special tools to help you approximate how your app would run in the cloud.
 
 The Static Web Apps CLI (SWA CLI) includes an emulator that mimics how your app would run on Azure, but instead runs exclusively on your machine.

articles/static-web-apps/static-web-apps-cli-install.md

@@ -11,6 +11,8 @@ ms.author: cshoe
 
 # Install the Static Web Apps CLI (SWA CLI)
 
+[!INCLUDE [Required version](includes/static-web-apps-cli-required-version.md)]
+
 You have different options available to install the Azure Static Web Apps CLI. The Azure Static Web Apps CLI requires that you have [Node.js](https://nodejs.org/) installed locally. By default, Node.js comes with the Node Package Manager (npm), though you may opt to use other package managers such as [Yarn](https://yarnpkg.com/) or [pnpm](https://pnpm.io/).
 
 | Resource | Command |

articles/static-web-apps/static-web-apps-cli-overview.md

@@ -11,6 +11,8 @@ ms.author: cshoe
 
 # Azure Static Web Apps CLI overview
 
+[!INCLUDE [Required version](includes/static-web-apps-cli-required-version.md)]
+
 Azure Static Web Apps websites are hosted in the cloud and often connect together a collection of cloud services. During development, and any time you need to run your app locally, you need tools to mimic how your app runs in the cloud.
 
 The Static Web Apps CLI (SWA CLI) includes a series of local services that approximate how your app would run on Azure, but instead they run exclusively on your machine.