Skip to content

Latest commit

 

History

History
108 lines (69 loc) · 6.64 KB

TravisCI_Readme.md

File metadata and controls

108 lines (69 loc) · 6.64 KB
Raw

##Continuous Integration Process:#

Continuous Integration is a development practice that requires developers to integrate code into a shared repository. Each time developer checks in code into the repository, it is then verified by an automated build process. This process gives flexibility for the developer to detect any build issues early in the build life cycle.

hyperledger build process is fully automated using Travis CI Continuous Integration tool, which helps in building a real time solution for all the code check-ins, perform Unit and Functional Tests. Once the build execution completes, developer will get build result notifications on slack, GitHub and email (Depending on configuration settings provided in .travis.yml file)

Master Repository can be found at [hyperledger] (https://github.com/hyperledger/fabric.git).

##Setting up Continuous Integration Process:

  • Login to [GitHub] (https://github.com) --> Fork and clone the hyperledger project into your GitHub account, if you weren't already. If you have a forked repository in your GitHub account, please pull hyperledger/fabric master repository. So that, updated .travis.yml (Configuration file for Travis CI) file will be copied into your repository.
Perform Travis CI integration in GitHub:

  • Click on Settings tab in forked fabric GitHub repository and click on Webhooks & Services option. Click on Add Service and click on Travis CI link in services panel. Provide below details

  • User (GitHub User Name)

  • Token (Generate token from profile - settings - Personal access token - click on Generate New Token) - Check on "public_repo" scope and click on generate token button. Copy and paste it in Token field

  • Domain (Enter "notify.travis-ci.org")

  • Click on Add Service button

This will enable integration between Travis CI and GitHub for the selected repository. After successful integration, Travis CI service will appear in Services menu.

Webhook_Travis

Sync and Enable fabric repository in Travis:

  • Browse Travis CI and click on Sign in with GitHub button and provide GitHub credentials.

  • http://travis-ci.org - for Public Repositories. http://travis-ci.com - for Private repositories.

  • After login to Travis CI --> Click on Accounts link under Username (Available at the top of right corner) and click on Sync account button. This will sync and display all the repositories available for the logged in user. As a next step user has to flick ON for the required repositories. After successful flick, refresh the Travis home page and you see all the selected repositories available in My Repositories section in Travis home page.

  • In more options menu, click on Settings and enable general settings (Build only if .travis.yml is present , Build Pushes , Limit Current jobs , Build pull requests) for the selected repository.

Settings

  • Disable Build Pull Requests option if you don't want to trigger automation build deployment for any Pull Requests.

Add Build status markdown link in Readme.md file

  • Copy markdown link from Travis CI home page and place it in Readme.md file of your working branch. Follow Embedding Status Images that helps you to setup the build status in Readme.md file.

Note: Please make sure .travis.yml , foldercopy.sh and containerlogs.sh are present with below modifications in the master branch or the working branch in GitHub before performing any git push operations.

  • Change notifications section as per user preferences:

Follow Travis Notification Settings to setup notifications in .travis.yml file.

Repository Owner has to provide slack token. Please get in touch with him/her for your Slack Token.

notifications:
slack:<Slack account name>:<User Slack Token> ex: slack:openchain:<user slack token>
 on_success: always
 on_failure: always
 email:
    recipients:
      - [email protected]
      - [email protected]
    on_success: [always|never|change] # default: change
    on_failure: [always|never|change] # default: always

Now you have completed with Travis CI setup process. If you make any changes in your code and push code to remote repository, Travis CI automatically starts the build process and shows you the build results on your notification settings (Slack, email and on GitHub Readme.md).

Build Results

Build Process includes below steps:

  1. git clone on updated git repository into Travis cloud environment from GitHub.
  2. Install all dependency software's and libraries
  3. Perform go build
  4. Start Peer process
  5. Perform unit tests (go tests)
  6. Perform Behave test suite (behave tests)
  7. Provides failed container log files in travis raw log file.
  8. Update slack channel (#fabric-ci-status) with build results.

More Information/Troubleshooting:

  • Developer can skip the Travis CI build process by providing [ci skip] in the git commit message.
git commit -m "Ignore build process [ci skip]"

  • How to skip Travis Build execution for PR's:?

    • Travis CI checks latest commit of PR and if the commit message is tagged with [ci skip], Travis CI ignores build process.
    • This will be useful, when you want to open a pull request early for review but you are not necessarily ready to run the tests right away. Also, you can skip Travis build process for document changes.
    • Right now, Travis only supports above method to skip build process.

  • What is the slack channel to view build results?

    • We are sending build notifications to hyperledger #fabric-ci-status slack channel. (User must join in #fabric-ci-status slack channel to receive build notifications)

  • What is build status errored mean?

    • When "go build" and "Unit tests" fails, Travis stops the build process and exits and mark the build status as errored. When unit tests fail, Travis CI will not execute behave test scripts. Failed: If Behave test cases fail, Travis continues executing remaining test cases and exits with build status as failed.

  • How to restart build without committing any changes to remote GitHub?

    • Apply git commit --allow-empty -m "Empty commit" and do a git push or click on Restart Job (only users with push access to repository can do this) button on Travis CI home page.

  • Where can I find Build log files?

    • Click on RAW log link on Travis CI home page.

  • Where can I find Behave Container log files?

    • Click on each container log file link displays bottom of the RAW log file.