Azure / Azure/webapps-deploy

README doesn't have a v3 example or explanation of the differences

Open
#388 4 comments 4 reactions 1 assignee Claimed by @dannysongg View on GitHub
need-to-triage
Dominant language
TypeScript
Stars
338
Forks
234
Avg merge
53m
Merged PRs (30d)
3

Description

All examples in README.md on the v3 branch as of now:
https://github.com/Azure/webapps-deploy/blob/145a0687697df1d8a28909569f6e5d86213041f9/README.md#L90
https://github.com/Azure/webapps-deploy/blob/145a0687697df1d8a28909569f6e5d86213041f9/README.md#L122
https://github.com/Azure/webapps-deploy/blob/145a0687697df1d8a28909569f6e5d86213041f9/README.md#L177

Some thoughts about the [3.0.0 release notes](https://github.com/Azure/webapps-deploy/releases/tag/v3.0.0):

### Features
> * 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.`

-- it's unlikely this is formatted correctly.

> Allowed values: `true/false`

should be written as:
> Allowed values: `true`/`false`

### Example

```yaml
- 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)
```

This example kinda relates to the original point -- something like this should be present in the readme. Ideally with a sample of a `v2` workflow and an equivalent `v3` workflow.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.