Skip to content

Commit c1c5e4c

Browse files
add required version include
1 parent 96f15b4 commit c1c5e4c

10 files changed

+28
-0
lines changed

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -244,6 +244,8 @@ To run your frontend app and API together locally, Azure Static Web Apps provide
244244

245245
Ensure you have the necessary command line tools installed.
246246

247+
[!INCLUDE [Required version](includes/static-web-apps-cli-required-version.md)]
248+
247249
```bash
248250
npm install -g @azure/static-web-apps-cli
249251
```

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -272,6 +272,8 @@ Replace the markup between the `body` tags in the *index.html* file with the fol
272272

273273
Now you can run your website and manipulate data in the database directly.
274274

275+
[!INCLUDE [Required version](includes/static-web-apps-cli-required-version.md)]
276+
275277
1. Use npm to install or update the Static Web Apps CLI. Select which command is best for your situation.
276278

277279
To install, use `npm install`.

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -104,6 +104,8 @@ The following sample configuration file shows you how to connect to an Azure SQL
104104

105105
The [Static Web Apps CLI](https://github.com/Azure/static-web-apps-cli) allows you to generate a configuration file stub.
106106

107+
[!INCLUDE [Required version](includes/static-web-apps-cli-required-version.md)]
108+
107109
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*.
108110

109111
Supported database types include:
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
author: craigshoemaker
3+
ms.author: cshoe
4+
ms.service: azure-static-web-apps
5+
ms.topic: include
6+
ms.date: 12/18/2024
7+
---
8+
9+
> [!IMPORTANT]
10+
> To improve the security of deployments from the 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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@ ms.author: cshoe
1111

1212
# Start the API server with the Azure Static Web App CLI
1313

14+
[!INCLUDE [Required version](includes/static-web-apps-cli-required-version.md)]
15+
1416
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.
1517

1618
You can start the core tools manually or automatically.

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@ ms.author: cshoe
1111

1212
# Configure the Azure Static Web Apps CLI
1313

14+
[!INCLUDE [Required version](includes/static-web-apps-cli-required-version.md)]
15+
1416
The Azure Static Web Apps (SWA) CLI gets configuration information for your static web app in one of two ways:
1517

1618
- CLI options (passed in at runtime)

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@ ms.author: cshoe
1111

1212
# Deploy a static web app with Azure Static Web Apps CLI
1313

14+
[!INCLUDE [Required version](includes/static-web-apps-cli-required-version.md)]
15+
1416
The Azure Static Web Apps CLI (SWA CLI) features the `deploy` command to deploy the current project to Azure Static Web Apps.
1517

1618
Common deployment scenarios include:

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@ ms.author: cshoe
1111

1212
# Start the Static Web Apps CLI emulator
1313

14+
[!INCLUDE [Required version](includes/static-web-apps-cli-required-version.md)]
15+
1416
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.
1517

1618
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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@ ms.author: cshoe
1111

1212
# Install the Static Web Apps CLI (SWA CLI)
1313

14+
[!INCLUDE [Required version](includes/static-web-apps-cli-required-version.md)]
15+
1416
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/).
1517

1618
| Resource | Command |

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@ ms.author: cshoe
1111

1212
# Azure Static Web Apps CLI overview
1313

14+
[!INCLUDE [Required version](includes/static-web-apps-cli-required-version.md)]
15+
1416
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.
1517

1618
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.

0 commit comments

Comments
 (0)