From baa2f82d264ea07c7460e32790669e95238a2ab2 Mon Sep 17 00:00:00 2001 From: "artem.zaiko.ext" Date: Wed, 27 Apr 2022 18:11:45 +0300 Subject: [PATCH] doc(deploy): update action trigger guid --- .github/workflows/ACTION_TRIGGER_GUIDE.md | 23 ++++++++++++++--------- 1 file changed, 14 insertions(+), 9 deletions(-) diff --git a/.github/workflows/ACTION_TRIGGER_GUIDE.md b/.github/workflows/ACTION_TRIGGER_GUIDE.md index b25cb9a7..cdd5e846 100644 --- a/.github/workflows/ACTION_TRIGGER_GUIDE.md +++ b/.github/workflows/ACTION_TRIGGER_GUIDE.md @@ -1,13 +1,18 @@ ### Actions deploy guide -In order to trigger workflow action you should execute the following curl: +In order to trigger workflow action you should execute the following curl ([docs](https://docs.github.com/en/rest/actions/workflows#create-a-workflow-dispatch-event)): -`curl -H "Accept: application/vnd.github.everest-preview+json" \` -`-H "Authorization: token " \` -`--request POST \` -`--data '{"event_type": ""}' \` -`https://api.github.com/repos/akveo/ngx-admin/dispatches` +``` +curl \ + -X POST \ + -H "Accept: application/vnd.github.v3+json" \ + -H "Authorization: token " \ + https://api.github.com/repos/akveo/ngx-admin/actions/workflows//dispatches \ + -d '{"ref":"","inputs":{"name":"Mona the Octocat","home":"San Francisco, CA"}}' +``` -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') +Parameters: + +- `WORKFLOW_ID` - the workflow id or its file name (e.g. `azureCliDeploy.yml`) +- `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) +- `REF`: Required. The git reference for the workflow. The reference can be a branch or tag name. ('demo')