Skip to content

Commit be9dfc2

Browse files
Merge pull request circleci#2308 from circleci/deploy-link-and-tocs-for-lang-guides
Deploy link and tocs for lang guides
2 parents 0a33cbc + 130903e commit be9dfc2

File tree

8 files changed

+74
-14
lines changed

8 files changed

+74
-14
lines changed

jekyll/_cci2/language-android.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,9 @@ order: 9
1111

1212
This guide will help you get started with an Android application on CircleCI.
1313

14+
* TOC
15+
{:toc}
16+
1417
## Overview
1518

1619
There are some assumptions made in this guide:
@@ -55,6 +58,7 @@ jobs:
5558
destination: reports
5659
- store_test_results:
5760
path: app/build/test-results
61+
# See https://circleci.com/docs/2.0/deployment-integrations/ for deploy examples
5862

5963
```
6064
{% endraw %}
@@ -126,3 +130,7 @@ React Native projects can be built on CircleCI 2.0 using Linux, Android
126130
and macOS capabilities. Please check out [this example React Native
127131
application](https://github.com/CircleCI-Public/circleci-demo-react-native)
128132
on GitHub for a full example of a React Native project.
133+
134+
## Deploy
135+
136+
See the [Deploy]({{ site.baseurl }}/2.0/deployment-integrations/) document for example deploy target configurations.

jekyll/_cci2/language-clojure.md

Lines changed: 21 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,9 @@ order: 2
1111

1212
This guide will help you get started with a Clojure application on CircleCI 2.0. If you’re in a rush, just copy the sample configuration below into a `.circleci/config.yml` in your project’s root directory and start building.
1313

14+
* TOC
15+
{:toc}
16+
1417
## Overview
1518

1619
Otherwise, we recommend reading our [walkthrough](#config-walkthrough) for a detailed explanation of our configuration.
@@ -26,28 +29,29 @@ If you use another testing tool, you can just adjust that step to run a differen
2629

2730
{% raw %}
2831
```YAML
29-
version: 2
30-
jobs:
31-
build:
32-
working_directory: ~/cci-demo-clojure
33-
docker:
34-
- image: circleci/clojure:lein-2.7.1
35-
environment:
32+
version: 2 # use CircleCI 2.0
33+
jobs: # basic units of work in a run
34+
build: # runs not using Workflows must have a `build` job as entry point
35+
working_directory: ~/cci-demo-clojure # directory where steps will run
36+
docker: # run the steps with Docker
37+
- image: circleci/clojure:lein-2.7.1 # ...with this image as the primary container; this is where all `steps` will run
38+
environment: # environment variables for primary container
3639
LEIN_ROOT: nbd
37-
JVM_OPTS: -Xmx3200m
38-
steps:
39-
- checkout
40-
- restore_cache:
40+
JVM_OPTS: -Xmx3200m # limit the maximum heap size to prevent out of memory errors
41+
steps: # commands that comprise the `build` job
42+
- checkout # check out source code to working directory
43+
- restore_cache: # restores saved cache if checksum hasn't changed since the last run
4144
key: cci-demo-clojure-{{ checksum "project.clj" }}
4245
- run: lein deps
43-
- save_cache:
46+
- save_cache: # generate and store cache in the .m2 directory using a key template
4447
paths:
4548
- ~/.m2
4649
key: cci-demo-clojure-{{ checksum "project.clj" }}
4750
- run: lein do test, uberjar
48-
- store_artifacts:
51+
- store_artifacts: # upload test results for display in Test Summary
4952
path: target/uberjar/cci-demo-clojure.jar
5053
destination: uberjar
54+
# See https://circleci.com/docs/2.0/deployment-integrations/ for deploy examples
5155
```
5256
{% endraw %}
5357

@@ -133,6 +137,10 @@ Finally we store the uberjar as an [artifact](https://circleci.com/docs/1.0/buil
133137

134138
Nice! You just set up CircleCI for a Clojure app.
135139

140+
## Deploy
141+
142+
See the [Deploy]({{ site.baseurl }}/2.0/deployment-integrations/) document for example deploy target configurations.
143+
136144
## Detailed Examples
137145

138146
This app illustrates the simplest possible setup for a Clojure web app. Real world projects tend to be more complex, so you may find this more detailed example useful as you configure your own projects:

jekyll/_cci2/language-go.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,9 @@ order: 3
1212

1313
**CircleCI 2.0 supports building Go projects using any version of Go that can be installed in a Docker image.**
1414

15+
* TOC
16+
{:toc}
17+
1518
## New to CircleCI 2.0?
1619

1720
If you're new to CircleCI 2.0, we recommend reading our [walkthrough](#config-walkthrough) for a detailed explanation of our configuration.
@@ -192,4 +195,9 @@ Finally, let's specify a path to store the results of the tests.
192195

193196
Success! You just set up CircleCI 2.0 for a Go app. Check out our {% comment %} TODO: Jobs {% endcomment %} [project’s build page](https://circleci.com/gh/CircleCI-Public/circleci-demo-go) to see how this looks when building on CircleCI.
194197

195-
If you have any questions about the specifics of testing your Go application, head over to our [community forum](https://discuss.circleci.com/) for support from us and other users.
198+
## Deploy
199+
200+
## Deploy
201+
202+
See the [Deploy]({{ site.baseurl }}/2.0/deployment-integrations/) document for example deploy target configurations.
203+

jekyll/_cci2/language-java.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,9 @@ order: 4
1111

1212
This guide will help you get started with a Java application on CircleCI.
1313

14+
* TOC
15+
{:toc}
16+
1417
## Overview
1518

1619
If you’re in a rush, just copy the sample configuration below into a `.circleci/config.yml` in your project’s root directory and start building.
@@ -57,6 +60,7 @@ jobs: # a collection of steps
5760

5861
- store_artifacts: # store the uberjar as an artifact
5962
path: target/demo-java-spring-0.0.1-SNAPSHOT.jar
63+
# See https://circleci.com/docs/2.0/deployment-integrations/ for deploy examples
6064
```
6165
{% endraw %}
6266

