Skip to content
This repository was archived by the owner on Oct 11, 2023. It is now read-only.

Commit 3e87a82

Browse files
authored
Merge pull request #212 from Azure/s-tuli/updateactionreadme
Update Readme.md to be in sync with action add-review-url@ Releases/v2
2 parents 6a8d60e + 7f5f44e commit 3e87a82

File tree

1 file changed

+9
-6
lines changed

1 file changed

+9
-6
lines changed

actions/add-review-url/README.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,16 @@ Refer to the documentation for [Azure Dev-spaces sample app](https://github.com/
77
## Example workflow syntax
88
The following Action snippet is used in the [Bikesharing sample PR workflow ](https://github.com/Azure/dev-spaces/blob/master/.github/workflows/bikes.yml)
99
```
10-
- uses: azure/dev-spaces/actions/add-review-url@Releases/v1
11-
with:
12-
repo-token: ${{ secrets.GITHUB_TOKEN }}
13-
host: ${{ secrets.HOST }}
10+
- uses: azure/dev-spaces/actions/add-review-url@Releases/v2
11+
with:
12+
repo-token: ${{ secrets.GITHUB_TOKEN }}
13+
host: ${{ secrets.HOST }}
14+
child-space: ${{steps.generate-child-space-name.outputs.result}}
15+
protocol: 'http'
1416
```
15-
where secrets.HOST is the host URL for the app deployed in AKS. See [Pull Request Flow Documentation for Azure Dev Spaces](https://aka.ms/devspaces/pr-flow#configure-your-github-action)
16-
17+
where:
18+
secrets.HOST is the host URL for the app deployed in AKS. See [Pull Request Flow Documentation for Azure Dev Spaces](https://aka.ms/devspaces/pr-flow#configure-your-github-action)
19+
protocol is an optional parameter that user can so choose to specify as https vs http as the case maybe. By default, its value is http. This is used to construct the URL of the preview app
1720
## How to build this GitHub Action for development
1821
Navigate to the directory: .\actions\add-review-url\src and run
1922
```

0 commit comments

Comments
 (0)