Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(deps): bump azure/webapps-deploy from 2 to 3 #2114

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

dependabot[bot]
Copy link
Contributor

@dependabot dependabot bot commented on behalf of github May 21, 2024

Bumps azure/webapps-deploy from 2 to 3.

Release notes

Sourced from azure/webapps-deploy's releases.

Release version 3.0.0 🎉

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
  • 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

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

New Contributors

Full Changelog: Azure/webapps-deploy@v2.2.11...v3.0.0

Node version updated to 20 in webapps_deploy@v2

... (truncated)

Commits

Dependabot compatibility score

You can trigger a rebase of this PR by commenting @dependabot rebase.


Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

  • @dependabot rebase will rebase this PR
  • @dependabot recreate will recreate this PR, overwriting any edits that have been made to it
  • @dependabot merge will merge this PR after your CI passes on it
  • @dependabot squash and merge will squash and merge this PR after your CI passes on it
  • @dependabot cancel merge will cancel a previously requested merge and block automerging
  • @dependabot reopen will reopen this PR if it is closed
  • @dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
  • @dependabot show <dependency name> ignore conditions will show all of the ignore conditions of the specified dependency
  • @dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
  • @dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
  • @dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

Note
Automatic rebases have been disabled on this pull request as it has been open for over 30 days.

updated-dependencies:
- dependency-name: azure/webapps-deploy
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
@dependabot dependabot bot requested a review from a team as a code owner May 21, 2024 21:23
@dependabot dependabot bot added the dependencies [auto] Pull requests that update 3rd party software libraries and requirements label May 21, 2024
Copy link

Coverage report

This PR does not seem to contain any modification to coverable code.

@thekaveman
Copy link
Member

thekaveman commented May 21, 2024

In my review of the issues on azure/webapps-deploy it wasn't clear that v3 is working/supported... some users report issues, there are inconsistencies in the docs, etc. Maybe we wait on this one for a bit.

E.g. this issue talks about deployments that actually fail at the Azure side, but are reported as successful under v3 of this Action. v2 reportedly does not have the same problem: Azure/webapps-deploy#404

@angela-tran angela-tran marked this pull request as draft May 24, 2024 17:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependencies [auto] Pull requests that update 3rd party software libraries and requirements
Projects
Status: Paused
Development

Successfully merging this pull request may close these issues.

1 participant