Skip to content

Commit

Permalink
Fix the various places where version 2.1 was not represented in sampl…
Browse files Browse the repository at this point in the history
…es (#54)
  • Loading branch information
ndintenfass committed Aug 26, 2018
1 parent 54dd8aa commit 0d39520
Show file tree
Hide file tree
Showing 6 changed files with 12 additions and 17 deletions.
3 changes: 1 addition & 2 deletions docs/commands.md
Expand Up @@ -83,13 +83,12 @@ commands:
The above could be invoked in `config.yml` as:

```yaml
version: 2
version: 2.1

orbs:
s3tools: circleci/s3@1

workflows:
version: 2
build-test-deploy:
jobs:
- deploy2s3:
Expand Down
2 changes: 1 addition & 1 deletion docs/conditional-steps.md
Expand Up @@ -43,7 +43,7 @@ jobs:

```yaml
# inside config.yml
version: 2
version: 2.1

orbs:
myorb: mynamespace/myorb@1.0.1
Expand Down
6 changes: 3 additions & 3 deletions docs/executors.md
Expand Up @@ -21,7 +21,7 @@ An executor definition includes the subset of the children keys of a `job` decla
A simple example of using an executor:

```yaml
version: 2
version: 2.1
executors:
my-executor:
docker:
Expand Down Expand Up @@ -201,7 +201,7 @@ Parameters in executors can be of the type `string` or `boolean`. Default values

**Example build configuration using a parameterized executor**
```yaml
version: 2
version: 2.1

executors:
python:
Expand All @@ -226,7 +226,7 @@ jobs:

**The above would resolve to:**
```yaml
version: 2
version: 2.1
jobs:
build:
steps: []
Expand Down
10 changes: 4 additions & 6 deletions docs/jobs.md
Expand Up @@ -15,7 +15,7 @@ A user must invoke jobs in the workflows stanza of `config.yml`, passing any nec
Example of defining and invoking a parameterized job in a `config.yml`:

```yaml
version: 2
version: 2.1

jobs:
sayhello:
Expand All @@ -30,7 +30,6 @@ jobs:
- echo "Hello << parameters.saywhat >>"

workflows:
version: 2
build:
jobs:
- sayhello:
Expand Down Expand Up @@ -67,10 +66,10 @@ commands:
**Config leveraging hello-orb**
```yaml
# config.yml
version: 2.1
orbs:
hello-orb: somenamespace/hello-orb@volatile
workflows:
version: 2
build:
jobs:
- hello-orb/sayhello:
Expand All @@ -82,7 +81,7 @@ workflows:
Parameters are in-scope only within the job or command that defined them. If you want a job or command to pass its parameters to a command it invokes, they must be passed explicitly.

```yaml
version: 2
version: 2.1

jobs:
sayhello:
Expand All @@ -108,7 +107,6 @@ commands:
- echo "<< parameters.saywhat >>"

workflows:
version: 2
build:
jobs:
- sayhello:
Expand All @@ -124,8 +122,8 @@ A single configuration may invoke a job many times. At configuration processing
>NOTE: The user must explicitly name repeat jobs when a repeat job should be upstream of another job in a workflow (ie: if the job is used under the `requires` key of a job invocation in a workflow you will need to name it).
```yaml
version: 2.1
workflows:
version: 2
build:
jobs:
- loadsay
Expand Down
6 changes: 2 additions & 4 deletions docs/pre-and-post-steps.md
Expand Up @@ -39,11 +39,10 @@ jobs:
Then an orb user could use the job as follows:
```yaml
# config.yml
version: 2
version: 2.1
orbs:
foo: somenamespace/foo@1.2
workflows:
version: 2
build:
jobs:
- foo/bar:
Expand All @@ -58,7 +57,7 @@ workflows:
The resulting configuration would look like this:

```yaml
version: 2
version: 2.1
jobs:
foo/bar:
machine: true
Expand All @@ -73,7 +72,6 @@ jobs:
- run:
command: echo "upload artifact to s3"
workflows:
version: 2
build:
jobs:
- foo/bar
Expand Down
2 changes: 1 addition & 1 deletion docs/whats-new.md
Expand Up @@ -11,7 +11,7 @@
Using an orb in your build configuration might look something like:

```yaml
version: 2
version: 2.1
orbs:
s3: circleci/aws-s3@1

Expand Down

0 comments on commit 0d39520

Please sign in to comment.