Skip to content
This repository has been archived by the owner on Jul 10, 2021. It is now read-only.

Update index.md #1957

Open
wants to merge 7 commits into
base: master
Choose a base branch
from
Open

Update index.md #1957

Changes from 4 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
d120832
Update index.md
stephly07 Jul 21, 2020
8824daf
Merge branch 'master' into patch-12
dorbin Jul 22, 2020
e198079
Merge branch 'master' into patch-12
dorbin Jul 22, 2020
1e6e379
Merge branch 'master' into patch-12
dorbin Jul 22, 2020
fb59f17
Merge branch 'master' into patch-12
dorbin Jul 23, 2020
15edab8
Merge branch 'master' into patch-12
dorbin Jul 27, 2020
01ce98b
Merge branch 'master' into patch-12
317brian Jul 29, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 9 additions & 8 deletions guides/user/pipeline/triggers-with-artifactsrewrite/webhooks/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,11 @@ sidebar:

In order to programatically trigger pipelines you can send a `POST` call to
Spinnaker at a preconfigured endpoint. You can use this to trigger pipelines
when a CI job finishes, from the command line, or from a third-party system.
The payload, whether it is one you are able to write, or it is provided for
when a CI job finishes, from the command line or from a third-party system.
The payload, whether it's one you're able to write, or it's provided for
you, will be available in the Pipeline's execution.

> __☞ Note__: You can configure multiple pipelines to trigger off of a single
> __Note:__ You can configure multiple pipelines to trigger off of a single
dorbin marked this conversation as resolved.
Show resolved Hide resolved
> webhook.

If you're triggering from a *GitHub* webhook, see the instructions
Expand Down Expand Up @@ -44,8 +44,9 @@ endpoint depends on how you've configured your [Spinnaker
endpoints](/setup/security) -- if you're running on a different endpoint, for
example `https://api.spinnaker-prod.net`, that'll be shown instead.

Keeping track of that endpoint as `$ENDPOINT` (it will depend on where
Spinnaker is installed), save that pipeline, and run:
Keeping track of that endpoint as `$ENDPOINT` will depend on where
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe just:
"Save that pipeline and run:
[command, including $ENDPOINT]
Where $ENDPOINT is the URL for the endpoint, which depends on where Spinnaker is installed."

Or something like that?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These would work better as imperative verbs in numbered steps, but you'd have to do that to the entire article.
This paragraph here is the third step in this section.

Spinnaker is installed.
Save that pipeline and run:

```bash
curl $ENDPOINT -X POST -H "content-type: application/json" -d "{ }"
Expand All @@ -58,7 +59,7 @@ arrives, you can provide __Payload Constraints__ in the trigger. These are
key/value pairs where the key must be found in the incoming payload, and the
value must match using regex.

For example, if we had configured:
For example, if we configured:

{%
include
Expand Down Expand Up @@ -100,7 +101,7 @@ same configuration screen as the webhook trigger:
[pipeline expressions guide](/guides/user/pipeline-expressions)."
%}

If you were to manually execute this pipeline, you would be prompted with the
If you manually executed this pipeline, you would be prompted with the
following dialogue:

{%
Expand All @@ -121,7 +122,7 @@ following payload for example:
}
```

> __☞ Note__: If you select the __Required__ checkbox for a parameter without
> __Note:__ If you select the __Required__ checkbox for a parameter without
> providing a default, the pipeline does not trigger if a parameter is not
> present. The difference between this and the preconditions covered earlier is
> that when a precondition isn't met, Spinnaker doesn't even try to run the
Expand Down