Skip to content

Commit

Permalink
More read me fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
polothy committed Jul 16, 2015
1 parent 8d856f5 commit 20eb0df
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Supported tests and code analysis tools:
Requirements:
* PHP 5.4 or later.
* Moodle 2.9 or later.
* The plugin being tested must have a [version.php](https://docs.moodle.org/dev/version.php) file and the `$plugin->component`
* The plugin being tested must have a [version.php](https://docs.moodle.org/dev/version.php) file and `$plugin->component`
must be defined within it.

# Getting started
Expand All @@ -27,29 +27,29 @@ Follow these steps to get your Moodle plugin building in Travis CI.

## Step 1

Sign into [Travis CI](https://travis-ci.org) with your Github account. Once you’re signed in, and Travis CI will have
Sign into [Travis CI](https://travis-ci.org) with your GitHub account. Once you’re signed in, and Travis CI will have
synchronized your repositories from GitHub. Go to your [profile](https://travis-ci.org/profile) page and enable Travis CI
for the plugin you want to build. Now whenever your plugin receives an update or gets a new pull request, Travis CI will
run a build to make sure nothing broke.

## Step 2

Copy the [.travis.dist.yml](.travis.dist.yml) file into the root of your plugin and rename it to `.travis.yml`. Once you
have added the `.travis.yml` file, commit and push up to Github, to trigger a Travis CI build. Check the
have added the `.travis.yml` file, commit and push up to GitHub, to trigger a Travis CI build. Check the
[build status](https://travis-ci.org/repositories) page to see if your build passes or fails.

## Step 3

This step is optional, but recommended as it greatly reduces [Composer](https://getcomposer.org) install times by making sure
that Composer does not exceed Github's API rate limits. Follow these steps:
that Composer does not exceed GitHub's API rate limits. Follow these steps:

1. [Create an access token](https://help.github.com/articles/creating-an-access-token-for-command-line-use/) in Github. When
1. [Create an access token](https://help.github.com/articles/creating-an-access-token-for-command-line-use/) in GitHub. When
creating your access token, be sure to **uncheck all scopes** as this will give read-only access to public information.
2. After you have created the access token, Github gives you the opportunity to copy it to your clipboard. Do this now.
2. After you have created the access token, GitHub gives you the opportunity to copy it to your clipboard. Do this now.
3. Go to [Travis CI](https://travis-ci.org/repositories) and select your plugin's repository. Then go to _Settings_ and
then to _Environment Variables_.
4. Click on _Add a new variable_.
5. For _Value_ paste in your Github access token.
5. For _Value_ paste in your GitHub access token.
6. For the _Name_ enter `GITHUB_API_TOKEN`
7. Ensure that the _Display value in build logs_ is set to **OFF**.
8. Click _Add_.
Expand Down Expand Up @@ -98,7 +98,7 @@ sudo: false

# This lists steps that are run before the installation step.
before_install:
# This configures Composer with your Github access token if you configured that in
# This configures Composer with your GitHub access token if you configured that in
# Travis CI. If you didn't configure this, then it can be removed.
- composer config -g github-oauth.github.com $GITHUB_API_TOKEN

Expand Down

0 comments on commit 20eb0df

Please sign in to comment.