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

Commit

Permalink
Merge pull request #212 from Azure/s-tuli/updateactionreadme
Browse files Browse the repository at this point in the history
Update Readme.md to be in sync with action add-review-url@ Releases/v2
  • Loading branch information
s-tuli committed Nov 12, 2019
2 parents 6a8d60e + 7f5f44e commit 3e87a82
Showing 1 changed file with 9 additions and 6 deletions.
15 changes: 9 additions & 6 deletions actions/add-review-url/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,16 @@ Refer to the documentation for [Azure Dev-spaces sample app](https://github.com/
## Example workflow syntax
The following Action snippet is used in the [Bikesharing sample PR workflow ](https://github.com/Azure/dev-spaces/blob/master/.github/workflows/bikes.yml)
```
- uses: azure/dev-spaces/actions/add-review-url@Releases/v1
with:
repo-token: ${{ secrets.GITHUB_TOKEN }}
host: ${{ secrets.HOST }}
- uses: azure/dev-spaces/actions/add-review-url@Releases/v2
with:
repo-token: ${{ secrets.GITHUB_TOKEN }}
host: ${{ secrets.HOST }}
child-space: ${{steps.generate-child-space-name.outputs.result}}
protocol: 'http'
```
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)

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)
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
## How to build this GitHub Action for development
Navigate to the directory: .\actions\add-review-url\src and run
```
Expand Down

0 comments on commit 3e87a82

Please sign in to comment.