From 7f5f44e1337651988c4ab0ff1b48cb96c855f24b Mon Sep 17 00:00:00 2001 From: Anupama Tuli Date: Fri, 8 Nov 2019 14:14:09 -0800 Subject: [PATCH] Update Readme.md to be in sync with action add-review-url@ Releases/v2 --- actions/add-review-url/README.md | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) diff --git a/actions/add-review-url/README.md b/actions/add-review-url/README.md index 416ba1a9a..5ee61fe3d 100644 --- a/actions/add-review-url/README.md +++ b/actions/add-review-url/README.md @@ -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 ```