@@ -141,5 +145,9 @@ Finally we store the uberjar as an [artifact](https://circleci.com/docs/2.0/arti
141145

142146
Nice! You just set up CircleCI for a Java app using Maven and Spring.
143147

148+
## Deploy
149+
150+
See the [Deploy]({{ site.baseurl }}/2.0/deployment-integrations/) document for example deploy target configurations.
151+
144152

145153

jekyll/_cci2/language-javascript.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,9 @@ order: 5
1111

1212
If you're new to CircleCI 2.0, we recommend reading our [Project Walkthrough]({{ site.baseurl }}/2.0/project-walkthrough/) for a detailed explanation of our configuration using Python and Flask as an example.
1313

14+
* TOC
15+
{:toc}
16+
1417
## Quickstart: demo JavaScript NodeJS reference project
1518

1619
We maintain a reference JavaScript NodeJS project to show how to build an Express.js app on CircleCI 2.0:
@@ -75,12 +78,17 @@ jobs: # a collection of steps
7578
prefix: coverage
7679
- store_test_results: # special step to upload test results for display in Test Summary
7780
path: test-results.xml
81+
# See https://circleci.com/docs/2.0/deployment-integrations/ for deploy examples
7882
```
7983
{% endraw %}
8084
---
8185

8286
Success! You just set up CircleCI 2.0 for a NodeJS app. Check out our [project’s {% comment %} TODO: Job {% endcomment %}build page](https://circleci.com/gh/CircleCI-Public/circleci-demo-javascript-express) to see how this looks when building on CircleCI.
8387

88+
## Deploy
89+
90+
See the [Deploy]({{ site.baseurl }}/2.0/deployment-integrations/) document for example deploy target configurations.
91+
8492
## See Also
8593

8694
Refer to the [Examples]({{ site.baseurl }}/2.0/examples/) page for more configuration examples of public Javascript projects.

jekyll/_cci2/language-php.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,9 @@ order: 6
1111

1212
If you're new to CircleCI 2.0, we recommend reading our [Project Walkthrough]({{ site.baseurl }}/2.0/project-walkthrough/) for a detailed explanation of our configuration using Python and Flask as an example.
1313

14+
* TOC
15+
{:toc}
16+
1417
## Quickstart: Demo PHP Laravel reference project
1518

1619
We maintain a reference PHP Laravel project to show how to build PHP on CircleCI 2.0:
@@ -76,13 +79,18 @@ jobs: # a collection of steps
7679
- run: php artisan migrate --env=testing --database=sqlite_testing --force
7780
- run: ./vendor/bin/codecept build
7881
- run: ./vendor/bin/codecept run
82+
# See https://circleci.com/docs/2.0/deployment-integrations/ for deploy examples
7983
```
8084
{% endraw %}
8185

8286
---
8387

8488
Success! You just set up CircleCI 2.0 for a PHP app. Check out our {% comment %} TODO: Job {% endcomment %} [project’s build page](https://circleci.com/gh/CircleCI-Public/circleci-demo-php-laravel) to see how this looks when building on CircleCI.
8589

90+
## Deploy
91+
92+
See the [Deploy]({{ site.baseurl }}/2.0/deployment-integrations/) document for example deploy target configurations.
93+
8694
## See Also
8795

8896
Refer to the [Examples]({{ site.baseurl }}/2.0/examples/) page for more configuration examples of public PHP projects.

jekyll/_cci2/language-python.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,9 @@ order: 7
1111

1212
This document describes CircleCI configuration for a sample application written in Python.
1313

14+
* TOC
15+
{:toc}
16+
1417
## Demo Python Django Reference Project
1518

1619
We maintain a reference Python Django project to show how to build Django on CircleCI 2.0:
@@ -85,9 +88,15 @@ Finally, add several `steps` within the `build` job:
8588
- store_artifacts: # special step to store test reports as artifacts
8689
path: test-reports/
8790
destination: tr1
91+
# See https://circleci.com/docs/2.0/deployment-integrations/ for deploy examples
8892
```
8993
{% endraw %}
9094

9195
Refer to the [configuration reference]({{ site.baseurl }}/2.0/configuration-reference/) for the complete list of available CircleCI configuration keys.
9296

97+
## Deploy
98+
99+
See the [Deploy]({{ site.baseurl }}/2.0/deployment-integrations/) document for example deploy target configurations.
100+
101+
93102

jekyll/_cci2/language-ruby.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,9 @@ order: 8
1111

1212
This guide will help you get started with a Ruby on Rails application on CircleCI.
1313

14+
* TOC
15+
{:toc}
16+
1417
## Overview
1518

1619
If you’re in a rush, just copy the sample configuration below into a `.circleci/config.yml` in your project’s root directory and start building.

0 commit comments

Comments
 (0)