circleci / circleci-docs

Documentation for CircleCI.
https://circleci.com/docs/
Other
795 stars 1.3k forks source link

Fix `runner.task_agent_directory` example in MR 3.0 ref [ONPREM-1269] #8806

Closed christian-stephen closed 4 months ago

christian-stephen commented 4 months ago

Description

A brief description of the changes.

The example for runner.task_agent_directory is incorrect. It should be using underscores instead of dashes: https://github.com/circleci/circleci-runner/blob/8640fb554f51ed9ebf4e593e9bd59a8a32ba79e5/config/machine/driver/config.go#L20

Reasons

A link to a GitHub and/or JIRA issue (if applicable). Otherwise, a brief sentence about why you made these changes.

https://circleci.atlassian.net/browse/ONPREM-1269

Content Checklist

Please follow our style when contributing to CircleCI docs. Our style guide is here: https://circleci.com/docs/style/style-guide-overview.

Please take a moment to check through the following items when submitting your PR (this is just a guide so will not be relevant for all PRs) 😸: