Skip to content

Commit ef0c934

Browse files
authored
Merge branch 'master' into Heading-Update-v2
2 parents c211066 + 7d1827c commit ef0c934

37 files changed

+132
-54
lines changed

user/billing-overview.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -251,8 +251,9 @@ arch:
251251
- ppc64le
252252
- s390x
253253
```
254+
{: data-file=".travis.yml"}
254255
255-
Please see our [Build Environment overview](/user/reference/overview/) and [Building for Multiple CPU architectures](/user/multi-cpu-architectures/) pages for more details.
256+
For more details, please see our [Build Environment overview](/user/reference/overview/) and [Building for Multiple CPU architectures](/user/multi-cpu-architectures/) pages.
256257
257258
In order to start a build in the Usage-based Plan, a positive credits balance is required in the account (at least 1 credit). The build job under Partner Queue Solution costs 0 credits per started minute. When introducing Partner Queue Solution, active accounts on the Usage-based Plans, including the Free Plan, with a balance of zero or fewer credits, are updated to hold 1 credit. Thus, everybody can use Partner Queues without requesting Travis CI support to grant additional credits. If you run into a negative account balance after that, you must file an additional request.
258259
@@ -355,11 +356,12 @@ This scenario is an example of a user with Credits, user licenses counted within
355356

356357
## VM Instance Sizes and Credit Cost
357358

358-
Usage and Concurrency based plans allow you to choose the instance size the build will run on (for the 'full vm' build job). Larger instance sizes deliver more resources (namely vCPU and RAM) for your build jobs. This can be done by setting a 'vm' property in the .travis.yml config. This property allows you to choose the Virtual machine instance for a build:
359+
Usage and Concurrency-based plans allow you to choose the instance size the build will run on (for the 'full vm' build job). Larger instance sizes deliver more resources (namely vCPU and RAM) for your build jobs. This can be done by setting a 'vm' property in the .travis.yml config. This property allows you to choose the Virtual machine instance for a build:
359360
```yaml
360361
vm:
361362
size: [large|x-large|2x-large]
362363
```
364+
{: data-file=".travis.yml"}
363365

364366
Instance sizes do not apply to OSX build jobs. Our [CI Environment Overview page](/user/reference/overview/#vm-instance-size) describes the available VM sizes vs. operating system and CPU architecture.
365367

@@ -391,6 +393,7 @@ GPU builds allow you to choose the instance size the build will run on (for the
391393
vm:
392394
size: [gpu-medium | gpu-xlarge] #new values in the schema for existing key
393395
```
396+
{: data-file=".travis.yml"}
394397

395398
Instance sizes do not apply to Windows and OSX build jobs. Visit our [CI Environment Overview page](/user/reference/overview/#gpu-vm-instance-size) for information on the available GPU VM sizes, operating system, and CPU architecture.
396399

user/browserstack.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,7 @@ driver = Selenium::WebDriver.for(:remote,
9696
:url => "http://USERNAME:[email protected]/wd/hub",
9797
:desired_capabilities => caps)
9898
```
99+
{: data-file="example.rb"}
99100

100101
Local identifiers are essential for [matrix builds][travis-matrix-builds]. Since matrix builds in travis can be run on
101102
the same VM, we need to add the Local Identifier when starting the connection to ensure that the correct local tunnel
@@ -122,6 +123,7 @@ Once the app is uploaded to the BrowserStack servers the resulting app id will b
122123
```ruby
123124
caps['app'] = ENV['BROWSERSTACK_APP_ID']
124125
```
126+
{: data-file="example.rb"}
125127

126128
Check out the BrowserStack Android Sample App [.travis.yml][browserstack-android-app-travis] file.
127129

user/build-config-imports.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -122,7 +122,7 @@ The path is relative to the repository's root.
122122
For configurations imported from a different repository, the latest version of
123123
the default branch in the repository will be used by default.
124124

125-
For configurations imported from the same repository the commit you are
125+
For configurations imported from the same repository, the commit you are
126126
currently building will be used by default. This is intended to help while you
127127
are creating and testing the shared configurations.
128128

@@ -138,8 +138,8 @@ import:
138138

139139
## Import private repository configs
140140

141-
In order to share configurations **from** a private repository this needs to
142-
be allowed on that repository, by enabling the *Allow importing config files from this repository*
141+
In order to share configurations **from** a private repository, this needs to
142+
be allowed on that repository by enabling the *Allow importing config files from this repository*
143143
setting in `More options > Settings > Config Import`.
144144

145145
> Only private repositories owned by the same organization or user account will
@@ -205,6 +205,7 @@ import:
205205
- source: other.yml
206206
mode: deep_merge_prepend
207207
```
208+
{: data-file=".travis.yml"}
208209

209210
### Deep merge
210211

@@ -236,7 +237,7 @@ if required, sections in `one.yml` with content from `.travis.yml`). The results
236237
merged into the `two.yml` file (again, items in the result of the previous merge win
237238
over what’s in this one, as the `deep_merge` mode is specified here).
238239

