Update the common-build-problems.md #2446
Conversation
Include the information about unexpected cache missing due to the usage of exit command in the script.
There was a problem hiding this comment.
The "common build problem" here is something along the lines of "Build terminates early if I use "exit" in my script".
So the section should be rewritten with that focus and dissociated from Java and Maven (because they are irrelevant here). Other relevant symptoms (cache is not saved) can be mentioned in the text as common symptoms so that this section can be found by relevant keywords by the next guy who hits the same problem.
(There are also lots of typos.)
|
|
||
| ## Build terminates early if I use `exit` in my script | ||
|
|
||
| Check the `scrip` section in your .travis.yaml configuration file. You might have used `exit` command in the given script |
There was a problem hiding this comment.
It should be `script`.
Additionally, these two sentences are basically pointing out the same idea. Drop one.
|
|
||
| Check the `scrip` section in your .travis.yaml configuration file. You might have used `exit` command in the given script | ||
|
|
||
| i:e |
There was a problem hiding this comment.
You probably meant "for example".
Aside
The phrase "i.e." (not "i:e") is shorthand for id est, meaning "in other words" to introduce another equivalent idea afterwards, and it does not fit here.
If you do mean "for example", the abbreviation is "e.g.", but it should not start the sentence. Just write out the words.
| @@ -610,3 +610,36 @@ jobs: | |||
|
|
|||
|
|
|||
| This creates only one job, _Peanut Butter and Bread_ under the stage named _Breakfast_ as you have defined. It is important to note that in YAML, the `-` symbol is used to create a list of items and the earlier example creates a list of 2 items, while you actually wanted 1. You can read more on [How to define Build Stages](/user/build-stages/#how-to-define-build-stages) and YAML lists syntax in the official [documentation](https://yaml.org/spec/1.2/spec.html#id2759963). | |||
|
|
|||
| ## Build terminates early if I use `exit` in my script | |||
There was a problem hiding this comment.
This "problem" statement seems to anticipate the answer already. The user would be looking for the statement that matches the symptom they are seeing in the FAQ, so I suggest dropping exit.
Job terminates prematurely
|
|
||
| script: mvn clean install -Dmaven.test.skip -q -B -V | grep -v DEBUG; exit "${PIPESTATUS[0]}"; | ||
|
|
||
| cache: |
There was a problem hiding this comment.
cache directive is not essential to this example, so I suggest dropping it.
|
|
||
| ```yaml | ||
| language: java | ||
| dist: trusty |
There was a problem hiding this comment.
This is not necessary. If you insist, please use xenial instead.
Include the information about unexpected cache missing due to the usage of exit command in the script.