This action handles the setup and teardown of a Cosmos DB namespace for running tests.
To set up a Cosmos DB account using the Core (SQL) API:
- name: Setup Cosmos DB
uses: Particular/[email protected]
with:
connection-string-name: EnvVarToCreateWithConnectionString
azure-credentials: ${{ secrets.AZURE_ACI_CREDENTIALS }}
tag: PackageNameTo set up a Cosmos DB account using the Table API:
- name: Setup Cosmos DB
uses: Particular/[email protected]
with:
api: Table
connection-string-name: EnvVarToCreateWithConnectionString
azure-credentials: ${{ secrets.AZURE_ACI_CREDENTIALS }}
tag: PackageNameThe setup action also automatically propagates the following environment variables:
EnvVarToCreateWithConnectionString_Apiwith a value that represents the chosen API flavourEnvVarToCreateWithConnectionString_DatabaseNamewhat a value that represents the database nameEnvVarToCreateWithConnectionString_ContainerOrTableNamewhat a value that represents the container or table name
The action tries to create the Cosmos DB account in the same region as the GitHub runner currently assigned to the workflow in order to minimize latency. However, sometimes Azure does not have enough Cosmos DB capacity in certain regions, causing account creation to fail.
The config branch of this repository stores the azure-regions.config file which controls which regions are allowed. If the GitHub Actions runner is not running in one of these regions, an allowed region will be selected at random.
The list can be updated via a PR to the config branch.
The scripts and documentation in this project are released under the MIT License.
Open the folder in Visual Studio Code and do the following:
Log into Azure
az login
az account set --subscription SUBSCRIPTION_IDRun the npm installation
npm installWhen changing index.js, either run npm run dev beforehand, which will watch the file for changes and automatically compile it, or run npm run prepare afterwards.