everypolitician / ensure-regression-tests

Ensure Pull Requests have regression tests included - shell script that runs in your Travis build

EveryPolitician

Data about every national legislature in the world, freely available for you to use

• everypolitician.org — data | about
• Report an issue

Repo summary

These are some of the key repos in the EveryPolitician family. There are others.

• everypolitician (this repo): contains no code, but is where issues/tickets for the whole project live

• everypolitician-data: where the data is stored -- but if you want to download it, get it from:

  • human? go via the EveryPolitician website
  • program? use the RawGit CDN, via links in countries.json, which we explain here

• viewer-static: the live website http://everypolitician.org (gh-pages)

• viewer-sinatra: Sinatra app for generating a dynamic version EveryPolitician website

• webhook-manager: sends out EveryPolitician WebHooks: register your URL here!

• everypolitician-docs: documentation at http://docs.everypolitician.org/ (gh-pages)

• rebuilder rebuilds data from source

• libraries for easily manipulating EveryPolitician data (useful for all devs, but we use the Ruby ones ourselves, of course!):

  • Ruby: everypolitician-ruby and everypolitician-popolo.
  • Python: everypolitician and everypolitician-popolo

• handy gems we use when getting the data: wikidata-fetcher, wikisnakker, twitter_username_extractor, facebook_username_extractor, twitter_list, scraped_page_archive

• gender-balance: repo for the Gender Balance website that crowdsources gender data for EveryPolitician

• data_pr_change_summarizer: code used by the bot to review a data PR and leave a helpful summary as a comment

The repos for many of our scrapers are kept separately in github.com/everypolitician-scrapers.

Technical blog

The EveryPolitician bot's own page is a good jumping-off point to lots of semi-technical explanations of what's going on (it has its own blog on Medium). For example:

• how the website is built (spoiler: viewer-sinatra → viewer-static)
• how webhooks are used (you can easily register your app!)
• how the scrapers run (many live on morph.io)

The bot is on twitter as @everypolitician

Contributing

If you have data for us, or know where to get it, please read our page about how to contribute.

Team

EveryPolitician is a mySociety project.

ensure-regression-tests's Issues

Handle pull requests that don't target master

Problem

Pull requests that don't target the master branch currently fail because the Travis build doesn't have a copy of any non-master branch refs due to the way it clones the repo.

Proposed solution

Add a git fetch step before trying to checkout the target branch so we have the required refs.

Explain adding rake task dependencies

Problem

When using scraper_test it creates a test:data rake task. In order to run this rake task as part of ensure-regression-tests it needs to be added as a dependency of the test rake task. This isn't currently documented anywhere.

Proposed solution

Add a section to the README that explains how to add a dependency to the test rake task so that you can run other tests as part of this script.

For example adding test:data as a dependency of the test task would look like this:

task test: 'test:data'

Expand README.md

It would be good if the README included at least the following:

• Explanation of what this script does
• How to use the latest version (by having master in the URL)
• How to use a specific version (e.g. with SHA or tag in the URL)

Checks fail when PR targets a branch other than master

Problem

ensure-regression-tests fail when the PR targets a branch other than master.

error: pathspec '<target-branch-name>' did not match any file(s) known to git.