sgollapudi77
released this
11 Oct 12:51
·
14 commits
to releases/v3
since this release
Release v3
Moving from the older Zip Deploy API to Kudu Publish API for deploying your webapp via Github action webapps-deploy
.
Reason for migration
The reason for this change is the Publish API /api/publish/
has many more features over the older /zipdeploy/
API and it is also currently used in the Azure CLI, plugins for Maven and Gradle, it would be consistent with other deployment providers.
What it means for the existing users
- Users who are currently using the
webapps-deploy@v2
can still use the same action without any change in the workflow file. - Users who want to shift to the new workflow can use the
webapps-deploy@v3
to use the new Publish API features.
Features
- New workflow parameter
type
- The type of the artifact being deployed, this sets the default target path and informs the web app how the deployment should be handled.- Allowed values: JAR, WAR, EAR, ZIP, Static
- Ex:
- type=war: Deploy a WAR package. By default, the WAR package is deployed to /home/site/wwwroot/app.war. The target path can be specified with parameter target-path.
- New workflow parameter
target-path
- The absolute path to deploy the artifact to.- Allowed value: {string}
- Ex:
/home/site/wwwroot
- New workflow parameter
clean
- Specifies whether to clean (delete) the target deployment before deploying the artifact there.- Allowed values:
true/false
- Ex:
clean=true
- Allowed values:
- New workflow parameter
restart
- By default, the API restarts the app following the deployment operation (restart=true). To deploy multiple artifacts, prevent restarts on all but the final deployment by setting restart=false.- Allowed values:
true/false
- Ex:
restart=true
- Allowed values:
Example
- name: Deploy to Azure Web App
id: deploy-to-webapp
uses: azure/webapps-deploy@v3
with:
app-name: ${{ env.AZURE_WEBAPP_NAME }}
publish-profile: ${{ secrets.AZURE_WEBAPP_PUBLISH_PROFILE }}
package: '*.war'
type: (jar, war, zip, static)
clean: (true, false)
target-path: (i.e. /home/site/wwwroot/test, /home/site/wwwroot/test.war)
restart: (true, false)
What's Changed
- Migrate webapps-deploy to OneDeploy by @dannysongg in #360
New Contributors
- @dannysongg made their first contribution in #360
Full Changelog: v2.2.11...v3.0.0