GitXplorerGitXplorer
j

julia-helper

public
1 stars
0 forks
0 issues

Commits

List of commits on branch master.
Unverified
d097bdb5822d9d40151af04bd2b58d9d0a2970e2

Add git testing

jjiahao committed 10 years ago
Unverified
b4dd1e0dc1e0bd90deab8ce1c91f1f7404e619e7

Return an error exit code correctly

jjiahao committed 10 years ago
Unverified
dfd8a84d7aa64abd1c479b8c6d52935de057bb81

Fix typo in travis_lint variable

jjiahao committed 10 years ago
Unverified
f8542280c9e0b126d73f14745f0e608199b61d7c

Incrementally run various tests only if the relevant files change

jjiahao committed 10 years ago
Unverified
1165741f1e1ba498f3ae93736fbf3910b5d42dba

Add pre-commit and pre-push hooks

jjiahao committed 10 years ago
Unverified
78be9301dcdf10065a71b52ba956e76288cacb1f

Initial commit

jjiahao committed 10 years ago

README

The README file for this repository.

julia-helper

Scripts to help Julia developers

What's this?

This repository contains some git hooks, which are user level scripts that are run by git automatically when certain commands are executed. Currently pre-commit and pre-push hooks are provided, which are run before the usual git commit and git push commands respectively. The idea is to provide checks to be run each time code is checked in. These git hooks can be bypassed with --no-verify to the appropriate git command.

pre-commit runs make whitespace to check for whitespace.

pre-push runs more extensive checks before allowing commits to be pushed:

  • Checks .travis.yml to ensure that it is a valid Travis configuration
  • Checks that the documentation can be built in both HTML and PDF formats
  • Runs the entire Julia test suite

Prerequisites

  • A git checkout of Julia. The path will be referred to here as $JULIAHOME.
  • A build environment suitable for building Julia.
  • (Optional) travis-yaml, the Travis Configuration Parser
  • (Optional) Python with virtualenv installed, for testing that the documentation builds
  • (Optional) pdflatex for building PDF documentation. (Some documentation issues are only uncovered in the PDF build.)

Installation

Simply copy the git hooks to the appropriate .git/hooks subdirectory of your Julia repository, or append to your existing git hooks.

Example:

ln -s julia-helper/julia/git-hooks/pre-push.sample $JULIAHOME/.git/hooks/pre-push
ln -s julia-helper/julia/git-hooks/pre-commit.sample $jULIAHOME/.git/hooks/pre-commit