Note: The default ITS GitLab runner is a shared resource and is subject to slowdowns during heavy usage.
You can run your own GitLab runner that is dedicated just to your group if you need to avoid processing delays.

Commit e9ef6f03 authored by Ben Balk's avatar Ben Balk
Browse files

Initial text for README.md

parent 0341316d
# GoGit-M
An automated way to test your code for vulereabilities!
## Getting Started
It couldn't be easier to get started. Simply create a file in your repo called .gitlab-ci.yml and paste the following text into it:
---
stages:
- sast
bandit:
stage: sast
image: python:latest
script:
- pip install bandit
- bandit -r .
allow_failure: true
### Prerequisites
Your code repo needs to be hosted in GitLab (https://gitlab.umich.edu)
```
Give examples
```
## Running the tests
Simply by creating the .gitlab-ci.yml file in your repo, GitLab will begin automatically testing your code using the shared GitLab Runner.
### Break down into end to end tests
Out of the box we are offering an easy entry point into automatically testing your python code for static vulnerabilities.
```
Give an example
```
## Authors
* **Rick Getchell** - rgetchel@umich.edu
* **Patrick Steffes** - psteffes@umich.edu
* **Greg Benn** - gbenn@umich.edu
* **Ben Balk** - bbalk@umich.edu
## Acknowledgments
* The 2019 Hacks With Friends Volunteers
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment