Skip to content

Add pre-push hook instruction to README #64

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 4 commits into from
Closed

Add pre-push hook instruction to README #64

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
31853a7
Add pre-push hook instruction to README
indocomsoft Jun 24, 2018
6f01eb1
I derped
indocomsoft Jun 24, 2018
56c014a
Merge branch 'master' into pre-push
indocomsoft Jun 24, 2018
d4f5d0e
Merge branch 'master' into pre-push
indocomsoft Jun 25, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 54 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,60 @@ Cadet is the web application powering Source Academy.
4. PostgreSQL (>= 9.6)
5. git (>= 2.13.2)

### Git's `pre-push` hook
We are using following script as a `pre-push` hook.

```bash
#!/bin/sh

echo Running pre-push hooks...

echo mix format
if ! mix format --check-formatted; then
exit 1
fi

echo mix test
if ! mix test; then
exit 1
fi

echo mix credo
if ! mix credo; then
exit 1
fi

exit 0
```

An automated way to install the script is:

```bash
cat > .git/hooks/pre-push <<EOL
#!/bin/sh

echo Running pre-push hooks...

echo mix format
if ! mix format --check-formatted; then
exit 1
fi

echo mix test
if ! mix test; then
exit 1
fi

echo mix credo
if ! mix credo; then
exit 1
fi

exit 0
EOL
chmod +x .git/hooks/pre-push
```

### Setting Up Local Development Environment

Install Elixir dependencies
Expand Down