239-
The reasoning behind this is that in many cases when you import something to your
240+
The reasoning behind this is that, in many cases, when you import something to your
240241
`.travis.yml` file, you want to be able to overwrite or customize that imported
241242
configuration with config in your `.travis.yml` file.
242243

@@ -245,14 +246,15 @@ configuration with config in your `.travis.yml` file.
245246
The merge mode `merge` performs a shallow merge.
246247

247248
This means that root level sections (keys) defined in your `.travis.yml` will
248-
overwrite root level sections (keys) that are also present in the imported
249+
overwrite root-level sections (keys) that are also present in the imported
249250
file.
250251

251252
```yaml
252253
import:
253254
- source: one.yml
254255
mode: merge # shallow merge
255256
```
257+
{: data-file=".travis.yml"}
256258

257259
## Import precedence
258260

user/build-matrix.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -228,7 +228,7 @@ of Python.
228228

229229
### Explicitly included jobs inherit the first value in the array
230230

231-
The jobs which are explicitly included inherit the first value of the expansion
231+
The jobs that are explicitly included inherit the first value of the expansion
232232
keys defined.
233233

234234
In this example with a 3-job Python build matrix, each job in `jobs.include`
@@ -413,6 +413,7 @@ jobs:
413413
script: echo "Running job 1"
414414
415415
```
416+
{: data-file=".travis.yml"}
416417

417418
This name will appear on the build matrix UI and can be convenient in order to
418419
quickly identify jobs in a large matrix.
@@ -434,6 +435,7 @@ jobs:
434435
- <<: *shared_job
435436
- <<: *shared_job
436437
```
438+
{: data-file=".travis.yml"}
437439

438440
In rare circumstances it can still be desirable to execute multiple jobs with the same config. In such cases, job uniqueness can be achieved by specifying any additional key, e.g., a job name:
439441

@@ -447,3 +449,4 @@ jobs:
447449
- name: Job 2
448450
<<: *shared_job
449451
```
452+
{: data-file=".travis.yml"}

user/caching.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -143,6 +143,7 @@ To disable npm caching, use:
143143
cache:
144144
npm: false
145145
```
146+
{: data-file=".travis.yml"}
146147

147148
To explicitly cache `npm`, use:
148149

@@ -443,7 +444,7 @@ usable in all jobs using it.
443444
In this case, we advise you to add a public environment variable
444445
name to each job to create a unique cache entry:
445446

446-
```
447+
```yaml
447448
CACHE_NAME=JOB1
448449
```
449450
{: data-file=".travis.yml"}
@@ -481,7 +482,7 @@ tar: /path/to/unreadable/directory: Cannot stat: No such file or directory
481482
## How does caching work
482483

483484
Travis CI saves an archive of all the directories listed in the configuration and uploads
484-
it to a storage provider, using a secure and protected URL, ensuring security and privacy of
485+
it to a storage provider, using a secure and protected URL, ensuring the security and privacy of
485486
the uploaded archives.
486487

487488
Note that this makes our cache not network-local, it is still bound to network

user/common-build-problems.md

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -44,9 +44,9 @@ are two cores available, bursted.
4444

4545
Depending on the tool in use, this can be caused by a few things:
4646

47-
- Ruby test suite consuming too much memory
48-
- Tests running in parallel using too many processes or threads (e.g. using the
49-
`parallel_test` gem)
47+
- Ruby test suite consuming too much memory.
48+
- Tests running in parallel using too many processes or threads (e.g., using the
49+
`parallel_test` gem).
5050
- g++ needing too much memory to compile files, for instance, with a lot of
5151
templates included.
5252

@@ -105,6 +105,7 @@ if defined?(RUBY_ENGINE) && RUBY_ENGINE == "ruby" && RUBY_VERSION >= "1.9"
105105
end
106106
end
107107
```
108+
{: data-file="example.rb"}
108109

