analyticalmonk / Rperform

:bar_chart: R package for tracking performance metrics across git versions and branches.
https://analyticalmonk.github.io/Rperform
GNU General Public License v3.0
65 stars 9 forks source link

editable wiki? #32

Closed tdhock closed 8 years ago

tdhock commented 8 years ago

Hey @analyticalmonk I wanted to post a question on https://github.com/analyticalmonk/Rperform/wiki/Integrating-Rperform-with-Travis-CI but the wiki is not editable. can you make it editable?

I was trying to follow your instructions and get Rperform working with https://github.com/tdhock/coseg and I was not sure what permissions I need to give to the access token. repo?

analyticalmonk commented 8 years ago

Hey @tdhock made it editable. However, the instructions on that page aren't valid anymore. I will be editing that some time tomorrow.

Created a dummy package and working on creating some tests for Rperform right now. Also, here's a (in-progress) tutorial about using Rperform: Tutorial: Using Rperform with packages. It uses the dummy package to help someone new to Rperform get up to speed.

analyticalmonk commented 8 years ago

In addition to updating the wiki, I would be creating a brief hands-on tutorial about using Rperform on Travis. That should clear things up.

analyticalmonk commented 8 years ago

@tdhock About the access token, repo would do. In fact, since it's a public repo, just the _publicrepo option (under repo) would do as well.

I will be updating the wiki but here's the quick setup guide (from my email last week):

In a nutshell, a repo maintainer would have to complete the following steps to run Rperform with the Travis-CI builds:

  • Create a gh-pages branch and create an 'Rperform' directory on the branch. The html pages produced and containing the test results will be stored here and visible at the link: username.github.io/projectname/Rperform
  • Make appropriate changes to the .travis.yml. This includes creating the required environment variables and sourcing the script in the before_install section as is done in the sample_travis.yml file.

Here's the sample_travis.yml file mentioned in the second point.

analyticalmonk commented 8 years ago

@tdhock Here's a new tutorial for integrating Rperform with Travis CI builds: Tutorial: Using Rperform with Travis CI

Also closing this issue since wiki is now editable.