grim/convey

Document the new stage.Run attribute and mark stage.Always as deprecated

2017-09-04, Gary Kramlich
83977b4d7654
Parents f8f38beb1f98
Children 80aa11c2552d
Document the new stage.Run attribute and mark stage.Always as deprecated
1 files changed, 2 insertions(+), 1 deletions(-)
  • +2 -1
    REFERENCE.md
    • --- a/REFERENCE.md Mon Sep 04 22:17:44 2017 -0500
    +++ b/REFERENCE.md Mon Sep 04 22:38:16 2017 -0500
    @@ -402,11 +402,12 @@
    | Name | Required | Default | Description |
    | ----------- | -------- | ------- | ----------- |
    -| always | | false | Whether or not this stage should be run if a previous stage has failed. |
    +| always | | false | (Deprecated, used run instead) Whether or not this stage should be run if a previous stage has failed. |
    | enabled | | true | Whether or not to run the stage at all. |
    | concurrent | | false | Whether or not the tasks should be run at the same time. |
    | environment | | | A list of environment variables to set. The should be specified in a `NAME` or `NAME=VALUE` format. If no value is provided, the value of the variable from the host will be provided if it is available. These environment variables will be applied on top of any that were set at the top-level and the plan level. |
    | name | | stageN | A name to give the stage.
    +| run | No | on-success | When a stage should be run. Possible values are `on-success`, `on-failure`, or `always`. Defaults to `on-success`. |
    | tasks | Yes | | A list of task names to be run as part during this stage. If running sequentially they are run in the order that they are provided. |
    ----