109110
If your project is using the [Code Climate integration](/user/code-climate/) or
110111
Simplecov, this issue can also come up with the 0.8 branch of Simplecov. The fix
@@ -460,26 +461,28 @@ There are few ways to work around that.
460461
### Timeouts installing dependencies
461462
462463
If you are getting network timeouts when trying to download dependencies, either
463-
use the built in retry feature of your dependency manager or wrap your install
464+
use the built-in retry feature of your dependency manager or wrap your install
464465
commands in the `travis_retry` function.
465466
466467
#### Bundler
467468
468469
Bundler retries three times by default, but if you need to increase that number,
469470
use the following syntax in your `.travis.yml`
470471
471-
```bash
472+
```yaml
472473
bundler_args: --retry 5
473474
```
475+
{: data-file=".travis.yml"}
474476

475477
#### travis_retry
476478

477479
For commands which do not have a built-in retry feature, use the `travis_retry`
478-
function to retry it up to three times, if the return code is non-zero:
480+
function to retry it up to three times if the return code is non-zero:
479481

480-
```bash
482+
```yaml
481483
install: travis_retry pip install myawesomepackage
482484
```
485+
{: data-file=".travis.yml"}
483486
484487
Most of our internal build commands are wrapped with `travis_retry` to reduce the
485488
impact of network timeouts.
@@ -642,3 +645,4 @@ env:
642645
global:
643646
- NODE_OPTIONS="--dns-result-order=ipv4first"
644647
```
648+
{: data-file=".travis.yml"}

user/coveralls.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@ Add the Coveralls Gem to your `Gemfile`:
3434

3535
gem 'coveralls', require: false
3636
```
37+
{: data-file="Gemfile"}
3738

3839
You might need to update your `Gemfile.lock` as well.
3940

@@ -49,6 +50,7 @@ Add Coveralls to the top of your test suite before you `require` any application
4950
require 'coveralls'
5051
Coveralls.wear!
5152
```
53+
{: data-file="Gemfile"}
5254

5355
After those three steps, the next time you push a commit, you'll be able to look up your [code coverage statistics](https://coveralls.io)!
5456

user/coverity-scan.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -132,8 +132,8 @@ script: make
132132

133133
to
134134

135-
```bash
135+
```yaml
136136
script: if [ ${COVERITY_SCAN_BRANCH} != 1 ]; then make ; fi
137137
```
138-
138+
{: data-file=".travis.yml"}
139139
Be sure to replace `make` with your standard CI build command.

user/customizing-the-build.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ The *Auto Cancellation Setting* is in the *Settings* tab of each repository, and
7676

7777
![Auto cancellation setting](/images/autocancellation.png "Auto cancellation setting")
7878

79-
For example, in the following screenshot, we pushed commit `ca31c2b` to the branch `MdA-fix-notice` while builds #226 and #227 were queued. With the auto cancellation feature on, the builds #226 and #227 were automatically cancelled:
79+
For example, in the following screenshot, we pushed commit `ca31c2b` to the branch `MdA-fix-notice` while builds #226 and #227 were queued. With the auto cancellation feature on, the builds #226 and #227 were automatically canceled:
8080

8181
![Auto cancellation example](/images/autocancellation-example.png "Auto cancellation example")
8282

@@ -101,7 +101,7 @@ git:
101101
```
102102
{: data-file=".travis.yml"}
103103

104-
> Some operations on the repository, such as common automated code review scripts (e.g. Pronto for Ruby), may fail due to the limited git clone depth, not being able to access all the objects in the repository. Removing the depth flag, or running `git fetch --unshallow` might solve the issue.
104+
> Some operations on the repository, such as common automated code review scripts (e.g., Pronto for Ruby), may fail due to the limited git clone depth, not being able to access all the objects in the repository. Removing the depth flag, or running `git fetch --unshallow` might solve the issue.
105105

106106
## Git Clone Quiet
107107

@@ -190,7 +190,7 @@ Deploy keys are not currently supported by LFS, so you should use a Assembla OAu
190190

191191
### Linux
192192

193-
[Git LFS](https://git-lfs.github.com/) is supported by default on our Ubuntu Trusty, Xenial and Bionic images.
193+
[Git LFS](https://git-lfs.github.com/) is supported by default on our Ubuntu Trusty, Xenial, and Bionic images.
194194

195195
### macOS
196196

@@ -260,12 +260,13 @@ You can do this by adding:
260260
git:
261261
clone: false
262262
```
263+
{: data-file=".travis.yml"}
263264

264265
> Note that if you use this option, the `TRAVIS_COMMIT_MESSAGE` environment variable will not be defined.
265266

266267
## Set the symlinks option
267268

268-
In some cases when a repository is used for both Linux and Windows, it may be desirable to set
269+
In some cases, when a repository is used for both Linux and Windows, it may be desirable to set
269270
[core.symlinks](https://git-scm.com/docs/git-config#Documentation/git-config.txt-coresymlinks) option.
270271

271272
To do this:
@@ -274,6 +275,7 @@ To do this:
274275
git:
275276
symlinks: true
276277
```
278+
{: data-file=".travis.yml"}
277279

278280
## Build Specific Branches
279281

user/database-setup.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -371,6 +371,7 @@ addons:
371371
packages:
372372
- rabbitmq-server
373373
```
374+
{: data-file=".travis.yml"}
374375

375376
## Riak
376377

0 commit comments

Comments
 (0)