Skip to content

Commit

Permalink
Update Readme and Changelog for v5.0 (#248)
Browse files Browse the repository at this point in the history
* Update CHANGELOG and README for v5.0 release
  • Loading branch information
nturinski authored Dec 15, 2017
1 parent 9aaf0cf commit dd976bc
Show file tree
Hide file tree
Showing 7 changed files with 31 additions and 10 deletions.
13 changes: 8 additions & 5 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,15 @@ All notable changes to the "azure-appservice" extension will be documented in th

## 0.5.0 - 2017-12-15
### Added
- Change Deployment Source for apps and slots
- Deploy from Explorer
- Auto-detects deployment method
- Select configuration source when adding deployment slots
- View and edit a web app's files (feature flag required)
- Configure web app's deployment source from the explorer
- Deploy from Explorer with a button
- Deploy projects immediately after web app creation
- Browse for any folder when deploying
- Zip deployment file inclusion setting
- Create deployment slots from configuration sources
- UI improvements including "Creating..." placeholder nodes, "Load More..." when there are a lot of web apps, etc.
- View and edit a web app's files (feature flag required)
- Run commands from the Command Palette

### Removed
- Deployment from web app context menu
Expand Down
28 changes: 23 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,27 +2,45 @@
The Azure App Services extension for VS Code lets you quickly browse, create, manage, and deploy Azure App Service websites.

## Features

* Browse sites across all of your Azure subscriptions
* Browse to the Azure Portal for advanced tasks, such as scaling
* Create new web apps/deployment slots (Linux with Node.js only)
* Deploy to your web apps/deployment slots

![Deploy to Web App](resources/WebApp_Deploy.png)

* Start, stop, and restart the web app/deployment slot
* Swap deployment slots
* View and edit web app settings

![Add App Settings](resources/ApplicationSettings_Add.png)
![Edit App Settings](resources/ApplicationSettings_Edit.png)
* View web app log stream

![Web App Log Stream](resources/WebApp_LogStream.png)

* How to configure zip deployment:
* If you set the deployment source of your web app to “None”, the deploy command will Zip the contents of a selected folder and upload the Zip file to Azure. You might want to use the following settings to customize which files to include/exclude:

* 'appService.zipGlobPattern'
* Uses a glob pattern to define which files to be included in the deployment. The default value is “**/*”.

* 'appService.zipIgnorePattern'
* Uses a glob pattern to define which files to be excluded from the deployment. The default value is “” which doesn’t exclude any files/folders.

* For example, you might want to exclude the “node_modules” folder from the deployment to speed up the Zip file creation and uploading. In this case, you will need the following setting:
* “appService.zipIgnorePattern”: “node_modules{,/**}”
* And in order to have the web app run proper deployment command to restore the npm packages, you need to have the following Application Setting on your site:
* SCM_DO_BUILD_DURING_DEPLOYMENT=true

![Web App Log Stream](resources/Scm_Do_Build_During_Deployment.png)

## Preview Features

* View and edit a web app's files
* To enable this feature, modify your `appService.showRemoteFiles` user setting to true.
* To enable this feature, click File > Preferences > Settings. modify your `appService.showRemoteFiles` to be true.

![Enable Remote File Editing](resources/Remote_File_Editing_Setting.png)

* To view a file, click on it in the explorer.
* To edit, make edits in the editor and save it. When prompted to upload the file, click "Upload".
* CAUTION: Manually editing your Web App's files could cause unexpected behavior.

## Known Issues
Expand Down
Binary file removed resources/ApplicationSettings_Add.png
Binary file not shown.
Binary file removed resources/ApplicationSettings_Edit.png
Binary file not shown.
Binary file added resources/Remote_File_Editing_Setting.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added resources/Scm_Do_Build_During_Deployment.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified resources/WebApp_Deploy.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit dd976bc

Please sign in to comment.