Skip to content

Commit 5611e8d

Browse files
committed
add how-to section for usage
1 parent 931bdd3 commit 5611e8d

File tree

4 files changed

+17
-0
lines changed

4 files changed

+17
-0
lines changed

README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,23 @@ The action pushes to an Azure Storage Container, and assumed an existing reverse
66

77
By default, it will also purge the provided CDN path.
88

9+
## How to
10+
11+
1. Head to the actions section of your repository, for example https://github.com/yourOrg/yourRepo/actions
12+
13+
1. On the left side, click on Build and deploy (docs)
14+
![Build and deploy (docs)](/images/build-and-deploy.png "Build and deploy (docs)")
15+
1. On the right side, you should now see a Run workflow button
16+
![Run Workflow](/images/run-workflow.png "Run Workflow")
17+
1. Clicking this will open a menu which lets you select the branch you want to build, and which environment you'd like to deploy to
18+
1. Preview will generate a custom url for any branch you want, and will be available in the workflow output.
19+
All builds, regardless of environment, will print a url to the summary.
20+
![Summary](/images/summary.png "Summary")
21+
22+
Preview URLs wil be added as a comment to PRs automatically.
23+
24+
_note: autodeploy from branch is currently in progress. This docs will be updated when available._
25+
926
## Usage
1027

1128
### Security considerations

images/build-and-deploy.png

180 KB
Loading

images/run-workflow.png

189 KB
Loading

images/summary.png

343 KB
Loading

0 commit comments

Comments
 (0)