diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml new file mode 100644 index 0000000..3127591 --- /dev/null +++ b/.github/workflows/main.yml @@ -0,0 +1,31 @@ +name: Python App Workflow + +on: + push: + branches: + - main + +jobs: + build: + + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v2 + with: + fetch-depth: 0 + + - name: Set up Python + uses: actions/setup-python@v2 + with: + python-version: '3.8' + + - name: Install dependencies + run: | + python3 -m pip install --upgrade pip + pip3 install -r requirements.txt + + - name: Run GitMiner + run: | + cp config.json.example config.json + python3 gitminer.py --help diff --git a/README.md b/README.md index 3bb9f48..574888a 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -Logo +Logo # GHE Miner GitMiner will query Github useful source code data at the Enterprise, Organization or Repository level. @@ -50,20 +50,19 @@ Get a single repo from an org: Local run: ``` -$ python gitminer.py --hostname acme --org DevOps --repo GitMiner +$ python3 gitminer.py --hostname acme --org DevOps --repo ghe-miner ``` - Get all repos for a single org: ``` -$ python gitminer.py --hostname acme --org DevOps +$ python3 gitminer.py --hostname acme --org DevOps ``` Get all repos for all orgs: ``` -$ python gitminer.py --hostname acme --all +$ python3 gitminer.py --hostname acme --all ``` # Sample Output diff --git a/img/ghe-miner.png b/img/ghe-miner.png deleted file mode 100644 index c2aed70..0000000 Binary files a/img/ghe-miner.png and /dev/null differ diff --git a/img/gitminer.png b/img/gitminer.png new file mode 100644 index 0000000..60f4fd0 Binary files /dev/null and b/img/gitminer.png differ