Improve docs for tasks that take toolsmiths-env argument

rowanjacobs commented 4 years ago

Describe how bbl-state input and BBL_STATE_DIR params interact with toolsmiths-env input [#169967477]

What is this change about?

This change makes the documentation for tasks that take toolsmiths-env as input less confusing. Specifically, there is a note under the BBL_STATE_DIR param saying that if toolsmiths-env is specified as an input, BBL_STATE_DIR will be ignored.

Please provide contextual information.

https://www.pivotaltracker.com/story/show/169967477

Please check all that apply for this PR:

[ ] introduces a new task
[ ] changes an existing task
[ ] changes the Dockerfile
[ ] introduces a breaking change (other users will need to make manual changes when this is released)

Did you update the README as appropriate for this change?

[ ] YES
[X] N/A

How should this change be described in release notes?

Improve docs for tasks that take toolsmiths-env argument

What is the level of urgency for publishing this change?

[ ] Urgent - unblocks current or future work
[X] Slightly Less than Urgent

Tag your pair, your PM, and/or team!

@cloudfoundry/pcf-toolsmiths

cf-gitbot commented 4 years ago

We have created an issue in Pivotal Tracker to manage this:

https://www.pivotaltracker.com/story/show/172069588

The labels on this github issue will be updated when the story is started.

jamespollard8 commented 4 years ago

LGTM - thanks!

cloudfoundry / cf-deployment-concourse-tasks