Skip to content

Commit d798601

Browse files
Merge pull request circleci#2957 from circleci/tjs/2948
Add legacy note + links to new CLI
2 parents bfd3a39 + 75463b6 commit d798601

File tree

2 files changed

+8
-0
lines changed

2 files changed

+8
-0
lines changed

jekyll/_cci2/examples.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,12 @@ title: "Testing Config Files Locally"
44
description: "Example CircleCI 2.0 Configuration Files"
55
---
66

7+
<div class="alert alert-info" role="alert">
8+
<b>Note:</b> This document describes how to test and validate your config through the CircleCI API.
9+
It is also possible to install the <a href="{{ site.baseurl }}/2.0/local-cli/#overview">CircleCI
10+
CLI</a>, which allows you to <a href="{{ site.baseurl }}/2.0/local-cli/#validate-a-circleci-config">validate</a> your CircleCI config locally.
11+
</div>
12+
713
To add a script that tests your config file locally, complete the following steps:
814

915
1. Add a shell script in your `.circleci` directory, for example, `run-build-locally.sh`.

jekyll/_cci2/local-cli.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -107,6 +107,8 @@ $ circleci config validate
107107
Config file at .circleci/config.yml is valid
108108
```
109109

110+
You can also [validate your config through CircleCI's API]({{ site.baseurl }}/2.0/examples/).
111+
110112
### Run validate using git hooks
111113
{:.no_toc}
112114

0 commit comments

Comments
 (0)