Skip to content

Commit 92bcb48

Browse files
authored
Merge pull request egen#87 from starkandwayne/reword-lesson-05
Reword benefits/downsides section in lesson 05. [Fixes egen#41]
2 parents c939cf2 + 994b698 commit 92bcb48

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -453,22 +453,22 @@ The name of resources, and later the name of task outputs, determines the name u
453453
So, `hello-world` can access anything from `resource-tutorial` (this tutorial's `git` repository) under the `resource-tutorial/` path. Since the relative path of `task_hello_world.yml` task file inside this repo is `01_task_hello_world/task_hello_world.yml`, the `task: hello-world` references it by joining the two: `file: resource-tutorial/01_task_hello_world/task_hello_world.yml`
454454

455455

456-
There is a benefit and a downside to abstracting tasks into YAML files outside of the pipeline.
456+
There are benefits and downsides to abstracting tasks into YAML files outside of the pipeline.
457457

458458
One benefit is that the behavior of the task can be kept in sync with the primary input resource (for example, a software project with tasks for running tests, building binaries, etc).
459459

460-
One downside is that the `pipeline.yml` no longer explains exactly what commands will be invoked. Comprehension of pipeline behavior is potentially reduced.
460+
Another benefit of extracting inline tasks into task files is that `pipeline.yml` files can get long and it can be hard to read and comprehend all the YAML. When extracting tasks into separate files we can give them long names so that readers can understand the purpose and expectation of the tasks at a glance.
461461

462-
But one benefit of extracting inline tasks into task files is that `pipeline.yml` files can get long and it can be hard to read and comprehend all the YAML. Instead, give tasks long names so that readers can understand what the purpose and expectation of the task is at a glance.
462+
One downside is that the `pipeline.yml` no longer explains exactly what commands will be invoked. Comprehension of pipeline behavior is potentially reduced.
463463

464-
But one downside of extracting inline tasks into files is that `fly set-pipeline` is no longer the only step to updating a pipeline.
464+
Also, when we extract inline tasks into files, `fly set-pipeline` is no longer the only step to updating a pipeline.
465465

466466
From now onwards, any change to your pipeline might require you to do one or both:
467467

468468
* `fly set-pipeline` to update Concourse on a change to the job build plan and/or input/output resources
469469
* `git commit` and `git push` your primary resource that contains the task files and task scripts
470470

471-
If a pipeline is not performing new behaviour then it might be you skipped one of the two steps above.
471+
If the new behavior you intended is not showing up in the pipeline then you may have skipped one of the two steps above.
472472

473473
### 06 - View job output in terminal
474474

0 commit comments

Comments
 (0)