Merge pull request #2 from advanced-security/scripts

Moved scripts into their own folder

Author: aegilops

.funcignore

@@ -14,7 +14,7 @@ LICENSE
 jest.config.js
 *.example
 node_modules/.bin/
-*.sh
+scripts/
 *.env
 tsconfig.json
 src/

.gitignore

@@ -105,8 +105,5 @@ __azurite_db*__.json
 # if you fork this repo, you can uncomment this and commit your own filter.yml
 filter.yml
 
-# local example files
-*.example
-
 # Azure environment file
 azure.env

INSTALL.md

@@ -11,8 +11,9 @@ To get this Azure Function working, you need to:
 
 > [!NOTE]
 > When working with the Azure CLI, remember to use `az login` to log in to Azure, and `az logout` first if you are having problems.
->
-> To use the convenience scripts, set your Azure settings in a local `azure.env` file that they pick up. You may need to change settings if you want to vary the region the Function is used in, or change its name to allow more than one to coexist in the same subscription.
+
+> [!NOTE]
+> To use the Bash (use WSL on Windows for Bash) scripts in the `scripts` directory, set your Azure settings in a `azure.env` file that they pick up from the same directory. You may need to change settings if you want to vary the region the Function is used in, or change its name to allow more than one to coexist in the same subscription.
 
 ## Creating a GitHub app
 
@@ -78,7 +79,7 @@ This is left until the creation of the app using a manifest has been implemented
 
 You need to create an Azure Function App, and deploy the Azure Function to it.
 
-Before you deploy, set a `filter.yml` if you wish to filter out certain events. See [filtering events](README.md#filtering-events) for more details.
+Before you deploy, set a `filter.yml` if you wish to filter out certain events. See [filtering events](README.md) for more details.
 
 ### Creating the Functions App
 
@@ -98,11 +99,11 @@ Fill in the details, and click on the "Review + create" button. Make sure you se
 
 #### Creating the Functions App with the Azure CLI
 
-It needs your subscription ID, a location, and a function app name to be set in `azure.env` in the repo directory.
+It needs your subscription ID, a location, and a function app name to be set in `scripts/azure.env` in the repo directory.
 
 Only the subscription ID is necessary - the rest have defaults: you may want to change the region or the name of the function.
 
-You can use the convenience script `create-azure-function.sh`.
+You can use the convenience script `scripts/create-azure-function.sh`.
 
 #### Creating the Functions App with the VSCode Azure Functions extension
 

filter.yml

@@ -0,0 +1,13 @@
+# Save as: azure.env
+
+# if you want to use a different location than eastus, you can change this
+AZURE_LOCATION="eastus"
+
+# fill in your Azure subscription ID
+AZURE_SUBSCRIPTION_ID="..."
+
+# pick an appropriate name for the function app
+AZURE_FUNCTION_APP_NAME="teams-secret-scanning-notifier"
+
+# pick an appropriate name for a new resource group
+AZURE_RESOURCE_GROUP="${AZURE_FUNCTION_APP_NAME}-rg"

scripts/azure.env.example

@@ -2,7 +2,9 @@
 
 set -euo pipefail
 
-. ./azure.env
+SCRIPT_DIR=$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd )
+
+. "${SCRIPT_DIR}"/azure.env
 
 # set Azure location to us-east unless it is set to something different already
 AZURE_STORAGE_ACCOUNT="${AZURE_STORAGE_ACCOUNT:-teamssecretnotifier001sa}"

create-function-app.sh renamed to scripts/create-function-app.sh

@@ -1,6 +1,12 @@
 #!/bin/bash
 
-. ./azure.env
+set -euo pipefail
+
+SCRIPT_DIR=$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd )
+
+. "${SCRIPT_DIR}"/azure.env
+
+./make-function-zip.sh
 
 az account set --subscription "${AZURE_SUBSCRIPTION_ID}"
 az functionapp deployment source config-zip --resource-group "${AZURE_RESOURCE_GROUP}" --name "${AZURE_FUNCTION_APP_NAME}" --src teams-secret-scanning-notifier.zip

deploy-zip.sh renamed to scripts/deploy-zip.sh

@@ -1,6 +1,10 @@
 #!/bin/bash
 
-. ./azure.env
+set -euo pipefail
+
+SCRIPT_DIR=$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd )
+
+. "${SCRIPT_DIR}"/azure.env
 
 npm run build
 func azure functionapp publish "${AZURE_FUNCTION_APP_NAME}" || echo "Failed to publish function app, try running 'az logout' then 'az login', then try again"

deploy.sh renamed to scripts/deploy.sh

@@ -1,6 +1,10 @@
 #!/bin/bash
 
-. ./azure.env
+set -euo pipefail
+
+SCRIPT_DIR=$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd )
+
+. "${SCRIPT_DIR}"/azure.env
 
 az account set --subscription "${AZURE_SUBSCRIPTION_ID}"
 FUNCTIONS_APP_HOSTNAME=$(az functionapp show --resource-group "${AZURE_RESOURCE_GROUP}" --name "${AZURE_FUNCTION_APP_NAME}" --query "defaultHostName" --output tsv)

get-function-url.sh renamed to scripts/get-function-url.sh

@@ -10,7 +10,7 @@ zip -q -r teams-secret-scanning-notifier.zip . \
 -x 'teams-secret-scanning-notifier.zip' '.vscode/*' '*settings*.json' \
     '.git/*' '.github/*' '.gitignore' '.eslint*' '.funcignore' '*.md' \
     'CODEOWNERS' 'LICENSE' '*.ts' '*.map' 'jest.config.js' \
-    '*.example' 'node_modules/.bin/*' '*.sh' '*.env' \
+    '*.example' 'node_modules/.bin/*' 'scripts/*' '*.env' \
     'tsconfig.json' 'src/*' 'test/*' \
     'node_modules/@types/*' 'node_modules/*jest*/*' \
     'node_modules/*eslint*/*' '*/.github/*' '*/.history/*' \