Skip to content

Commit e4c7f5b

Browse files
committed
Add scripts/ to script paths in INSTALL.md
1 parent 2738f8b commit e4c7f5b

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

INSTALL.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -132,7 +132,7 @@ The private key should be a single line, removing the whitespace in the `.pem` f
132132
-----BEGIN RSA PRIVATE KEY-----MIAAA...AAA==-----END RSA PRIVATE KEY-----
133133
```
134134

135-
You can use the `pem-to-one-liner.sh` script to do this, which just uses `tr` to remove the line breaks.
135+
You can use the `scripts/pem-to-one-liner.sh` script to do this, which just uses `tr` to remove the line breaks.
136136

137137
It is also possible to set these directly in the Azure Portal, but you may prefer to configure them in code.
138138

@@ -142,7 +142,7 @@ You can sync your remote settings from the app you created to the local repo.
142142

143143
You can use the Azure Functions extension in VSCode. Right-click on the Function App in the Resources pane, and select "Download remote settings" from the context menu.
144144

145-
Alternatively, you can also use the `sync-settings-remote-to-local.sh` script, after you set `azure.env` appropriately. This will save the settings to `remote.settings.json`, which you can copy to `local.settings.json`.
145+
Alternatively, you can also use the `scripts/sync-settings-remote-to-local.sh` script, after you set `scripts/azure.env` appropriately. This will save the settings to `remote.settings.json`, which you can copy to `local.settings.json`.
146146

147147
Then in your `local.settings.json` file these environment variables are defined like:
148148

@@ -171,7 +171,7 @@ You can also set them directly in the `local.settings.json` (as above) and sync
171171

172172
#### Configuring the Functions App with the Azure CLI
173173

174-
You can use the `sync-settings-local-to-remote.sh` shell script provided in this repository. Make sure to set the `local.settings.json` and `azure.env` appropriately first.
174+
You can use the `scripts/sync-settings-local-to-remote.sh` shell script provided in this repository. Make sure to set the `local.settings.json` and `scripts/azure.env` appropriately first.
175175

176176
### Deploying the Function to the Function App
177177

@@ -181,7 +181,7 @@ You can use the Azure Portal, the Azure CLI, or the VSCode Azure Functions exten
181181

182182
Some of these steps assume you have zipped up the code of this function into `slack-secret-scanning-notifier.zip`.
183183

184-
You can do that using the `make-function-zip.sh` shell script provide in this repository. Make sure to set the `azure.env` appropriately first.
184+
You can do that using the `scripts/make-function-zip.sh` shell script provide in this repository. Make sure to set the `scripts/azure.env` appropriately first.
185185

186186
#### Deploying with the Azure Portal
187187

@@ -195,9 +195,9 @@ Select "Zip Deploy", and upload the `slack-secret-scanning-notifier.zip` file.
195195

196196
#### Deploying with the Azure CLI
197197

198-
Use the `deploy.sh` shell script provided in this repository. Make sure to set the `azure.env` appropriately first.
198+
Use the `scripts/deploy.sh` shell script provided in this repository. Make sure to set the `scripts/azure.env` appropriately first.
199199

200-
That may fail if it can't find the function app. If it does, you can try using `deploy-zip.sh` instead, using the `slack-secret-scanning-notifier.zip`.
200+
That may fail if it can't find the function app. If it does, you can try using `scripts/deploy-zip.sh` instead, using the `slack-secret-scanning-notifier.zip`.
201201

202202
#### Deploying with the VSCode Azure Functions extension
203203

@@ -211,7 +211,7 @@ There are a couple of ways to deploy the function to the Function App with the V
211211

212212
You need to find the URL of the Function to set up the GitHub App's webhook.
213213

214-
This is returned when you deploy the function to the Function App using the `deploy.sh` script. If you used a different method, you may need to find it manually.
214+
This is returned when you deploy the function to the Function App using the `scripts/deploy.sh` script. If you used a different method, you may need to find it manually.
215215

216216
You can use the Azure Portal, the Azure CLI, or the VSCode Azure Functions extension to do this.
217217

@@ -225,7 +225,7 @@ That should take you to the Function App's page. You should see your Function li
225225

226226
#### Finding the Function's URL with the Azure CLI
227227

228-
Use the `get-function-url.sh` shell script provided in this repository. Make sure to set the `azure.env` appropriately first.
228+
Use the `scripts/get-function-url.sh` shell script provided in this repository. Make sure to set the `scripts/azure.env` appropriately first.
229229

230230
This gets the URL of your Functions App and adds `/api/slack-secret-scanning-notifier` to the end of the URL, to get the full URL to your Function.
231231

0 commit comments

Comments
 (0)