chore: add docs deploy script (#5682)

Co-authored-by: Maksim Karatkevich <m.karatkevich@akveo.com>
This commit is contained in:
maksim-karatkevich 2020-05-15 16:32:37 +03:00 committed by GitHub
parent a48cb2b0bf
commit ef650ae1cf
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 30 additions and 4 deletions

View file

@ -1,12 +1,13 @@
### Actions deploy guide
In order to trigger `deploy-to-demo` action you should execute the following curl:
In order to trigger workflow action you should execute the following curl:
`curl -H "Accept: application/vnd.github.everest-preview+json" \`
`-H "Authorization: token <ACCESS_TOKEN>" \`
`--request POST \`
`--data '{"event_type": "deploy-to-demo"}' \`
`--data '{"event_type": "<ACTION>"}' \`
`https://api.github.com/repos/akveo/ngx-admin/dispatches`
This curl expects `ACCESS_TOKEN` input parameter
<br>`ACCESS_TOKEN`: A personal access token. Creating a [personal access token guide](https://help.github.com/en/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line)
This curl expects two input parameters:
- `ACCESS_TOKEN`: A personal access token. Creating a [personal access token guide](https://help.github.com/en/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line)
- `ACTION`: action to trigger ('deploy-docs', 'deploy-to-demo')