-### Notifications of PR builds
+### PR build notifications
By default, Hipchat will be notified both for push builds and pull request
builds.
@@ -495,7 +495,7 @@ notifications:
```
{: data-file=".travis.yml"}
-## Configuring Pushover notifications
+## Configure Pushover notifications
Notifications can also be sent via [Pushover](https://pushover.net/) via the following format:
@@ -521,7 +521,7 @@ notifications:
> travis encrypt [user_key] --add notifications.pushover.users --append
> ```
-You can also customise the notifications, like with IRC notifications:
+You can also customize the notifications, like with IRC notifications:
```yaml
notifications:
@@ -534,11 +534,11 @@ notifications:
```
{: data-file=".travis.yml"}
-Other flags, such as `on_success` and `on_failure` also work like the IRC notification config.
+Other flags, such as `on_success` and `on_failure`, also work like the IRC notification config.
Pull Request builds do not trigger Pushover notifications.
-## Configuring Slack notifications
+## Configure Slack notifications
Travis CI can send notifications to your [Slack](https://slack.com) channels
about build results.
@@ -576,7 +576,7 @@ notifications:
```
{: data-file=".travis.yml"}
-To specify a different channel when using with encrypted credentials use:
+To specify a different channel when using encrypted credentials use:
```bash
travis encrypt "
-## Configuring your Travis-CI repository
+## Configure the Travis-CI repository
In order to scan using SourceClear, add the following to your `.travis.yml` file:
From 5dc7a927f8aed43a65836fac03fd5a938c543cdd Mon Sep 17 00:00:00 2001
From: nrios14 <44674816+nrios14@users.noreply.github.com>
Date: Thu, 7 Nov 2024 09:43:14 -0400
Subject: [PATCH 016/178] Update build-feeds.md
---
user/build-feeds.md | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/user/build-feeds.md b/user/build-feeds.md
index 612352fe127..14f838e0eba 100644
--- a/user/build-feeds.md
+++ b/user/build-feeds.md
@@ -9,7 +9,7 @@ One way to get updates on your builds is an Atom feed.
You can read it in your favorite RSS reader, or programmatically consume it
with scripts.
-### Atom Feeds
+## Atom Feeds
Every repository on Travis CI has its own Atom feed, which includes all builds that were run on it, with both pull requests and normal commits.
@@ -27,9 +27,9 @@ This URL returns a JSON representation by default, but you can get the Atom feed
https://api.travis-ci.org/repos/travis-ci/travis-ci/builds.atom
```
-### Private Repositories
+## Private Repositories
-For private repositories you need a token to subscribe to
+For private repositories, you need a token to subscribe to
the feed. The API endpoint is different too: `https://api.travis-ci.com`
1. The token is the same as is used to fetch a build status image, which can be
From 300a2366b7425d48f02e73912a686a69a80e99a5 Mon Sep 17 00:00:00 2001
From: nrios14 <44674816+nrios14@users.noreply.github.com>
Date: Thu, 7 Nov 2024 09:44:50 -0400
Subject: [PATCH 017/178] Update cc-menu.md
---
user/cc-menu.md | 8 ++++----
1 file changed, 4 insertions(+), 4 deletions(-)
diff --git a/user/cc-menu.md b/user/cc-menu.md
index e791648029e..e042b77a1e0 100644
--- a/user/cc-menu.md
+++ b/user/cc-menu.md
@@ -1,5 +1,5 @@
---
-title: Using CCMenu with Travis CI
+title: Use CCMenu with Travis CI
layout: en
---
@@ -13,9 +13,9 @@ layout: en
They were originally built for use with CruiseControl, but they work just as well with Travis CI, and you can use either to poll your Travis CI repositories and have their status
show in the menu bar or tray.
-### Using the CC feed with repositories
+## Use CC feed with repositories
-Open source repositories use the URL scheme `https://api.travis-ci.org/repos/
-### Encrypting your OAUTH tokens
+## Encrypt OAUTH tokens
It is recommended that you encrypt both OAUTH tokens using the Travis CI command line client by removing them from your `travis.yml` above and running the following commands:
From bb8dc51d9f8aa229720af599c8fdd8d23ca78eda Mon Sep 17 00:00:00 2001
From: nrios14 <44674816+nrios14@users.noreply.github.com>
Date: Fri, 8 Nov 2024 12:23:01 -0400
Subject: [PATCH 084/178] Update heroku.md
---
user/deployment/heroku.md | 24 ++++++++++++------------
1 file changed, 12 insertions(+), 12 deletions(-)
diff --git a/user/deployment/heroku.md b/user/deployment/heroku.md
index bc0df76ad28..024b7790f46 100644
--- a/user/deployment/heroku.md
+++ b/user/deployment/heroku.md
@@ -32,7 +32,7 @@ travis encrypt $(heroku auth:token) --add deploy.api_key --pro
```
You can also use the Travis CI command line setup tool `travis setup heroku`.
-## Deploying Custom Application Names
+## Deploy Custom Application Names
By default, we will try to deploy to an application by the same name as the repository. For example, if you deploy an application from the GitHub repository [travis-ci/travis-chat](https://github.com/travis-ci/travis-chat) without explicitly specify the name of the application, Travis CI will try to deploy to a Heroku app named *travis-chat*.
@@ -72,9 +72,9 @@ deploy:
```
{: data-file=".travis.yml"}
-## Deploying Specific Branches
+## Deploy Specific Branches
-If you have branch specific options, as [shown above](#deploying-custom-application-names), Travis CI will automatically figure out which branches to deploy from. Otherwise, it will only deploy from your **master** branch.
+If you have branch-specific options, as [shown above](#deploying-custom-application-names), Travis CI will automatically figure out which branches to deploy from. Otherwise, it will only deploy from your **master** branch.
You can also explicitly specify the branch to deploy from with the **on** option:
@@ -97,11 +97,11 @@ deploy:
```
{: data-file=".travis.yml"}
-Builds triggered from Pull Requests will never trigger a deploy.
+Builds triggered from Pull Requests will never trigger a deployment.
-## Running Commands
+## Run Commands
-In some setups, you might want to run a command on Heroku after a successful deploy. You can do this with the **run** option:
+In some setups, you might want to run a command on Heroku after a successful deployment. You can do this with the **run** option:
```yaml
deploy:
@@ -133,7 +133,7 @@ Use an addon such as [Papertrail](https://elements.heroku.com/addons/papertrail)
These add-ons have email notification systems that can be triggered when certain string matches occur in your Heroku logs. For example you could trigger an e-mail notification if the log contains "this and all later migrations canceled".
-### Restarting Applications
+### Restart Applications
Sometimes you want to restart your Heroku application between or after commands. You can easily do so by adding a "restart" command:
@@ -148,9 +148,9 @@ deploy:
```
{: data-file=".travis.yml"}
-## Deploying build artifacts
+## Deploy build artifacts
-After your tests ran and before the deploy, Travis CI will clean up any additional files and changes you made.
+After your tests run and before the deploy, Travis CI will clean up any additional files and changes you made.
Maybe that is not what you want, as you might generate some artifacts (think asset compilation) that are supposed to be deployed, too. There is now an option to skip the clean up:
@@ -181,7 +181,7 @@ deploy:
```
{: data-file=".travis.yml"}
-#### Using `.gitignore` on `git` strategy
+#### Use the .gitignore on git strategy
When you use any of the `git` strategies, be mindful that the deployment will
honor `.gitignore`.
@@ -190,9 +190,9 @@ If your `.gitignore` file matches something that your build creates, use
[`before_deploy`](#running-commands-before-and-after-deploy) to change
its content.
-### Running commands before and after deploy
+### Run Commands Before or After Deploy
-Sometimes you want to run commands before or after deploying. You can use the `before_deploy` and `after_deploy` stages for this. These will only be triggered if Travis CI is actually deploying.
+Sometimes, you want to run commands before or after deploying. You can use the `before_deploy` and `after_deploy` stages for this. These will only be triggered if Travis CI is actually deploying.
```yaml
before_deploy: "echo 'ready?'"
From 12e3c29f10743a9bec14e61d2365971ac2a9b732 Mon Sep 17 00:00:00 2001
From: nrios14 <44674816+nrios14@users.noreply.github.com>
Date: Fri, 8 Nov 2024 12:24:05 -0400
Subject: [PATCH 085/178] Update testfairy.md
---
user/deployment/testfairy.md | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/user/deployment/testfairy.md b/user/deployment/testfairy.md
index b2c25b19017..c1749bc7a7f 100644
--- a/user/deployment/testfairy.md
+++ b/user/deployment/testfairy.md
@@ -1,5 +1,5 @@
---
-title: TestFairy deployment
+title: TestFairy Deployment
layout: en
deploy: v1
@@ -27,7 +27,7 @@ $ travis encrypt "YOUR API KEY" --add deploy.api-key
## Symbols file
-Attach your symbols mapping file so TestFairy can de-obfuscate and symbolicate crash reports automatically. Set the `symbols-file` key to your `proguard_mapping.txt` file or to a zipped `.dSYM` file.
+Attach your symbols mapping file so TestFairy can de-obfuscate and symbolize crash reports automatically. Set the `symbols-file` key to your `proguard_mapping.txt` file or to a zipped `.dSYM` file.
```yaml
deploy:
From f4559f37526332d198975190e3da1434333d58b6 Mon Sep 17 00:00:00 2001
From: nrios14 <44674816+nrios14@users.noreply.github.com>
Date: Fri, 8 Nov 2024 12:25:04 -0400
Subject: [PATCH 086/178] Update puppetforge.md
---
user/deployment/puppetforge.md | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/user/deployment/puppetforge.md b/user/deployment/puppetforge.md
index a841586dbe1..31e5122ed3b 100644
--- a/user/deployment/puppetforge.md
+++ b/user/deployment/puppetforge.md
@@ -22,7 +22,7 @@ deploy:
```
{: data-file=".travis.yml"}
-## Deploying to a custom forge
+## Deploy to a Custom Forge
To deploy to your own hosted Forge instance by adding it in the `url` key:
@@ -38,9 +38,9 @@ deploy:
```
{: data-file=".travis.yml"}
-## Running commands before and after deploy
+## Run Commands Before or After Deploy
-Sometimes you want to run commands before or after deploying. You can use
+Sometimes, you want to run commands before or after deploying. You can use
the `before_deploy` and `after_deploy` stages for this. These will only be
triggered if Travis CI is actually deploying.
From 8c0fba105a099a37000c4f9eb9b98ece1875cecf Mon Sep 17 00:00:00 2001
From: nrios14 <44674816+nrios14@users.noreply.github.com>
Date: Fri, 8 Nov 2024 14:59:57 -0400
Subject: [PATCH 087/178] Update npm.md
---
user/deployment/npm.md | 14 +++++++-------
1 file changed, 7 insertions(+), 7 deletions(-)
diff --git a/user/deployment/npm.md b/user/deployment/npm.md
index d1877604f52..ac33a8b92c8 100644
--- a/user/deployment/npm.md
+++ b/user/deployment/npm.md
@@ -36,7 +36,7 @@ $ travis setup npm
Keep in mind that the above command has to run in your project directory, so
it can modify the `.travis.yml` for you.
-## NPM auth token
+## npm Auth token
Your NPM Auth Token can be obtained by:
@@ -91,7 +91,7 @@ deploy:
Builds triggered from Pull Requests will never trigger a release.
-## Releasing build artifacts
+## Release build artifacts
After your tests ran and before the release, Travis CI will clean up any additional files and changes you made.
@@ -111,7 +111,7 @@ reported when multiple attempts are made.
We recommend deploying from only one job with
[Conditional Releases with `on:`](/user/deployment/#conditional-releases-with-on).
-## Tagging releases
+## Tag releases
You can automatically add [npm distribution tags](https://docs.npmjs.com/getting-started/using-tags) with the `tag` option:
@@ -122,7 +122,7 @@ deploy:
```
{: data-file=".travis.yml"}
-## Note on `.gitignore`
+## The .gitignore method
Notice that `npm` deployment honors `.gitignore` if `.npmignore` does not exist.
This means that if your build creates artifacts in places listed in `.gitignore`,
@@ -136,7 +136,7 @@ If your `.gitignore` file matches something that your build creates, use
its content, or create (potentially empty) `.npmignore` file
to override it.
-## Running commands before and after deploy
+## Run Commands Before or After Deploy
Sometimes you want to run commands before or after deploying. You can use the `before_deploy` and `after_deploy` stages for this. These will only be triggered if Travis CI is actually deploying.
@@ -150,9 +150,9 @@ after_deploy:
```
{: data-file=".travis.yml"}
-## Troubleshooting "npm ERR! You need a paid account to perform this action."
+## Troubleshoot npm Error
-npm assumes that [scoped packages](https://docs.npmjs.com/misc/scope) are
+If you get the error message "npm ERR! You need a paid account to perform this action." is because npm assumes that [scoped packages](https://docs.npmjs.com/misc/scope) are
private by default. You can explicitly tell npm your package is a public package
and avoid this error by adding the following to your `package.json` file:
From ff1d9f56e4c06f78272375b1661dd91c26be9566 Mon Sep 17 00:00:00 2001
From: nrios14 <44674816+nrios14@users.noreply.github.com>
Date: Fri, 8 Nov 2024 15:02:14 -0400
Subject: [PATCH 088/178] Update openshift.md
---
user/deployment/openshift.md | 12 ++++++------
1 file changed, 6 insertions(+), 6 deletions(-)
diff --git a/user/deployment/openshift.md b/user/deployment/openshift.md
index f46aedf79c6..b7596be23d6 100644
--- a/user/deployment/openshift.md
+++ b/user/deployment/openshift.md
@@ -30,7 +30,7 @@ Keep in mind that the above command has to run in your project directory, so it
To provide the best service possible, Travis CI has teamed up with OpenShift as a [partner](https://www.openshift.com/partners) and there is an official [Travis CI QuickStart](https://hub.openshift.com/quickstarts/26-travis-ci) to get you going.
-### Application to deploy
+## Deploy to Applications
By default, we will try to deploy to an application by the same name as the repository. For example, if you deploy an application from the GitHub repository [travis-ci/travis-chat](https://github.com/travis-ci/travis-chat) without explicitly specify the name of the application, Travis CI will try to deploy to an OpenShift app named *travis-chat*.
@@ -71,7 +71,7 @@ deploy:
```
{: data-file=".travis.yml"}
-### Branch to deploy from
+## Deploy Specific Branches
If you have branch specific options, as [shown above](#application-to-deploy), Travis CI will automatically figure out which branches to deploy from. Otherwise, it will only deploy from your **master** branch.
@@ -98,7 +98,7 @@ deploy:
Builds triggered from Pull Requests will never trigger a deploy.
-### Deploying build artifacts
+## Deploy build artifacts
After your tests ran and before the deploy, Travis CI will clean up any additional files and changes you made.
@@ -117,7 +117,7 @@ deploy:
You can deploy only when certain conditions are met.
See [Conditional Releases with `on:`](/user/deployment/#conditional-releases-with-on).
-### Note on `.gitignore`
+### The .gitignore method
As this deployment strategy relies on `git`, be mindful that the deployment will
honor `.gitignore`.
@@ -126,7 +126,7 @@ If your `.gitignore` file matches something that your build creates, use
[`before_deploy`](#running-commands-before-and-after-deploy) to change
its content.
-### Running commands before and after deploy
+## Run Commands Before or After Deploy
Sometimes you want to run commands before or after deploying. You can use the `before_deploy` and `after_deploy` stages for this. These will only be triggered if Travis CI is actually deploying.
@@ -140,7 +140,7 @@ after_deploy:
```
{: data-file=".travis.yml"}
-### Deployment branch
+### Deployment Branch
OpenShift can be configured to deploy from a branch different from the default `master` via `rhc app-configure --deployment-branch mybranch`.
From c8ba15f0d88b8dbb098ca76e7939c0a1321fa59e Mon Sep 17 00:00:00 2001
From: nrios14 <44674816+nrios14@users.noreply.github.com>
Date: Fri, 8 Nov 2024 15:03:57 -0400
Subject: [PATCH 089/178] Update packagecloud.md
---
user/deployment/packagecloud.md | 10 +++++-----
1 file changed, 5 insertions(+), 5 deletions(-)
diff --git a/user/deployment/packagecloud.md b/user/deployment/packagecloud.md
index f73274aeacc..24f12a47764 100644
--- a/user/deployment/packagecloud.md
+++ b/user/deployment/packagecloud.md
@@ -40,7 +40,7 @@ travis setup packagecloud
Keep in mind that the above command has to run in your project directory, so it can modify the `.travis.yml` for you.
-### Branch to release from
+### Release Branch
You can explicitly specify the branch to release from with the **on** option:
@@ -68,7 +68,7 @@ By default, Travis CI will only release from the **master** branch.
Builds triggered from Pull Requests will never trigger a release.
-### Releasing build artifacts
+### Release build artifacts
After your tests ran and before the release, Travis CI will clean up any additional files and changes you made.
@@ -105,17 +105,17 @@ deploy:
```
{: data-file=".travis.yml"}
-### A note about Debian source packages
+### Debian Source Packages
If the packagecloud provider finds any `.dsc` files, it will scan it and try to locate it's contents within
the `local-dir` directory. Ensure the source package and it's contents are output to the same directory for it to work.
-### Conditional releases
+## Conditional Releases
You can deploy only when certain conditions are met.
See [Conditional Releases with `on:`](/user/deployment/#conditional-releases-with-on).
-### Running commands before and after release
+## Run Commands Before or After Release
Sometimes you want to run commands before or after releasing a package. You can use the `before_deploy` and `after_deploy` stages for this. These will only be triggered if Travis CI is actually pushing a release.
From f69cf880fba8e0106ca772d4805e193fd6575f8c Mon Sep 17 00:00:00 2001
From: nrios14 <44674816+nrios14@users.noreply.github.com>
Date: Fri, 8 Nov 2024 15:05:23 -0400
Subject: [PATCH 090/178] Update scalingo.md
---
user/deployment/scalingo.md | 10 +++++-----
1 file changed, 5 insertions(+), 5 deletions(-)
diff --git a/user/deployment/scalingo.md b/user/deployment/scalingo.md
index 74b86db039d..dbfd0a8df26 100644
--- a/user/deployment/scalingo.md
+++ b/user/deployment/scalingo.md
@@ -1,5 +1,5 @@
---
-title: Scalingo deployment
+title: Scalingo Deployment
layout: en
deploy: v1
@@ -18,7 +18,7 @@ Chose one of two ways to connect to your Scalingo account:
-## Connecting using a username and password
+## Connect with Username and Password
Add your Scalingo username and your [encrypted](/user/encryption-keys/#usage)
Scalingo password to your `.travis.yml`:
@@ -32,7 +32,7 @@ deploy:
```
{: data-file=".travis.yml"}
-## Connecting using an api key
+## Connect with an API key
Add your [encrypted](/user/encryption-keys/#usage)
Scalingo `api_key` to your `.travis.yml`:
@@ -45,7 +45,7 @@ deploy:
```
{: data-file=".travis.yml"}
-## Optional settings
+## Optional Settings
* `remote`: Remote url or git remote name of your git repository. The default
remote name is "scalingo".
@@ -55,7 +55,7 @@ deploy:
remote. Specifying the `app` will add a remote to your local repository: `git
remote add -## Beta opt-in +## The opt-in option You can opt in using the repository setting "Build config validation" in the Travis CI UI, or by specifying the `version` in your `.travis.yml` file: @@ -20,7 +20,7 @@ version: ~> 1.0 ``` {: data-file=".travis.yml"} -## Build config validation +## Build Config Validation When active the [build config validation](https://github.com/travis-ci/travis-yml) feature will validate and normalize any incoming build config sources (e.g. @@ -52,7 +52,7 @@ The messages have 4 severity levels: * `warn` - The build config contains mistakes that our system can repair. It is safe to ignore these messages. * `info` - The build config parser has made changes to the config that you might want to be informed of. It is safe to ignore these messages. -## Validation message types +## Types of Validation messages This table lists build config validation message types, and explains how to respond to these messages. From 1609fc069f49eb5206a1a3b1f19c5ea7cd0f838c Mon Sep 17 00:00:00 2001 From: nrios14 <44674816+nrios14@users.noreply.github.com> Date: Fri, 8 Nov 2024 16:51:25 -0400 Subject: [PATCH 112/178] Update cron-jobs.md --- user/cron-jobs.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/user/cron-jobs.md b/user/cron-jobs.md index 5715d952f57..e26e725b517 100644 --- a/user/cron-jobs.md +++ b/user/cron-jobs.md @@ -15,7 +15,7 @@ Configure cron jobs from the "Cron Jobs" settings tab on your Travis CI page. {{ site.data.snippets.ghlimit }} -## Adding Cron Jobs +## Add Cron Jobs Select the branch to run the build on, how often to run the build, and whether to run the build if there was a build in the last 24 hours, then click "Add": @@ -25,17 +25,17 @@ Confirm that the cron job is displayed in your settings tab:  -## Skipping Cron Jobs +## Skip Cron Jobs Please note that cron jobs will run regardless and cannot be skipped even with [ci skip] in the latest commit message. -## Deleting Cron Jobs +## Delete Cron Jobs -Click the small trash icon on the right hand side of the page: +Click the small trash icon on the right-hand side of the page:  -## Detecting Builds Triggered by Cron +## Detect Builds Triggered by Cron To check whether a build was triggered by cron, examine the `TRAVIS_EVENT_TYPE` environment variable to see if it has the value `cron`. From ac96fbb0f827137d3bc5d1beb8338a1294bac489 Mon Sep 17 00:00:00 2001 From: nrios14 <44674816+nrios14@users.noreply.github.com> Date: Fri, 8 Nov 2024 16:53:06 -0400 Subject: [PATCH 113/178] Update docker.md --- user/docker.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/user/docker.md b/user/docker.md index dd05e731e99..0671e6fa270 100644 --- a/user/docker.md +++ b/user/docker.md @@ -1,5 +1,5 @@ --- -title: Using Docker in Builds +title: Use Docker in Builds layout: en --- @@ -24,9 +24,9 @@ examples. > We do not currently support use of Docker on macOS. -> For information on how to use Docker on Travis CI Enterprise check out [Enabling Docker Builds](/user/enterprise/build-images/#enabling-docker-builds). +> For information on how to use Docker on Travis CI Enterprise, check out [Enabling Docker Builds](/user/enterprise/build-images/#enabling-docker-builds). -## Using a Docker Image from a Repository in a Build +## Use a Docker Image from a Repository This [example repository](https://github.com/travis-ci/docker-sinatra) runs two Docker containers built from the same image: @@ -84,7 +84,7 @@ Finished in 0.022952763 seconds. 43.57 tests/s, 43.57 assertions/s ``` -## Building a Docker Image from a Dockerfile +## Build a Docker Image from a Dockerfile Instead of downloading the Docker image from [carlad/sinatra](https://registry.hub.docker.com/u/carlad/sinatra/) you can @@ -117,7 +117,7 @@ script: ``` {: data-file=".travis.yml"} -## Pushing a Docker Image to a Registry +## Push a Docker Image to a Registry To push an image to a Docker registry, one must first authenticate via `docker login`. The email, username, and password used for login should be stored in @@ -139,7 +139,7 @@ Within your `.travis.yml` prior to attempting a `docker push` or perhaps before echo "$DOCKER_PASSWORD" | docker login -u "$DOCKER_USERNAME" --password-stdin ``` -### Branch Based Registry Pushes +### Branch-Based Registry Pushes To push a particular branch of your repository to a remote registry, use the custom deploy section of your `.travis.yml`: @@ -172,7 +172,7 @@ When pushing to a private registry, be sure to specify the hostname in the echo "$DOCKER_PASSWORD" | docker login -u "$DOCKER_USERNAME" --password-stdin registry.example.com ``` -## Using Docker Compose +## Use the Docker Compose The [Docker Compose](https://docs.docker.com/compose/) tool is also [installed in the Docker enabled environment](/user/reference/trusty/#docker). @@ -191,7 +191,7 @@ before_install: ``` {: data-file=".travis.yml"} -## Installing a newer Docker version +## Install a newer Docker version You can upgrade to the latest version and use any new Docker features by manually updating it in the `before_install` step of your `.travis.yml`: From f5b07abf4fdd43eaa66bcad55154868ee69c9096 Mon Sep 17 00:00:00 2001 From: nrios14 <44674816+nrios14@users.noreply.github.com> Date: Fri, 8 Nov 2024 17:01:02 -0400 Subject: [PATCH 114/178] Update pull-requests.md --- user/pull-requests.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/user/pull-requests.md b/user/pull-requests.md index a58045f518e..ef7694389d6 100644 --- a/user/pull-requests.md +++ b/user/pull-requests.md @@ -1,5 +1,5 @@ --- -title: Building Pull Requests +title: Build Pull Requests layout: en --- @@ -36,7 +36,7 @@ Travis CI makes encrypted variables and data available only to pull requests com Pull requests sent from forked repositories do not have access to encrypted variables or data even if these are defined in the fork source project unless certain repository settings in Travis CI aren't set. -### Repository settings - forks +### Fork Repository settings {{ site.data.snippets.git_repository_settings_forks_general }} @@ -58,7 +58,7 @@ script: ``` {: data-file=".travis.yml"} -## My Pull Request isn't being built +## Pull Request does not build If a pull request isn't built or doesn't show up in Travis CI's user interface, that usually means that it can't be merged. We rely on the merge commit that GitHub transparently creates between the changes in the source branch and the upstream branch the pull request is sent against. @@ -78,13 +78,13 @@ The command "eval git fetch origin +refs/pull/994/merge: " failed Restoring the branch of a merged pull request will not trigger a build, nor will pushing a new commit to a branch that has already been merged. -## 'Double builds' on pull requests +## Double builds on pull requests If you see two build status icons on your GitHub pull request, it means there is one build for the branch, and one build for the pull request itself (actually the build for the merge of the head branch with the base branch specified in the pull request). [Build pushed branches](/user/web-ui/#build-pushed-branches) and [Build pushed pull requests](/user/web-ui/#build-pushed-pull-requests) control this behaviour. -## See Also +## Further Reading * [Building only the latest commit](/user/customizing-the-build/#building-only-the-latest-commit) * [Building specific branches](/user/customizing-the-build/#building-specific-branches) From 2c34ab85da62961514c32afeb3025a92f9da6bad Mon Sep 17 00:00:00 2001 From: nrios14 <44674816+nrios14@users.noreply.github.com> Date: Fri, 8 Nov 2024 17:21:43 -0400 Subject: [PATCH 115/178] Update common-build-problems.md --- user/common-build-problems.md | 74 ++++++++++++++++++----------------- 1 file changed, 38 insertions(+), 36 deletions(-) diff --git a/user/common-build-problems.md b/user/common-build-problems.md index 59b8b6e6c26..9c890bc75ab 100644 --- a/user/common-build-problems.md +++ b/user/common-build-problems.md @@ -9,7 +9,7 @@ redirect_from: -## My tests broke but were working yesterday +## Broken Tests that previously worked A very common cause when a test is suddenly breaking without any major code changes involved is a change in upstream dependencies. @@ -33,9 +33,9 @@ version. * Additionally, we update our build environment regularly, which brings in newer versions of languages and the running services. -## My build script is killed without any error +## The build script is killed without any errors -Sometimes, you'll see a build script causing an error and the message in +Sometimes, you'll see a build script causing an error, and the message in the log will be something like `Killed`. This is usually caused by the script or one of the programs it runs exhausting @@ -47,7 +47,7 @@ Depending on the tool in use, this can be caused by a few things: - Ruby test suite consuming too much memory - Tests running in parallel using too many processes or threads (e.g. using the `parallel_test` gem) -- g++ needing too much memory to compile files, for instance with a lot of +- g++ needing too much memory to compile files, for instance, with a lot of templates included. ### Parallel processes @@ -63,7 +63,7 @@ likely to show similar causes. It can be caused by memory leaks or by custom settings for the garbage collector, for instance to delay a sweep for as long as possible. Dialing these numbers down should help. -## My build fails unexpectedly +## Unexpected Build Failures One possible cause for builds failing unexpectedly can be calling `set -e` (also known as `set errexit`), either *directly in* your `.travis.yml`, or `source`ing a script which does. This causes any error causing a non-zero return status in your script to stop and fail the build immediately. @@ -74,7 +74,7 @@ See also [Complex Build Steps](/user/customizing-the-build/#implementing-complex Another reason could be that the repo setting **Clone or import** is set to `OFF.` In this case, no information from the repository is shared and it is possible some builds using private dependencies between repos can break. If you want to avoid the situation when all of your repositories stop sharing dependencies, please go to the repository settings and explicitly set **Clone or Import** to `ON.` In this case, your builds keep running as usual. -## Segmentation faults from the language interpreter (Ruby, Python, PHP, Node.js, etc.) +## Segmentation faults from the language interpreter If your build is failing due to unexpected segmentation faults in the language interpreter, this may be caused by corrupt or invalid caches of your extension codes (gems, modules, etc). This can happen with any interpreted language, such as Ruby, Python, PHP, Node.js, etc. @@ -82,7 +82,7 @@ Fix the problem by * clearing the cache or * removing the cache key from your .travis.yml (you can add it back in a subsequent commit). -## **Ruby**: RSpec returns 0 even though the build failed +## **Ruby**: RSpec returns 0 when the build failed In some scenarios, when running `rake rspec` or even rspec directly, the command returns 0 even though the build failed. This is commonly due to some RubyGem @@ -110,7 +110,7 @@ If your project is using the [Code Climate integration](/user/code-climate/) or Simplecov, this issue can also come up with the 0.8 branch of Simplecov. The fix is to downgrade to the last 0.7 release until the issue is fixed. -## **Capybara**: I'm getting errors about elements not being found +## **Capybara**: Not found elements Errors In scenarios that involve JavaScript, you can occasionally see errors that indicate that an element is missing, a button, a link, or some other resource @@ -138,14 +138,14 @@ If you're still seeing timeouts after increasing it initially, set it to something much higher for one test run. Should the error still persist, there's possibly a deeper issue on the page, for instance compiling the assets. -## **Ruby**: Installing the debugger_ruby-core-source library fails +## **Ruby**: debugger_ruby-core-source library installation fails -This Ruby library unfortunately has a history of breaking with even patchlevel +This Ruby library, unfortunately, has a history of breaking with even patch-level releases of Ruby. It's commonly a dependency of libraries like linecache or other Ruby debugging libraries. We recommend moving these libraries to a separate group in your Gemfile and then -to install RubyGems on Travis CI without this group. As these libraries are only +installing RubyGems on Travis CI without this group. As these libraries are only useful for local development, you'll even gain a speedup during the installation process of your build. @@ -161,9 +161,9 @@ end bundler_args: --without development debug ``` -## **Ruby**: Tests frozen and cancelled after 10 minute log silence +## **Ruby**: Tests frozen and canceled -In some cases, the use of the `timecop` gem can result in seemingly sporadic +In some cases, tests get frozen and then canceled after 10 minutes of log silence. The use of the `timecop` gem can result in seemingly sporadic "freezing" due to issues with ordering calls of `Timecop.return`, `Timecop.freeze`, and `Timecop.travel`. For example, if using RSpec, be sure to have a `Timecop.return` configured to run *after* all examples: @@ -179,7 +179,7 @@ end ## **Mac**: macOS Mavericks (10.9) Code Signing Errors -With Mavericks quite a lot has changed in terms of code signing and the keychain application. +With Mavericks, quite a lot has changed in terms of code signing and the keychain application. Signs of issues can be error messages stating that an identity can't be found and that "User interaction is not allowed." @@ -311,7 +311,7 @@ You can also have more details in [this GitHub issue](https://github.com/travis- ## **Mac**: Errors running CocoaPods -CocoaPods usage can fail for a few reasons currently. +CocoaPods usage can currently fail for a few reasons. ### Newer version of CocoaPods required @@ -324,7 +324,7 @@ before_install: ``` {: data-file=".travis.yml"} -### CocoaPods can't be found +### CocoaPods cannot be found CocoaPods isn't currently installed on all available Rubies, which unfortunately means it will fail when using the default Ruby, which is 2.0.0. @@ -350,14 +350,14 @@ rvm: 1.9.3 ``` {: data-file=".travis.yml"} -## **System**: Required language pack isn't installed +## **System**: Required language pack not installed The Travis CI build environments currently have only the en_US language pack -installed. If you get an error similar to : "Error: unsupported locale +installed. If you get an error similar to: "Error: unsupported locale setting", then you may need to install another language pack during your test run. -This can be done with the follow addition to your `.travis.yml`: +This can be done with the following addition to your `.travis.yml`: ```yaml before_install: @@ -380,7 +380,7 @@ addons: ``` {: data-file=".travis.yml"} -## **Linux**: apt fails to install package with 404 error +## **Linux**: apt fails to install the package with 404 error This is often caused by old package database and can be fixed by adding the following to `.travis.yml`: @@ -390,12 +390,12 @@ before_install: ``` {: data-file=".travis.yml"} -## **Windows**: common build problems and known issues +## **Windows**: Common build problems and Known issues -For a list of common build problems on Windows, known issues and workarounds, please visit the [Travis CI community forum].(https://travis-ci.community/t/current-known-issues-please-read-this-before-posting-a-new-topic/264). +For a list of common build problems on Windows, known issues, and workarounds, please visit the [Travis CI community forum].(https://travis-ci.community/t/current-known-issues-please-read-this-before-posting-a-new-topic/264). The [Travis CI community forum](https://travis-ci.community) provides better visibility on the issues customers are running into and how to solve them. -## Travis CI does not preserve the state between builds +## Travis CI not preserving the state between builds Travis CI uses virtual machine snapshotting to make sure no state is preserved between builds. If you modify the CI environment by writing something to a data store, creating @@ -407,7 +407,7 @@ Travis CI runs all commands over SSH in isolated virtual machines. Commands that modify SSH session states are "sticky" and persist throughout the build. For example, if you `cd` into a directory, all subsequent commands are run from that directory. -## Git submodules are not updated correctly +## Git submodules not updating correctly Travis CI automatically initializes and updates submodules when there's a `.gitmodules` file in the root of the repository. @@ -447,7 +447,7 @@ https://github.com/someuser/somelibrary.git Otherwise, Travis CI builders won't be able to clone your project because they don't have your private SSH key. -## My builds are timing out +## Builds time out Builds can unfortunately time out, either during installation of dependencies or during the build itself, for instance because of a command that's taking a longer amount of time to run while not producing any output. @@ -490,7 +490,7 @@ does work in the [other steps](/user/job-lifecycle/). ### Build times out because no output was received -When a long running command or compile step regularly takes longer than 10 minutes without producing any output, you can adjust your build configuration to take that into consideration. +When a long-running command or compile step regularly takes longer than 10 minutes without producing any output, you can adjust your build configuration to take that into consideration. The shell environment in our build system provides a function that helps to work around that, at least for longer than 10 minutes. @@ -515,13 +515,13 @@ Continuing the example above to extend the waiting time to 30 minutes: > We recommend to carefully use `travis_wait`, as overusing it can extend your build time when there could be a deeper underlying issue. When in doubt, [email us](mailto:support@travis-ci.com) first to see if something could be improved about this particular command first. -#### Limitations of `travis_wait` +#### Limitations of travis_wait `travis_wait` works by starting a process, sending it to the background, and watching the background process. If the command you pass to `travis_wait` does not persist, then `travis_wait` does not extend the timeout. -## Running builds in debug mode +## Run builds in debug mode In private repositories and those public repositories for which the feature is enabled, it is possible to run builds and jobs in debug mode. @@ -529,7 +529,7 @@ Using this feature, you can interact with the live VM where your builds run. For more information, please consult [the debug VM documentation](/user/running-build-in-debug-mode/). -## Log length exceeded +## Exceed Log length The log for each build is limited to approximately 4 MB. When it reaches that length, the build is terminated and you'll see the following message at the end of your build log: @@ -539,7 +539,7 @@ The log length has exceeded the limit of 4 Megabytes (this usually means that te The build has been terminated. ``` -## FTP/SMTP/other protocol do not work +## FTP and SMTP Protocols do not work Some protocols such as FTP and SMTP are not directly supported due to the infrastructure requirements in place for security and fair usage. Using @@ -559,7 +559,7 @@ before_install: {: data-file=".travis.yml"} -## I pushed a commit and can't find its corresponding build +## Pushing a commit and not finding the build The build request events that Travis CI receives are listed in your repository's Requests page. You can find it under the **More Options** dropdown menu, choosing **Requests**. @@ -578,22 +578,22 @@ If a build hasn't been triggered for your commit, these are the possible build r > Please note that Travis CI does not receive a Webhook event when more than three commits are tagged. So if you do `git push --tags`, and more than three tags that are present locally, are not known on GitHub, Travis will not be told about any of those events, and the tagged commits will not be built. -## I'm running out of disk space in my build +## Build running out of disk space Approximate available disk space is listed in the [build environment overview](/user/reference/overview/#virtualisation-environment-vs-operating-system). The best way to find out what is available on your specific image is to run `df -h` as part of your build script. If you need a bit more space in your Ubuntu builds, we recommend using `language: minimal`, which will route you to a base image with less tools and languages preinstalled. This image has approximately ~24GB of free space. -## Uploading artifacts to sonatype +## Upload artifacts to sonatype When publishing via the `nexus-staging-maven-plugin` to Sonatype OSS Repository, IP addresses used by TravisCI change due to our [NAT layer](https://travis-ci.com/blog/2018-07-23-the-tale-of-ftp-at-travis-ci). To get around this, please use a `stagingProfileId` as [explained in this document](https://travis-ci.community/t/sonatype-deployment-problems/1353/2?u=mzk). -## Travis CLI does not recognize my valid Github token +## Travis CLI does not recognize my valid GitHub token When using the [Travis CLI tool](https://github.com/travis-ci/travis.rb#readme) to interact with the Travis CI platform, if you receive an `insufficient_oauth_permissions` error or similar, please ensure the Github Token supplied via `--github-token` has **repo** scope as [explained in this document](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). -## Duplicate/Unknown job shows up in my build +## Unknown or Duplicate jobs in a build When specifying stages, users often unknowingly add an implicit job to the list of jobs in a stage using YAML that is otherwise syntactically correct. @@ -631,7 +631,9 @@ This creates only one job, _Peanut Butter and Bread_ under the stage named _Bre When adding custom setup instructions to a NodeJS build, add them in the `before_script` phase and not before _dependencies are installed_. The `before_script` phase is the safest place to add custom setup scripts. Symptoms of this problem include previously succeeding builds suddenly failing due to the addition of a new dependency. -## **Node**: NPM/YARN throw ***Error: connect ENETUNREACH*** or build hangs in the install phase i.e. `npm install` or `yarn install` for NodeJs versions 16+ on LXD images (ppc64le, arm64 and s390x) +## **Node**: NPM or YARN connect ENETUNREACH Error + +If using NPM or YARN, the ***Error: connect ENETUNREACH*** shows or the build hangs in the install phase, i.e., `npm install` or `yarn install` for NodeJs versions 16+ on LXD images (ppc64le, arm64, and s390x). This seems to be a known bug and the details can be reviewed at https://github.com/npm/cli/issues/4163. Add the following to resolve the issue: From 7de9ad5f9145279939f27b286002bbefb55ad865 Mon Sep 17 00:00:00 2001 From: nrios14 <44674816+nrios14@users.noreply.github.com> Date: Fri, 8 Nov 2024 17:30:31 -0400 Subject: [PATCH 116/178] Update gui-and-headless-browsers.md --- user/gui-and-headless-browsers.md | 34 +++++++++++++++---------------- 1 file changed, 17 insertions(+), 17 deletions(-) diff --git a/user/gui-and-headless-browsers.md b/user/gui-and-headless-browsers.md index 5ed1545daef..c908d5e6eaa 100644 --- a/user/gui-and-headless-browsers.md +++ b/user/gui-and-headless-browsers.md @@ -6,13 +6,11 @@ layout: en -## What This Guide Covers - This guide covers headless GUI & browser testing using tools provided by the Travis [CI environment](/user/reference/precise/). Most of the content is technology-neutral and does not cover all the details of specific testing tools (like Poltergeist or Capybara). We recommend you start with the [Onboarding](/user/onboarding/) and [Build Configuration](/user/customizing-the-build/) guides before reading this one. -## Using Sauce Labs +## Work with Sauce Labs -[Sauce Labs](https://saucelabs.com) provides a Selenium cloud with access to more than 170 different device/OS/browser combinations. If you have browser tests that use Selenium, using Sauce Labs to run the tests is very easy. First, you need to sign up for their service (it's free for open source projects). +[Sauce Labs](https://saucelabs.com) provides a Selenium cloud with access to more than 170 different device/OS/browser combinations. If you have browser tests that use Selenium, using Sauce Labs to run the tests is very easy. First, you need to sign up for their service (it's free for open-source projects). Once you've signed up, set up a tunnel using Sauce Connect so Sauce Labs can connect to your web server. Our [Sauce Connect addon](/user/sauce-connect/) makes this easy, just add this to your .travis.yml: @@ -51,14 +49,14 @@ capabilities["tags"] = [os.environ["TRAVIS_PYTHON_VERSION"], "CI"] For travis-web, our very own website, we use Sauce Labs to run browser tests on multiple browsers. We use environment variables in our [.travis.yml](https://github.com/travis-ci/travis-web/blob/15dc5ff92184db7044f0ce3aa451e57aea58ee19/.travis.yml#L14-15) to split up the build into multiple jobs, and then pass the desired browser into Sauce Labs using [desired capabilities](https://github.com/travis-ci/travis-web/blob/15dc5ff92184db7044f0ce3aa451e57aea58ee19/script/saucelabs.rb#L9-13). On the Travis CI side, it ends up looking like [this](https://travis-ci.org/travis-ci/travis-web/builds/12857641). -## Using xvfb to Run Tests That Require a GUI +## Run GUI Tests with xvfb To run tests requiring a graphical user interface on Travis CI, use `xvfb` (X Virtual Framebuffer) to imitate a display. If you need a browser, you can use Firefox (either with the pre-installed version, or the [addon](/user/firefox)) or Google Chrome (with the [addon](/user/chrome), on Linux Trusty or macOS). -### Using `services:` +### Use services: on your script > This only works on Ubuntu 16.04 (Xenial) and later on releases i.e. with `dist: xenial` or `dist: bionic` @@ -72,7 +70,7 @@ services: ``` {: data-file=".travis.yml"} -### Using the xvfb-run wrapper +### How to use the xvfb-run wrapper `xvfb-run` is a wrapper for invoking `xvfb` so that `xvfb` can be used with less fuss: @@ -89,7 +87,7 @@ script: xvfb-run --server-args="-screen 0 1024x768x24" make test ``` {: data-file=".travis.yml"} -### Using xvfb directly +### Direct use of xvfb > This is recommended on Ubuntu 14.04 (Trusty) i.e. with `dist: trusty`. For `dist: xenial`, use the `services` keyword described [above](/user/gui-and-headless-browsers/#using-services). @@ -121,7 +119,7 @@ before_install: See [xvfb manual page](http://www.xfree86.org/4.0.1/Xvfb.1.html) for more information. -### Starting a Web Server +### Start a Web Server @@ -148,10 +146,10 @@ Note that@@ -117,7 +117,7 @@ See the example below for reference. Perforce and SVN builds are currently **available only for Linux Ubuntu** and standard amd64 CPU architecture build environments, starting from the Bionic Beaver Ubuntu distribution. -## Switching Accounts +## Switch Accounts You can easily switch between your cloud platform provider accounts: @@ -127,7 +127,7 @@ You can easily switch between your cloud platform provider accounts:  -## Selecting a different programming language +## Select a different programming language Use one of these common languages: From b241fd868a1ac3c321c564c9b0359cbfb6416fee Mon Sep 17 00:00:00 2001 From: nrios14 <44674816+nrios14@users.noreply.github.com> Date: Fri, 8 Nov 2024 16:41:25 -0400 Subject: [PATCH 109/178] Update customizing-the-build.md --- user/customizing-the-build.md | 66 +++++++++++++++++------------------ 1 file changed, 33 insertions(+), 33 deletions(-) diff --git a/user/customizing-the-build.md b/user/customizing-the-build.md index ce4134576be..0381350e7d4 100644 --- a/user/customizing-the-build.md +++ b/user/customizing-the-build.md @@ -1,5 +1,5 @@ --- -title: Customizing the Build +title: Customize the Build layout: en redirect_from: @@ -12,7 +12,7 @@ redirect_from: Builds on Travis CI are configured mostly through the build configuration stored in the file `.travis.yml` in your repository. This allows your -configuration to be version controlled and flexible. +configuration to be version-controlled and flexible. For advanced use cases the main build configuration file `.travis.yml` can import other, shared config sources using the [Build Config Imports](/user/build-config-imports/) @@ -50,7 +50,7 @@ The [Build Lifecycle documentation](/user/job-lifecycle/) now has its own page. {: #Build-Lifecycle} -## Limiting Concurrent Jobs +## Limit Concurrent Jobs {{ site.data.snippets.concurrent_jobs }} @@ -65,9 +65,9 @@ Or using the command line client: $ travis settings maximum_number_of_builds --set 1 ``` -## Building Only the Latest Commit +## Build the Latest Commit only -If you are only interested in building the most recent commit on each branch you can use this new feature to automatically cancel older builds in the queue that are *not yet running*. Existing builds will be allowed to finish. +If you are only interested in building the most recent commit on each branch, you can use this new feature to automatically cancel older builds in the queue that are *not yet running*. Existing builds will be allowed to finish. The *Auto Cancellation Setting* is in the *Settings* tab of each repository, and you can enable it separately to: * *Auto cancel branch builds* - cancels queued builds in your branch and appears in the *Build History* tab of your repository. @@ -128,7 +128,7 @@ git: ## Git LFS -### Authentication with GitHub +### GitHub Authentication We recommend using a read-only GitHub OAuth token to authenticate when using [Git LFS](https://git-lfs.github.com/): @@ -143,7 +143,7 @@ This authentication is required when connecting to private repositories, and pre Deploy keys are not currently supported by LFS, so you should use a GitHub OAuth token to authenticate as in the example above. -### Authentication with Bitbucket +### Bitbucket Authentication We recommend using a read-only Bitbucket OAuth token to authenticate when using [Git LFS](https://git-lfs.github.com/): @@ -158,7 +158,7 @@ This authentication is required when connecting to private repositories, and pre Deploy keys are not currently supported by LFS, so you should use a Bitbucket OAuth token to authenticate as in the example above. -### Authentication with GitLab +### GitLab Authentication We recommend using a read-only GitLab OAuth token to authenticate when using [Git LFS](https://git-lfs.github.com/): @@ -173,7 +173,7 @@ This authentication is required when connecting to private repositories, and pre Deploy keys are not currently supported by LFS, so you should use a GitLab OAuth token to authenticate as in the example above. -### Authentication with Assembla +### Assembla Authentication We recommend using a read-only Assembla OAuth token to authenticate when using [Git LFS](https://git-lfs.github.com/): @@ -234,12 +234,12 @@ git: where `skip-worktree-map-file` is a path to the existing file in the current repository with data you'd like to put into `$GIT_DIR/info/sparse-checkout` file of [format described in Git documentation](https://git-scm.com/docs/git-read-tree#_sparse_checkout). -## Git End of Line Conversion Control +## Git End-of-Line Conversion Control Travis CI clones repositories with platform-dependent [core.autocrlf](https://git-scm.com/docs/git-config#Documentation/git-config.txt-coreautocrlf) behavior. This behavior can be modified via the autocrlf attribute in `.travis.yml`. Valid values are `true`, `false` and `input`. -To clone your repository without end of line conversion, add: +To clone your repository without end-of-line conversion, add: ```yaml git: @@ -250,7 +250,7 @@ git: This is equivalent to [`git config --global core.autocrlf input`](https://git-scm.com/docs/git-config#Documentation/git-config.txt-coreautocrlf) prior to cloning the repository. -## Disabling git clone +## Disable git clone In some workflows, like [build stages](https://docs.travis-ci.com/user/build-stages/#what-are-build-stages), it might be beneficial to skip the automatic `git clone` step. @@ -263,7 +263,7 @@ git: > Note that if you use this option, the `TRAVIS_COMMIT_MESSAGE` environment variable will not be defined. -## Setting symlinks option +## Set the symlinks option In some cases when a repository is used for both Linux and Windows, it may be desirable to set [core.symlinks](https://git-scm.com/docs/git-config#Documentation/git-config.txt-coresymlinks) option. @@ -275,13 +275,13 @@ git: symlinks: true ``` -## Building Specific Branches +## Build Specific Branches Travis CI uses the `.travis.yml` file from the branch containing the Git commit that triggers the build. Include branches using a safelist, or exclude them using a blocklist. > Note that you also need to take into account automatic [Pull Request Builds](/user/pull-requests/#double-builds-on-pull-requests) when deciding to safelist or blocklist certain branches. -### Safelisting or Blocklisting Branches +### Safelist or Blocklist Branches Specify which branches to build using a safelist, or blocklist branches that you do not want to be built: @@ -316,7 +316,7 @@ branches: > Note that for historical reasons `.travis.yml` needs to be present *on all active branches* of your project. -### Using Regular Expressions +### Regular Expressions You can use regular expressions to safelist or blocklist branches: @@ -333,7 +333,7 @@ Any name surrounded with `/` in the list of branches is treated as a regular exp Options that are specified after the last `/` (e.g., `i` for case insensitive matching) are not supported but can be given inline instead. For example, `/^(?i:deploy)-.*$/` matches `Deploy-2014-06-01` and other branches and tags that start with `deploy-` in any combination of cases. -## Skipping a Build +## Skip a Build If you don't want to run a build for a particular commit for any reason, you may instruct Travis CI to skip building this commit via a command in the commit message. @@ -354,7 +354,7 @@ For example, Note that in case multiple commits are pushed together, the skip command is effective only if present in the commit message of the HEAD commit. -## Build matrix +## Build Matrix You can also define exclusions to the build matrix: @@ -372,7 +372,7 @@ jobs: > All build matrixes are currently limited to a maximum of **200 jobs** for both private and public repositories. If you are on an open-source plan, please remember that Travis CI provides this service free of charge to the community. So please only specify the matrix you *actually need*. -### Naming Jobs within Matrices +### Name Jobs within Matrices You can define names for specific jobs within a matrix. We recommend unique job names, but do not enforce it (though this may change in the future). Jobs defined in the `matrix.include` @@ -397,7 +397,7 @@ script: ./test.py $TEST_SUITE Jobs that are generated by matrix expansion cannot be given name attributes. -### Excluding Jobs +### Exclude Jobs If the jobs you want to exclude from the build matrix share the same matrix parameters, you can specify only those and omit the varying parts. @@ -450,7 +450,7 @@ jobs: ``` {: data-file=".travis.yml"} -#### Excluding Jobs with `env` Value +#### Exclude Jobs with the env Value When excluding jobs with `env` values, the value must match _exactly_. @@ -500,7 +500,7 @@ jobs: ``` {: data-file=".travis.yml"} -### Explicitly Including Jobs +### Explicitly Included Jobs It is also possible to include entries into the matrix with `matrix.include`: @@ -541,7 +541,7 @@ keys defined. In this example with a 3-job Python build matrix, each job in `matrix.include` has the `python` value set to `'3.8'`. -You can explicitly set the python version for a specific entry: +You can explicitly set the Python version for a specific entry: ```yaml language: python @@ -559,13 +559,13 @@ script: env $EXTRA_TESTS ./test.py $TEST_SUITE ``` {: data-file=".travis.yml"} -### Jobs That Are Allowed to Fail +### Intentionally allow Jobs to Fail You can define jobs that are allowed to fail in the build matrix. Allowed failures are jobs in your build matrix that are allowed to fail without causing the entire build to fail. This lets you add in experimental and -preparatory builds, for example to test against runtime versions or +preparatory builds, for example, to test against runtime versions or configurations that you are not ready to officially support. Define allowed failures in the build matrix as key/value pairs: @@ -577,7 +577,7 @@ jobs: ``` {: data-file=".travis.yml"} -#### Conditionally Allowing Jobs to Fail +#### Conditionally allow Jobs to Fail Allowed failures can include a [condition](/user/conditional-builds-stages-jobs/#conditionally-allowing-jobs-to-fail) using the key `if`. @@ -592,14 +592,14 @@ jobs: ``` {: data-file=".travis.yml"} -#### Matching Jobs with `allow_failures` +#### Matching Jobs with the allow_failures attribute When matching jobs against the definitions given in `allow_failures`, _all_ attributes specified on an entry in `allow_failures` must be met exactly, and all the keys in `allow_failures` element must exist in the top level of the build matrix (i.e., not in `matrix.include`). -##### `allow_failures` Examples +#### allow_failures Examples Consider @@ -644,7 +644,7 @@ jobs: Without the top-level `env`, no job will be allowed to fail. -### Fast Finishing +### Use a Fast Finish If some jobs in the build matrix are allowed to fail, the build won't be marked as finished until they have completed. @@ -658,7 +658,7 @@ jobs: Now, the build result will be determined as soon as all the required jobs finish, based on these results, while the rest of the `allow_failures` jobs continue to run. -## Installing a Second Programming Language +## Install a Second Programming Language If you need to install a second programming language in your current build environment, you can do so in the `before_install` stage of the build. @@ -682,7 +682,7 @@ before_install: It's also possible to use other language installation methods such as `apt-get`, `pyenv` for Python, `nvm` for Node.js, etc. -## Implementing Complex Build Steps +## Implement Complex Build Steps If you have a complex build environment that is hard to configure in the `.travis.yml`, consider moving the steps into a separate shell script. The script can be a part of your repository and can easily be called from the `.travis.yml`. @@ -703,13 +703,13 @@ addons: ``` {: data-file=".travis.yml"} -## What Repository Providers or Version Control Systems Can I Use? +## Repository Providers and Version Control Systems Build and test your open source and private repositories hosted on GitHub on [travis-ci.com](https://travis-ci.com/). Travis CI can also integrates with Atlassian [Bitbucket](https://bitbucket.org/), [GitLab](https://about.gitlab.com/) and Assembla (https://www.assembla.com/). Travis CI currently does not support git repositories hosted on other version control systems such as Mercurial. -## What YAML Version Can I Use in `.travis.yml` +## YAML Versions for a .travis.yml file Travis CI uses the Ruby libYAML library, which means that your `.travis.yml` must be valid [YAML 1.1](http://yaml.org/spec/1.1/). From 9fcd325fca66345a5702e9451a070ad1df3a2c86 Mon Sep 17 00:00:00 2001 From: nrios14 <44674816+nrios14@users.noreply.github.com> Date: Fri, 8 Nov 2024 16:49:17 -0400 Subject: [PATCH 110/178] Update build-config-imports.md --- user/build-config-imports.md | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/user/build-config-imports.md b/user/build-config-imports.md index f2844205959..cd0d4f91a91 100644 --- a/user/build-config-imports.md +++ b/user/build-config-imports.md @@ -1,5 +1,5 @@ --- -title: Importing Shared Build Configuration +title: Import Shared Build Configuration layout: en --- @@ -7,7 +7,7 @@ layout: en The main source of configuration for your build is the `.travis.yml` file stored in your repository. You can import shared configuration snippets into your `.travis.yml` or [API build request payload](https://docs.travis-ci.com/user/triggering-builds/), -to update your build configuration in multiple repositories making only one +to update your build configuration in multiple repositories, making only one change. Imported configs can themselves include other configs, making this feature very @@ -18,16 +18,16 @@ configuration snippets in total. > BETA The feature Build Config Imports is currently in beta. Please leave feedback on the [Community forum](https://travis-ci.community/c/early-releases). {: .beta } -## Opt-in +## The opt-in option -In order for this feature to be active you have to enable the feature +In order for this feature to be active, you have to enable the feature [Build Config Validation](/user/build-config-validation/) which will be rolled out to all users in the near future. You can enable Build Config Validation in your repository's settings, or by adding `version: ~> 1.0` to your `.travis.yml` file. -## Example +## Import Shared Build Configuration Example Instead of specifying which versions of Ruby to test against in multiple files across many repositories, you can define them in a shared snippet: @@ -102,7 +102,7 @@ present in the importing and an imported config, or in multiple imported configs You can customize this by specifying the merge mode used for each import. See below for more information on [merge modes](#merge-modes). -## Importing configs from the same repository +## Import configs from the same repository When importing configurations stored in the same repository as your `travis.yml`, you can omit the `
/ ` part: @@ -117,9 +117,9 @@ import: The path is relative to the repository's root. -## Importing specific versions of configs +## Import specific config versions -For configurations imported from a different repository the latest version of +For configurations imported from a different repository, the latest version of the default branch in the repository will be used by default. For configurations imported from the same repository the commit you are @@ -136,7 +136,7 @@ import: ``` {: data-file=".travis.yml"} -## Importing configs from private repositories +## Import private repository configs In order to share configurations **from** a private repository this needs to be allowed on that repository, by enabling the *Allow importing config files from this repository* @@ -147,7 +147,7 @@ setting in `More options > Settings > Config Import`. > from private repositories cannot be imported to configs from public > repositories. -## Sharing encrypted secrets +## Share Encrypted Secrets Encrypted secrets contained in imported config snippets can be shared and decrypted with repositories owned by the same organization or user account. @@ -192,7 +192,7 @@ There are these merge modes: The default merge mode is `deep_merge_append`. -### Deep merge append/prepend +### Deep merge: append and prepend The merge modes `deep_merge_append` and `deep_merge_prepend` recursively merge sections (keys) that hold maps (hashes), and concatenates sequences (arrays) by @@ -269,7 +269,7 @@ When triggering a build through the Travis API or the web UI, the order of ascen No. The parsed YAML trees must be merged. Thus, the `import` keyword is accepted only at the root level. If it suits your scenario, you can specify your job template in, e.g., `job.yml` and import it into your `.travis.yml` with the `mode: deep_merge`, adding in the `.travis,yml` specifics to be overridden in the imported template. -### Is it possible to create and use anchors via the shared configs mechanism? +### Can I create and use anchors via the shared configs mechanism? Unfortunately, it’s not supported. As much as we encourage [using YAML as a build configuration language](/user/build-config-yaml), anchors and aliases, referring to these anchors must be defined and used within a single `.yml` file and will be expanded before any *import* action (merging parse trees) occurs. For the same reason, attempts to assign an anchor within `.travis.yml` to an *imported* key will not work — both `.travis.yml` and `imported.yml` must be parsed before the merge action can occur. From 2e4e2019c4d3ee1fdffc666222073ca3de0714f9 Mon Sep 17 00:00:00 2001 From: nrios14 <44674816+nrios14@users.noreply.github.com> Date: Fri, 8 Nov 2024 16:50:30 -0400 Subject: [PATCH 111/178] Update build-config-validation.md --- user/build-config-validation.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/user/build-config-validation.md b/user/build-config-validation.md index 52d5a4ec05f..52c54da1d32 100644 --- a/user/build-config-validation.md +++ b/user/build-config-validation.md @@ -10,7 +10,7 @@ layout: en
sudo is not available for builds that are running on the
-## Using the [Chrome addon](/user/chrome) in the headless mode
+## Headless mode with the Chrome addon
Starting with version 57 for Linux Trusty and version 59 on macOS, Google Chrome can be used in "headless"
-mode, which is suitable for driving browser-based tests using Selenium and other tools.
+mode with the [Chrome addon](/user/chrome), which is suitable for driving browser-based tests using Selenium and other tools.
> As of 2017-05-02, this means `stable` or `beta` on Linux builds, and `beta` on macOS builds.
@@ -181,14 +179,14 @@ before_install:
```
{: data-file=".travis.yml"}
-#### Documentation
+### More Documentation
* [Headless Chromium documentation](https://chromium.googlesource.com/chromium/src/+/lkgr/headless/README.md)
* [Getting Started with Headless Chrome](https://developers.google.com/web/updates/2017/04/headless-chrome)
-## Using the [Firefox addon](/user/firefox) in headless mode
+## Headless mode with the Firefox addon
-Starting with version 56, Firefox can be used in "headless" mode, which is
+Starting with version 56, Firefox can be used in "headless" mode with the [Firefox addon](/user/firefox), which is
suitable for driving browser-based tests using Selenium and other tools.
Headless mode can be enabled using the `MOZ_HEADLESS`
[environment variable](/user/environment-variables/):
@@ -215,12 +213,12 @@ options.add_argument('-headless')
firefox = Firefox(firefox_options=options)
```
-#### Documentation
+### More Documentation
* [Using headless mode](https://developer.mozilla.org/en-US/Firefox/Headless_mode#Using_headless_mode)
* [Automated testing with headless mode](https://developer.mozilla.org/en-US/Firefox/Headless_mode#Automated_testing_with_headless_mode)
-## Using PhantomJS
+## Use PhantomJS
[PhantomJS](http://phantomjs.org/) is a headless WebKit with JavaScript API. It is an optimal solution for fast headless testing, site scraping, pages capture, SVG renderer, network monitoring and many other use cases.
@@ -237,12 +235,14 @@ If you need a web server to serve the tests, see the previous section.
## Examples
+The following are a series of examples.
+
### Real World Projects
- [Ember.js](https://github.com/emberjs/ember-mocha/blob/master/.travis.yml) (starts web server programmatically)
- [Sproutcore](https://github.com/sproutcore/sproutcore/blob/master/.travis.yml) (starts web server with *before_script*)
-### Ruby
+### Ruby Example
#### RSpec, Jasmine, Cucumber
From 9d32506342e524b269e1b135d7e4878085a1a008 Mon Sep 17 00:00:00 2001
From: nrios14 <44674816+nrios14@users.noreply.github.com>
Date: Fri, 8 Nov 2024 17:34:58 -0400
Subject: [PATCH 117/178] Update speeding-up-the-build.md
---
user/speeding-up-the-build.md | 32 ++++++++++++++++----------------
1 file changed, 16 insertions(+), 16 deletions(-)
diff --git a/user/speeding-up-the-build.md b/user/speeding-up-the-build.md
index 6d81b51a480..bf2c2c2a6e1 100644
--- a/user/speeding-up-the-build.md
+++ b/user/speeding-up-the-build.md
@@ -1,15 +1,15 @@
---
-title: Speeding up the build
+title: Speed up the build
layout: en
---
Travis CI implements a few optimizations which help to speed up your build,
-like in memory filesystem for DB's files, but there is a range of things
+like in-memory filesystem for DB's files, but there is a range of things
that can be done to improve build times even more.
-## Parallelizing your Builds across Virtual Machines
+## Parallelize Builds across Virtual Machines
To speed up a test suite, you can break it up into several parts using
Travis CI's [build
@@ -71,7 +71,7 @@ actionmailer, activesupport and a whole bunch of sets run the activerecord
tests against multiple databases. See their [.travis.yml
file](https://github.com/rails/rails/blob/master/.travis.yml) for more examples.
-## Parallelizing your Build on One Virtual Machine
+## Parallelize a Build on a single Virtual Machine
Parallelizing the test suite on one virtual machine depends on the language and test runner:
@@ -81,11 +81,11 @@ Parallelizing the test suite on one virtual machine depends on the language and
To give you an idea of the speedup we are talking about, I've tried to run tests in parallel on `travis-core` and I was able to see a drop from about 26 minutes to about 19 minutes across 4 jobs.
-## Parallelizing RSpec, Cucumber and Minitest on Multiple VMs
+## Parallelize RSpec, Cucumber, and Minitest on Multiple VMs
-If you want to parallel tests for RSpec, Cucumber or Minitest on multiple VMs to get faster feedback from CI, you can try [knapsack](https://github.com/ArturT/knapsack) gem. It will split tests across virtual machines and make sure that tests will run a comparable time on each VM (each job will take similar time). You can use our matrix feature to set up knapsack.
+If you want to perform parallel tests for RSpec, Cucumber, or Minitest on multiple VMs to get faster feedback from CI, you can try [knapsack](https://github.com/ArturT/knapsack) gem. It will split tests across virtual machines and make sure that tests will run a comparable time on each VM (each job will take similar time). You can use our matrix feature to set up knapsack.
-### RSpec Parallelization example
+### RSpec Parallelization Example
```yaml
script: "bundle exec rake knapsack:rspec"
@@ -106,7 +106,7 @@ MY_GLOBAL_VAR=123 CI_NODE_TOTAL=2 CI_NODE_INDEX=0
MY_GLOBAL_VAR=123 CI_NODE_TOTAL=2 CI_NODE_INDEX=1
```
-### Cucumber Parallelization example
+### Cucumber Parallelization Example
```yaml
script: "bundle exec rake knapsack:cucumber"
@@ -119,7 +119,7 @@ env:
```
{: data-file=".travis.yml"}
-### Minitest Parallelization example
+### Minitest Parallelization Example
```yaml
script: "bundle exec rake knapsack:minitest"
@@ -132,9 +132,9 @@ env:
```
{: data-file=".travis.yml"}
-### RSpec, Cucumber and Minitest Parallelization example
+### RSpec, Cucumber, and Minitest Parallelization Example
-If you want to parallelize a test suite for RSpec, Cucumber and Minitest at the same time, define script in `.travis.yml` as follows:
+If you want to parallelize a test suite for RSpec, Cucumber, and Minitest at the same time, define script in `.travis.yml` as follows:
```yaml
script:
@@ -155,13 +155,13 @@ You can either use our [built-in caching](/user/caching/) or roll your own on S3
want to roll your own and you use Ruby with Bundler, check out [the great WAD project](https://github.com/Fingertips/WAD).
For other languages, you can use s3 tools directly to upload and download the dependencies.
-## Environment-Specific Ways to Speed up your Build
+## Environment-Specific Ways to Speed up a Build
In addition to the optimizations implemented by Travis, there are also
several environment-specific ways you may consider to increase the speed of
your tests.
-### PHP optimizations
+### PHP Optimizations
PHP VM images on Travis CI provide several PHP versions which include
XDebug. The XDebug extension is useful, if you wish to generate code coverage
@@ -176,7 +176,7 @@ builds if:
- you are testing on PHP 7.0 or above and are able to use the [PHP Debugger (phpdbg)](https://github.com/krakjoe/phpdbg)
which may be faster.
-#### Using phpdbg example
+#### phpdbg Example
```yaml
before_script:
@@ -188,7 +188,7 @@ script:
```
{: data-file=".travis.yml"}
-### Makefile optimization
+### Makefile Optimization
If your makefile build consists of independent parts that can be safely
parallelized, you can [run multiple recipes
@@ -200,7 +200,7 @@ similar number (or slightly higher if your build frequently waits on disk I/O).
> Note that doing this will cause concurrent recipe output to become interleaved.
-#### Makefile parallelization example
+#### Makefile Parallelization Example
```yaml
env:
From eb40f9919a837f0dc58fa3841e633306dd49d643 Mon Sep 17 00:00:00 2001
From: nrios14 <44674816+nrios14@users.noreply.github.com>
Date: Fri, 8 Nov 2024 17:45:39 -0400
Subject: [PATCH 118/178] Update apps.md
---
user/apps.md | 66 ++++++++++++++++++++++++++--------------------------
1 file changed, 33 insertions(+), 33 deletions(-)
diff --git a/user/apps.md b/user/apps.md
index fe83a7125d9..04b58987790 100644
--- a/user/apps.md
+++ b/user/apps.md
@@ -1,5 +1,5 @@
---
-title: Apps, Clients and Tools
+title: Apps, Clients, and Tools
layout: en
---
@@ -16,12 +16,12 @@ There is a wide range of tools you can use to interact with Travis CI:
And if you don't find anything that fits your needs, you can also interact with our [API](/api/) directly.
-Note however that Travis CI can not take any responsibility of for third-party tools you might use.
-
-# Websites {#websites}
+However, Travis CI cannot take any responsibility for third-party tools you might use.
## Full Web Clients
+This section shows the full web client apps that are available.
+
### Travis CI Web Client
{:.app}{:.official}
@@ -34,6 +34,8 @@ Our official web interface, written in [Ember.js](http://www.emberjs.com)
## Dashboards
+This section shows the different available dashboard apps.
+
### TravisLight
{:.app}
@@ -112,6 +114,8 @@ By Workshop 64
## Tools
+This section shows available tools.
+
### Travis Web Encrypter
{:.app}
@@ -124,11 +128,9 @@ By Konstantin Haase
-# Mobile Applications
+## Android Mobile Applications
-## Android
-
-### Siren of Shame (Android)
+### Siren of Shame
{:.app}
@@ -138,7 +140,7 @@ By Automated Architecture
- [website](http://sirenofshame.com/)
- [play store](https://play.google.com/store/apps/details?id=com.automatedarchitecture.sirenofshame2)
-## iOS
+## iOS Mobile Applications
### Jarvis
@@ -160,7 +162,7 @@ By Dimitri Roche
- [app store](https://itunes.apple.com/us/app/project-monitor/id857272990)
- [source code](https://github.com/dimroc/iOS.ProjectMonitor)
-### Siren of Shame (iOS)
+### Siren of Shame
{:.app}
@@ -170,7 +172,7 @@ By Automated Architecture
- [website](http://sirenofshame.com/)
- [app store](https://itunes.apple.com/us/app/siren-of-shame/id637677118)
-## Windows Phone
+## Windows Mobile Applications
### Travis7
@@ -181,7 +183,7 @@ By Tim Felgentreff
- [website](http://travis7.codeplex.com/)
-# Desktop
+## Desktop
If you are looking for **desktop notifications**, our command line client [supports them](https://github.com/travis-ci/travis.rb#monitor).
@@ -232,9 +234,7 @@ By catlight.io
-# Command Line Tools
-
-## Full Clients
+## Command Line Tools - Full Clients
### Travis CLI
@@ -250,7 +250,7 @@ Command line client for PowerShell
- [website](https://github.com/felixfbecker/PSTravis#readme)
-## Build Monitoring
+## Command Line Tools - Build Monitoring
### Bickle
@@ -297,7 +297,7 @@ By Henry Ruhs
- [website](https://github.com/redaxmedia/chroma-feedback)
-## Generators
+## Command Line Tools - Generators
### travis-encrypt
@@ -335,9 +335,7 @@ By James Halliday
- [website](https://github.com/substack/travisify)
-# Plugins
-
-## Google Chrome
+## Google Chrome Plugins
### My Travis
@@ -362,11 +360,11 @@ By Tomas Carnecky
{:.app}
Display build status next to project name on GitHub-By excellenteasy +By excellent easy - [website](https://chrome.google.com/webstore/detail/github-status/mgbkbopoincdiimlleifbpfjfhcndahp) -## Opera +## Opera Plugins ### GitHub+Travis @@ -377,7 +375,7 @@ By smasty - [website](https://addons.opera.com/en/extensions/details/travisgithub/) -## Editors +## Editor Plugins ### Atom Plugin @@ -416,7 +414,7 @@ By Keith Smiley - [website](https://github.com/Keithbsmiley/travis.vim) -## Other +## Other Plugins ### git-travis @@ -445,9 +443,11 @@ By Sankarsan Kampa - [website](https://github.com/DiscordHooks/travis-ci-discord-webhook) -# Libraries +## Libraries + +The following section shows the different available libraries. -## Ruby +### Ruby - [travis.rb](https://github.com/travis-ci/travis.rb) **(official)** - [trav3](https://github.com/danielpclark/trav3) by Daniel P. Clark @@ -456,7 +456,7 @@ By Sankarsan Kampa - [Knapsack](https://github.com/ArturT/knapsack) by Artur Trzop -## JavaScript +### JavaScript - [travis-ci](https://github.com/pwmckenna/node-travis-ci) by Patrick Williams - [node-travis-ci](https://github.com/mmalecki/node-travis-ci) by Maciej Małecki @@ -465,25 +465,25 @@ By Sankarsan Kampa - [ee-travis](https://github.com/eventEmitter/ee-travis) by Michael van der Weg - [Favis CI](https://github.com/jaunesarmiento/favis-ci) by Jaune Sarmiento -## PHP +### PHP - [php-travis-client](https://github.com/l3l0/php-travis-client) by Leszek Prabucki -## Python +### Python - [TravisPy](http://travispy.readthedocs.org/en/latest/) by Fabio Menegazzo -## PowerShell +### PowerShell - [PSTravis](https://github.com/felixfbecker/PSTravis) by Felix Becker -## Elixir +### Elixir - [travis.ex](https://github.com/localytics/travis.ex) by Kevin Deisz -## R +### R - [travis](https://github.com/ropenscilabs/travis) by Kirill Müller -## Go +### Go - [go-travis](https://github.com/shuheiktgw/go-travis) by Shuhei Kitagawa From 675d08684ef662bedb45eb2dd199993ddc9bc946 Mon Sep 17 00:00:00 2001 From: nrios14 <44674816+nrios14@users.noreply.github.com> Date: Mon, 11 Nov 2024 07:40:12 -0400 Subject: [PATCH 119/178] Update build-config-yaml.md --- user/build-config-yaml.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/user/build-config-yaml.md b/user/build-config-yaml.md index 6b2ab179972..821a95fe2f9 100644 --- a/user/build-config-yaml.md +++ b/user/build-config-yaml.md @@ -1,5 +1,5 @@ --- -title: Using YAML as a build configuration language +title: Use YAML as a build configuration language layout: en --- @@ -11,7 +11,7 @@ imported using the [Build Config Imports](/user//) feature. This page documents a few noteworthy pieces of information about how Travis CI uses YAML. -## Usage of YAML anchors and aliases +## YAML anchors and aliases In more advanced use cases, in order to reduce repetition in large build config files a good practice is to use YAML's mechanism of defining and reusing shared @@ -50,10 +50,10 @@ deploy: branch: staging ``` -## Private keys as YAML anchors and aliases and external tooling +## Private keys as YAML anchors, aliases, and external tooling -In some cases it might be better to define a shared piece of YAML config in a -different place than where it is going to be used, e.g. in order to increase +In some cases, it might be better to define a shared piece of YAML config in a +different place than where it is going to be used, e.g., in order to increase readability. For example, one might define several jobs by reusing a shared portion of @@ -92,7 +92,7 @@ quoting version numbers so the YAML parser would interpret them as strings. is active for the given repository. For example, specifying a Node.js version as `node_js: 9.10` would have been -parsed into `9.0`, not matching the intended version. As a solution we would +parsed into `9.0`, not matching the intended version. As a solution, we would have recommended specifying `node_js: "9.10"` instead. With the introduction of a new YAML parser as part of the [Build Config Validation](/user/build-config-validation/) From 655b130071e41a73edf809ea8f57d5a2c8f62aed Mon Sep 17 00:00:00 2001 From: nrios14 <44674816+nrios14@users.noreply.github.com> Date: Mon, 11 Nov 2024 07:40:33 -0400 Subject: [PATCH 120/178] Update build-hacks.md --- user/build-hacks.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/user/build-hacks.md b/user/build-hacks.md index 1f5b631f5f5..77ab87fdc35 100644 --- a/user/build-hacks.md +++ b/user/build-hacks.md @@ -6,7 +6,7 @@ layout: en -## Update/Downgrade Maven +## Update or Downgrade Maven The newer Maven isn't always stable compared to previous ones, potentially breaking plugins, This script downloads and installs the latest 3.1.1 release From 14654c296c04d9eac5219b964a1bbd74ec5401de Mon Sep 17 00:00:00 2001 From: nrios14 <44674816+nrios14@users.noreply.github.com> Date: Mon, 11 Nov 2024 07:41:38 -0400 Subject: [PATCH 121/178] Update chrome.md --- user/chrome.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/user/chrome.md b/user/chrome.md index 2d397656bc6..89312297edb 100644 --- a/user/chrome.md +++ b/user/chrome.md @@ -10,9 +10,9 @@ This addon supports both, Linux and [macOS](/user/reference/osx/) [build environ > For Linux, you must be running on [Ubuntu Xenial 16.04](https://docs.travis-ci.com/user/reference/xenial/) or later build environments. -## Selecting a Chrome version +## Select a Chrome version -You can install the `stable` or the `beta` version of Chrome but you can't select a specific numeric version. +You can install the `stable` or the `beta` version of Chrome, but you can't select a specific numeric version. ```yaml addons: @@ -35,7 +35,7 @@ In that case, you may see an error message like this: ``` 30 11 2017 13:35:42.245:ERROR [launcher]: Cannot start Chrome - [4315:4315:1130/133541.781662:FATAL:setuid_sandbox_host.cc(157)] The SUID sandbox helper binary was found, but is not configured correctly. Rather than run without sandboxing I'm aborting now. You need to make sure that /opt/google/chrome/chrome-sandbox is owned by root and has mode 4755. + [4315:4315:1130/133541.781662:FATAL:setuid_sandbox_host.cc(157)] The SUID sandbox helper binary was found, but is not configured correctly. Rather than run without sandboxing, I'm aborting now. You need to make sure that /opt/google/chrome/chrome-sandbox is owned by root and has mode 4755. ``` or like this: From fc779be6cf165a2dbb97fae96401f09462f6d0fd Mon Sep 17 00:00:00 2001 From: nrios14 <44674816+nrios14@users.noreply.github.com> Date: Mon, 11 Nov 2024 07:42:34 -0400 Subject: [PATCH 122/178] Update deployment-v2.md From 29e109597a7ee8517c47b9c940904c25b8fa8e59 Mon Sep 17 00:00:00 2001 From: nrios14 <44674816+nrios14@users.noreply.github.com> Date: Mon, 11 Nov 2024 07:43:52 -0400 Subject: [PATCH 123/178] Update conditions-v0.md --- user/conditions-v0.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/user/conditions-v0.md b/user/conditions-v0.md index 8a2fa0f9f07..17484e924b4 100644 --- a/user/conditions-v0.md +++ b/user/conditions-v0.md @@ -12,7 +12,7 @@ specifying conditions in your build configuration (your `.travis.yml` file). See [Conditional Builds, Stages, and Jobs](/user/conditional-builds-stages-jobs/) for details. -## Specifying conditions +## Specify conditions The condition can be specified using a boolean language as follows: @@ -29,9 +29,9 @@ A term is defined as: All keywords (such as `AND`, `OR`, `NOT`, `IN`, `IS`, attributes, and functions) are case-insensitive. -### Left hand side +### Left-hand side -The left hand side part can either be a known attribute or a function call. +The left-hand side part can either be a known attribute or a function call. Known attributes are: @@ -52,7 +52,7 @@ The function `env` currently only supports environment variables that are given in your build configuration (e.g. on `env` or `env.global`), not environment variables specified in your repository settings. -### Right hand side +### Right-hand side It is currently not possible to compare function calls. This means that if you try to evaluate something similar to: From 16d758e0178db5e8eeb9d9b3a84def7d024635ce Mon Sep 17 00:00:00 2001 From: nrios14 <44674816+nrios14@users.noreply.github.com> Date: Mon, 11 Nov 2024 07:45:31 -0400 Subject: [PATCH 124/178] Update firefox.md --- user/firefox.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/user/firefox.md b/user/firefox.md index 82bd5730e35..52b550eae46 100644 --- a/user/firefox.md +++ b/user/firefox.md @@ -9,7 +9,7 @@ Our 64-bit Linux VMs include a version of Firefox. While Firefox is not pre-installed on macOS images, you can use this addon to set it up for use on your builds. -## Selecting a Firefox version +## Select a Firefox version To install a specific version of Firefox, you can use the Firefox addon. The addon will download and install Firefox before running your build script. @@ -36,4 +36,4 @@ In addition to specific version numbers, there are 6 special aliases you can use The `latest-unsigned` binary is an unbranded build, suitable for [Add-ons/Extensions Signing](https://wiki.mozilla.org/Addons/Extension_Signing#Unbranded_Builds). -For more information visit the [Mozilla Wiki](https://wiki.mozilla.org/Firefox/Channels#Developer_Edition_.28aka_Aurora.29). +For more information, visit the [Mozilla Wiki](https://wiki.mozilla.org/Firefox/Channels#Developer_Edition_.28aka_Aurora.29). From 11ad88657a8c142ffefddce08550e4aa10b488a1 Mon Sep 17 00:00:00 2001 From: nrios14 <44674816+nrios14@users.noreply.github.com> Date: Mon, 11 Nov 2024 07:49:34 -0400 Subject: [PATCH 125/178] Update running-build-in-debug-mode.md --- user/running-build-in-debug-mode.md | 34 ++++++++++++++--------------- 1 file changed, 17 insertions(+), 17 deletions(-) diff --git a/user/running-build-in-debug-mode.md b/user/running-build-in-debug-mode.md index 8af6862de88..0ef822db9dc 100644 --- a/user/running-build-in-debug-mode.md +++ b/user/running-build-in-debug-mode.md @@ -1,5 +1,5 @@ --- -title: Running Build in Debug Mode +title: Run Builds in Debug Mode layout: en --- @@ -13,7 +13,7 @@ significant differences between your local development environment and the Travis CI build environment, you can restart builds in debug mode to get shell access to the virtual machine or container. -## Enabling debug mode +## Enable debug mode Private repositories have debug mode enabled by default, and no changes need to be made. To limit access to debug, grant users only *read access* to the repo, and use a fork + PR workflow. @@ -21,7 +21,7 @@ For public repositories, we have to enable it on a repository basis. To enable debug for your public repositories, please email us at support@travis-ci.com and let us know which repositories you want activated. -## Restarting a job in debug mode +## Restart a job in debug mode The "Debug build" or "Debug job" button is available on the upper right corner of the build and job pages for private repositories. For open source repositories, @@ -29,7 +29,7 @@ this button is not available and you will need to use an API call instead.  -### Restarting a job in debug mode via API +### Restart a job in debug mode via API To restart a job in debug mode via API, send a `POST` request to the job's `debug` endpoint. This request needs to be authenticated by adding your [Travis CI API token](/user/triggering-builds/) @@ -70,7 +70,7 @@ $ curl -s -X POST \ https://api.travis-ci.org/job/${id}/debug ``` -#### Finding the job ID +#### Find the job ID The `${id}` is a job ID, not a build ID. For example, the ID `248927956` in the URL [`https://travis-ci.org/travis-ci/docs-travis-ci-com/builds/248927956`](https://travis-ci.org/travis-ci/docs-travis-ci-com/builds/248927956) is a build ID. To obtain the corresponding job ID, click the _View config_ button on that page, and the URL will change into [`https://travis-ci.org/travis-ci/docs-travis-ci-com/jobs/248927957/config`](https://travis-ci.org/travis-ci/docs-travis-ci-com/jobs/248927957/config), showing the job ID `248927957`. Alternatively, you can obtain job IDs corresponding to a build ID [via the API](https://docs.travis-ci.com/api/#builds). @@ -79,10 +79,10 @@ The `${id}` is a job ID, not a build ID. For example, the ID `248927956` in the To show any command input and output you see while connected to the VM running in the debug mode, pass an empty JSON object (`{}`) in the payload instead. -## Connecting to the job running in the debug mode +## Connect to the job running in the debug mode When the job starts in the debug mode, it will go through the initial steps, including setting up language -run times and caches (if applicable) and installing debug utilities. +run times and caches (if applicable) and install debug utilities. When it is ready for your connection, you will see: @@ -140,7 +140,7 @@ Permission denied (publickey). If you see this, run the command `ssh-keygen` (go through the prompts), and try again. -## Things to do once you are inside the debug VM +## Things to do once inside the debug VM Once inside the debug VM, you are able to explore. @@ -148,7 +148,7 @@ You are in a [`tmate`](https://tmate.io/) session, at the point where your `before_install` (even if it is not defined) phase is about to start. -### Convenience `bash` functions +### Convenience bash functions Various build phases are defined in convenience `bash` functions named `travis_run_*` (e.g., `travis_run_before_install`, `travis_run_install`). @@ -185,7 +185,7 @@ travis_run_script () ``` `travis_cmd` basically executes the string argument (with escaped white spaces in the example above) and adds some decorations so that the output looks nice. In the debug sessions, you can run the string argument (unescaped) instead. -### Basic `tmate` features +### Basic tmate features `tmate` is a fork of [`tmux`](https://tmux.github.io/). Your debug VM session uses the default configuration; thus, the command prefix is @@ -193,7 +193,7 @@ Your debug VM session uses the default configuration; thus, the command prefix i A subset of functionalities are available for you in this debug session. -#### Creating a new window +#### Create a new window ``` ctrl-b c @@ -202,7 +202,7 @@ ctrl-b c The first window is indexed 0. So repeating command will give you windows 1, 2, and so on. -#### Switching to a different window +#### Switch to a different window ``` ctrl-b 0 @@ -227,7 +227,7 @@ Switch to the previous window. Switching between windows can be helpful if you want to run long-running process in one window while looking at the debug VM in another. -#### Scrolling up and down the terminal history +#### Scroll up and down the terminal history ``` ctrl-b [ @@ -238,7 +238,7 @@ log history. Press `q` to exit the log scroll mode. -### Capturing the debug session output +### Capture the debug session output Before you end the debug session, you may wish to copy the output. By default, when you exit your `tmate` session the terminal is cleared immediately, without a chance to save it. @@ -254,7 +254,7 @@ In order to save the output, follow these steps: 1. cancel the debug session from the web UI (this leaves the job in "Canceled" state regardless of the result of the previous execution), or 1. open a new window (`ctrl-b c`), kill the first window (`tmate killw -t 0`), and exit the new window (`exit`). -### Getting out of the debug VM +### Get out of the debug VM Once you exit from all the live `tmate` windows, the debug VM will terminate after resetting the job's status to the original status before you restarted it. @@ -262,7 +262,7 @@ No more phases (`before_install`, `install`, etc.) will be executed. ## Known issues -### In a Node.js debug session, the `node` and `npm` versions differ from what is defined in the configuration +### In a Node.js debug session, the node and npm versions differ from what is defined in the configuration To set up the debug environment in the same ways as the Node.js job, run the following command when you log in to your debug session before @@ -271,7 +271,7 @@ executing any other command: ``` nvm install $TRAVIS_NODE_VERSION ``` -### If the debug VM crashes when running one of the `travis_run_*` functions +### If the debug VM crashes when running one of the travis_run_* functions If your debug build crashes when running any of the specified commands, we suggest narrowing down the issue as follows: From ffc50f10ebb97fafdcc062d74293293071900570 Mon Sep 17 00:00:00 2001 From: nrios14 <44674816+nrios14@users.noreply.github.com> Date: Mon, 11 Nov 2024 07:51:10 -0400 Subject: [PATCH 126/178] Update private-dependencies-gl.md --- user/private-dependencies-gl.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/user/private-dependencies-gl.md b/user/private-dependencies-gl.md index 93306d3112b..0dd36d74a70 100644 --- a/user/private-dependencies-gl.md +++ b/user/private-dependencies-gl.md @@ -18,7 +18,7 @@ either the [Deploy Key](#deploy-key) or [User Key](#user-key) method. If the dependency is also on GitLab, there are several different ways of fetching the repository from within a Travis CI VM. Each one has advantages and -disavantages, so read each method carefully and pick the one that applies best +disadvantages, so read each method carefully and pick the one that applies best to your situation. | Authentication | Protocol | Dependency URL format | Gives access to | Notes | @@ -30,7 +30,7 @@ to your situation. You can use a [dedicated CI user account](#dedicated-user-account) for all but the deploy key approach. This allows you to limit access to a well defined list -of repositories, and make sure that access is read only. +of repositories, and make sure that access is read-only. ## Deploy Key @@ -38,7 +38,7 @@ GitLab allows you to set up SSH keys for a repository. These deploy keys have so - They are not bound to a user account, so they will not get invalidated by removing users from a repository. - They do not give access to other, unrelated repositories. -- The same key can be used for dependencies not stored on GitLab. +- The same key can be used for dependencies that are not stored on GitLab. However, using deploy keys is complicated by the fact that GitLab does not allow you to reuse keys. So a single private key cannot access multiple GitLab repositories. @@ -151,7 +151,7 @@ before_install: ``` {: data-file=".travis.yml"} -It is also possible to inject the token into URLs, for instance, in a Gemfile, it would look like this: +It is also possible to inject the token into URLs. For instance, in a Gemfile, it would look like this: ```ruby source 'https://rubygems.org' @@ -169,10 +169,10 @@ gem 'lib1', gitlab: "myorg/lib1" gem 'lib2', gitlab: "myorg/lib2" ``` -> In case of private git submodules, be aware that the `git submodule +> In the case of private git submodules, be aware that the `git submodule > update --init --recursive` command runs before the `~/.netrc` credentials > are updated. If you are writing credentials to `~/.netrc`, disable the automatic loading of -> submodules, update the credentials and add an explicit step to update the submodules: +> submodules, update the credentials, and add an explicit step to update the submodules: > > ```yaml > git: From a8e09ce205143161fdecc4cfb9281be8262dc661 Mon Sep 17 00:00:00 2001 From: nrios14 <44674816+nrios14@users.noreply.github.com> Date: Mon, 11 Nov 2024 07:51:45 -0400 Subject: [PATCH 127/178] Update private-dependencies-assembla.md --- user/private-dependencies-assembla.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/user/private-dependencies-assembla.md b/user/private-dependencies-assembla.md index ff38973f9ae..dab4c48a09c 100644 --- a/user/private-dependencies-assembla.md +++ b/user/private-dependencies-assembla.md @@ -18,7 +18,7 @@ either the [Deploy Key](#deploy-key) or [User Key](#user-key) method. If the dependency is also on Assembla, there are several different ways of fetching the repository from within a Travis CI VM. Each one has advantages and -disavantages, so read each method carefully and pick the one that applies best +disadvantages, so read each method carefully and pick the one that applies best to your situation. | Authentication | Protocol | Dependency URL format | Gives access to | Notes | @@ -30,7 +30,7 @@ to your situation. You can use a [dedicated CI user account](#dedicated-user-account) for all but the deploy key approach. This allows you to limit access to a well defined list -of repositories, and make sure that access is read only. +of repositories, and make sure that access is read-only. ## Deploy Key From db3b92a10f10a4c0de5388eeef0eb8a52bc560b2 Mon Sep 17 00:00:00 2001 From: nrios14 <44674816+nrios14@users.noreply.github.com> Date: Mon, 11 Nov 2024 07:52:41 -0400 Subject: [PATCH 128/178] Update multi-platform-login.md --- user/multi-platform-login.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/user/multi-platform-login.md b/user/multi-platform-login.md index 5f2171d6fcf..2556cca1aef 100644 --- a/user/multi-platform-login.md +++ b/user/multi-platform-login.md @@ -10,11 +10,11 @@ You can now log into Travis CI using several accounts from our supported platfor > For Travis CI being able to recognize all your accounts, you have to log in on the provider website and then add the account on [Travis CI](travis-ci.com/signin). -## Adding Accounts +## Add Accounts You can add more accounts to Travis CI by using either the Sign-in page or the user menu. -### Adding accounts using the Sign-in page +### Add accounts using the Sign-in page To add more accounts: @@ -23,7 +23,7 @@ To add more accounts: 3. Go to the Travis CI Sign-in page. 4. Click **Sign In with GitHub/Bitbucket/GitLab/Assembla** on the sign-in page. Your account is stored and you can now switch between the different accounts in Travis CI. -### Adding accounts using the user menu +### Add accounts using the user menu To add more accounts: @@ -31,20 +31,20 @@ To add more accounts: 2. Click the **Add an account** link at the bottom of the menu. The Sign-in page appears displaying all your accounts. 3. Click **Sign In with
-### .travis.yml
+### .travis.yml file
Add the encrypted key to the `jwt` section of the `.travis.yml` file.
This can be done manually or using the `travis encrypt` command
@@ -67,7 +67,7 @@ environment variables containing the JWT tokens instead of the original values.
For example, using the previous configuration `SAUCE_ACCESS_KEY` and
`THIRDPARTY_SHARED_SECRET` will be available as environment variables.
-### How secure is this addon?
+### Secure the addon
The JWT token is only valid for 90 minutes. It is signed in a way that lets you securely
transmit your secret information without worrying that it is leaked.
@@ -106,7 +106,7 @@ Where:
- `exp` will be when the token expires (now + 5400 seconds, so 90 minutes)
- `iat` is the issued at time (now)
-### Third Party Service Provider Code Sample
+### Third-Party Service Provider Code Sample
A code sample which illustrates how to add JWT token authentication to third party services.
@@ -125,7 +125,7 @@ The HTTP BASIC AUTH header's payload is base64 encoded which will decode to stri
johndoe:eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJ0cmF2aXMtY2kub3JnIiwic2x1ZyI6InRyYXZpcy1jaS90cmF2aXMtY2kiLCJwdWxsLXJlcXVlc3QiOiIiLCJleHAiOjU0MDAsImlhdCI6MH0.soQJgHR6cGNr9Lj_N6yL2Nk5SQug-hXGUPenJy1QTVc
```
-The colon separated string contains the username before the colon and the JWT
+The colon-separated string contains the username before the colon and the JWT
token after the colon. The username is used to retrieve the user object from
the user database. Below is a function which is executed against the user
object and the token to validate them for authentication. Please note that the
@@ -154,7 +154,7 @@ def authenticate(user, access_key):
return False
```
-## List of Third-Party Services Integrated with the JWT Addon
+## Third-Party Services Integrated with the JWT Addon
### Sauce Labs
From 4db152e8d5f4b08b7c42f202546f73e7f8121338 Mon Sep 17 00:00:00 2001
From: nrios14 <44674816+nrios14@users.noreply.github.com>
Date: Mon, 11 Nov 2024 08:00:59 -0400
Subject: [PATCH 135/178] Update trusty-to-xenial-migration-guide.md
---
user/trusty-to-xenial-migration-guide.md | 12 ++++++------
1 file changed, 6 insertions(+), 6 deletions(-)
diff --git a/user/trusty-to-xenial-migration-guide.md b/user/trusty-to-xenial-migration-guide.md
index 64c79bd4fd6..264b38d1376 100644
--- a/user/trusty-to-xenial-migration-guide.md
+++ b/user/trusty-to-xenial-migration-guide.md
@@ -4,7 +4,7 @@ layout: en
---
As of August, 13th 2019, we've switched the default Linux distribution on Travis CI from Ubuntu Trusty 14.04 LTS to
-Ubuntu Xenial 16.04. Here are the most common issues our customers ran into and how you can fix them.
+Ubuntu Xenial 16.04. Here are the most common issues our customers run into and how you can fix them.
> If you’d like to stay on Ubuntu Trusty or need more time to set up your repository with Ubuntu Trusty,
please explicitly set `dist: trusty` in your .travis.yml file as soon as possible.
@@ -17,7 +17,7 @@ Repositories without an explicit operating system `os:` key in their `travis.yml
There are three important changes to take into account when updating to Xenial from our Trusty build environment:
-### 1. Services support
+### Services Support
Services like [MySQL or PostgreSQL](https://docs.travis-ci.com/user/database-setup/) are not started by default. To start any service, such as MySQL, add it to the services key in your config:
@@ -38,7 +38,7 @@ try to add the following line of code to your `.travis.yml`:
before_install: sudo mount -o remount,size=50% /var/ramfs
```
-### 2. Third-party APT sources
+### Third-party APT sources
Sources from third-party APT repositories have been removed. During the Xenial image provision, third-party APT repositories are used to pre-install services like `redis-server`. These packages are available during build time, but to reduce the risk of sporadic `apt-get update` failures, the repositories are removed after the packages are installed.
@@ -55,7 +55,7 @@ addons:
- git-lfs
```
-### 3. Headless browser testing
+### Headless browser testing
To use headless browser testing, you now start `xvfb` via the services key, like this:
@@ -72,12 +72,12 @@ The default build environment is Ubuntu Xenial 16.04. You can identify if your r
-Jobs run on Xenial, display Operating System Details, Description: Ubuntu 16.04.5 LTS
+Jobs run on Xenial, display Operating System Details, Description: Ubuntu 16.04.5 LTS.
You can find the specific versions of what’s pre-installed in the [Xenial Reference docs](/user/reference/xenial/).
> If your build depends on a different Ubuntu distribution like Ubuntu Trusty 14.04, you can explicitly specify `dist: trusty` to ensure your build will use it.
-## Need Help?
+## Contact Support
Please feel free to contact us via our [support](mailto:support@travis-ci.com?subject=Issues%20migrating%20my%20build%20to%20Xenial) email address, or create a [forum topic](https://travis-ci.community/c/environments/xenial).
From d94111670b785594f5f5e02d3c9d4c27ad55449a Mon Sep 17 00:00:00 2001
From: nrios14 <44674816+nrios14@users.noreply.github.com>
Date: Mon, 11 Nov 2024 08:02:31 -0400
Subject: [PATCH 136/178] Update travis-ci-vcs-proxy.md
---
user/travis-ci-vcs-proxy.md | 8 ++++----
1 file changed, 4 insertions(+), 4 deletions(-)
diff --git a/user/travis-ci-vcs-proxy.md b/user/travis-ci-vcs-proxy.md
index 2dfc00a71f7..2f8d90be745 100644
--- a/user/travis-ci-vcs-proxy.md
+++ b/user/travis-ci-vcs-proxy.md
@@ -37,9 +37,9 @@ You will need:
If you are on Windows when working with Perforce repository, you may want to check [Windows section](/user/travis-ci-vcs-proxy#windows) below in the *P4 CLI Usage* chapter.
-## Setting up repositories and organization TCI Proxy
+## Setup repositories and organization TCI Proxy
-You will go through following major steps in configuration
+You will go through the following major steps in configuration.
* In case of Assembla Cloud with P4 or SVN repository
* Note down certain configuration details from your P4 or SVN repository in Assembla Cloud.
@@ -134,7 +134,7 @@ P4CLIENT=testspace_j # This is your local client name, choose anything.
```
You can access your P4 environment variables by running in your command line `cat ~/.p4enviro` and if you want to edit your environment variables run `vim ~/.p4enviro` in your command line or use an IDE or text editor of your choice.
-## Inviting collaborators to TCI VCS Proxy Organization
+## Invite collaborators to TCI VCS Proxy Organization
To allow users to trigger builds in Travis CI, first, you must add them as members of the organization in the TCI VCS Proxy.
@@ -276,7 +276,7 @@ After you pushed successfully, with your Assembla username, you can see my `.tra
You may find more of the useful information in Assembla articles on working with Perforce Helix Core.
-## I want to build with Travis CI
+## Build with Travis CI
Once the Travis CI VCS Proxy configuration is ready for at least one organization and repository, please follow the instructions in [Getting started with Travis CI using Travis CI VCS Proxy](/user/travis-ci-vcs-proxy-get-started/).
From 244128cff10184bd38354dcf1e6649e987877fe0 Mon Sep 17 00:00:00 2001
From: nrios14 <44674816+nrios14@users.noreply.github.com>
Date: Mon, 11 Nov 2024 08:05:35 -0400
Subject: [PATCH 137/178] Update travis-ci-for-private.md
---
user/travis-ci-for-private.md | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/user/travis-ci-for-private.md b/user/travis-ci-for-private.md
index 4f7a2cc32df..0222cd5f699 100644
--- a/user/travis-ci-for-private.md
+++ b/user/travis-ci-for-private.md
@@ -23,7 +23,7 @@ the [blog post](https://travis-ci.com/blog/announcing-pull-request-support/) acc
## Who has access to the builds?
-Access rights on Travis CI is based on the access rights on GitHub, Bitbucket, GitLab or Assembla:
+Access rights on Travis CI are based on the access rights on GitHub, Bitbucket, GitLab or Assembla:
- Users that can access a repository on GitHub, Bitbucket, GitLab or Assembla can see the build status and logs on Travis CI.
- Users that can push to a repository on GitHub, Bitbucket, GitLab or Assembla can trigger, cancel and restart builds, and change its settings.
@@ -45,7 +45,7 @@ You can change the access rights to **Restricted** (or back to **Open**) under t
-## Is it safe to give Travis CI access to my private code?
+## Is giving Travis CI access to my private code safe?
Security is our major concern when it comes to your source code. At Travis CI, we make sure our infrastructure is protected and secure so that your most valuable asset is safe and protected from unauthorized access.
From 47d99d0deac06e18bc342e2f11318e3bdebf5b09 Mon Sep 17 00:00:00 2001
From: nrios14 <44674816+nrios14@users.noreply.github.com>
Date: Mon, 11 Nov 2024 08:06:13 -0400
Subject: [PATCH 138/178] Update what-is-travis.md
---
user/what-is-travis.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/user/what-is-travis.md b/user/what-is-travis.md
index 13d8f809d63..ee987058f06 100644
--- a/user/what-is-travis.md
+++ b/user/what-is-travis.md
@@ -7,6 +7,6 @@ layout: en
What is Travis CI?
- Travis CI is continuous integration for projects hosted on GitHub.
-- Travis CI is automation for testing building and deploying.
+- Travis CI is automation for testing, building, and deploying.
- Travis CI gives you peace of mind when developing.
- Travis CI lets you know as soon as something goes wrong.
From 90d5452cac359222844c412c5aa4c24a307b01b4 Mon Sep 17 00:00:00 2001
From: nrios14 <44674816+nrios14@users.noreply.github.com>
Date: Mon, 11 Nov 2024 08:06:48 -0400
Subject: [PATCH 139/178] Update web-ui.md
---
user/web-ui.md | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/user/web-ui.md b/user/web-ui.md
index 1bf08a02f36..c110a92f1c3 100644
--- a/user/web-ui.md
+++ b/user/web-ui.md
@@ -43,11 +43,11 @@ In the case of a fork-to-base pull request:
Read more: [Pull Requests and security restrictions](/user/pull-requests/#pull-requests-and-security-restrictions)
-## Enabling access to old build jobs
+## Enable access to old build jobs
{{ site.data.snippets.enabling_access_jobs_logs }}
-## Limiting access to build job logs
+## Limit access to build job logs
{{ site.data.snippets.limiting_access_jobs_logs }}
From 6f1a0034df499d34cfba98b94e3367b212e54db0 Mon Sep 17 00:00:00 2001
From: nrios14 <44674816+nrios14@users.noreply.github.com>
Date: Mon, 11 Nov 2024 08:30:42 -0400
Subject: [PATCH 140/178] Update android.md
---
user/languages/android.md | 20 +++++++++-----------
1 file changed, 9 insertions(+), 11 deletions(-)
diff --git a/user/languages/android.md b/user/languages/android.md
index 1649b41a9f3..0d4f0919e38 100644
--- a/user/languages/android.md
+++ b/user/languages/android.md
@@ -1,17 +1,15 @@
---
-title: Building an Android Project
+title: Build an Android Project
layout: en
---
-### What This Guide Covers
This guide covers build environment and configuration topics specific to Android projects. Please make sure to read our [Onboarding](/user/onboarding/) and [General Build configuration](/user/customizing-the-build/) guides first.
Android builds are not available on the macOS environment.
-
## CI Environment for Android Projects
### Overview
@@ -60,9 +58,9 @@ android:
```
{: data-file=".travis.yml"}
-### How to install Android SDK components
+### Install Android SDK components
-In your `.travis.yml` you can define the list of SDK components to be installed, as illustrated in the following example:
+In your `.travis.yml`, you can define the list of SDK components to be installed, as illustrated in the following example:
```yaml
language: android
@@ -77,7 +75,7 @@ android:
The exact component names must be specified (filter aliases like `add-on` or `extra` are also accepted). To get a list of available exact component names and descriptions run the command `sdkmanager --list` (preferably in your local development machine).
-#### Dealing with Licenses
+#### Deal with Licenses
By default, Travis CI will accept all the requested licenses, but it is also possible to define a white list of licenses to be accepted, as shown in the following example:
@@ -99,7 +97,7 @@ android:
For more flexibility, the licenses can also be referenced with regular expressions (using Tcl syntax as `expect` command is used to automatically respond to the interactive prompts).
-### Pre-installed components
+### Pre-installed Components
While the following components are preinstalled, the exact list may change without prior notice. To ensure the stability of your build environment, we recommend that you explicitly specify the required components for your project.
@@ -111,7 +109,7 @@ While the following components are preinstalled, the exact list may change witho
- extra-google-m2repository
- extra-android-m2repository
-### How to Create and Start an Emulator
+### Create and Start an Emulator
**Warning:** At the moment, these steps are not fully supported by Travis CI Android builder.
@@ -184,7 +182,7 @@ cache:
## Default Test Command
-If Travis CI could not detect Maven or Gradle files, Travis CI Android builder will try to use Ant to build your project. By default it will use
+If Travis CI cannot detect Maven or Gradle files, Travis CI Android builder will try to use Ant to build your project. By default, it will use
```bash
ant debug install test
@@ -192,7 +190,7 @@ ant debug install test
to run your test suite. This can be overridden as described in the [general build configuration](/user/customizing-the-build/) guide.
-## Testing Against Multiple JDKs
+## Test against Multiple JDKs
As for any JVM language, it is also possible to [test against multiple JDKs](/user/languages/java/#testing-against-multiple-jdks).
@@ -200,7 +198,7 @@ As for any JVM language, it is also possible to [test against multiple JDKs](/us
For Android projects, `env` and `jdk` can be given as arrays to construct a build matrix.
-## Building Android projects on new build environments
+## Build Android projects on new build environments
The `dist: trusty` build environment is the only supported build environment for Android but if you would like to build on newer build environments e.g. `dist: jammy`, you can exercise your access to the Travis CI build environments and install required packages and tools. An example .travis.yml config can be reviewed below:
From c28165654e349b869867ae6723eedee048d36cd2 Mon Sep 17 00:00:00 2001
From: nrios14 <44674816+nrios14@users.noreply.github.com>
Date: Mon, 11 Nov 2024 08:32:44 -0400
Subject: [PATCH 141/178] Update c.md
---
user/languages/c.md | 11 +++++------
1 file changed, 5 insertions(+), 6 deletions(-)
diff --git a/user/languages/c.md b/user/languages/c.md
index 9f3b088224f..d68e0f15990 100644
--- a/user/languages/c.md
+++ b/user/languages/c.md
@@ -1,10 +1,9 @@
---
-title: Building a C Project
+title: Build a C Project
layout: en
---
-## What This Guide Covers