Skip to content

Commit 2949b2c

Browse files
MarioRivisMarioRivis
committed
Config file is now taken from the config folder.
Added README.md. Added release.yml and modified other workflows. Fixed Depedabot Guava issue.
1 parent 074ea29 commit 2949b2c

File tree

7 files changed

+96
-69
lines changed

7 files changed

+96
-69
lines changed

‎.github/workflows/build.yml

+2-12
Original file line numberDiff line numberDiff line change
@@ -2,28 +2,18 @@ name: Build
22

33
# Run build on pull requests to the `master` branch
44
on:
5-
pull_request:
6-
branches:
7-
- master
5+
push:
86

97
jobs:
108
build:
119
runs-on: ubuntu-18.04
1210
steps:
1311
- uses: actions/checkout@v2
1412

15-
- name: Cache maven local repository
16-
uses: actions/cache@v1
17-
with:
18-
path: ~/.m2/repository
19-
key: ${{ runner.os }}-maven-${{ hashFiles('**/pom.xml') }}
20-
restore-keys: |
21-
${{ runner.os }}-maven-
22-
2313
- name: Set up Java for publishing to GitHub Packages
2414
uses: actions/setup-java@v1
2515
with:
26-
java-version: 1.8
16+
java-version: 11
2717

2818
- name: Maven Install
2919
run: mvn clean install

‎.github/workflows/deploy.yml

-23
This file was deleted.

‎.github/workflows/release.yml

+49
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
on:
2+
push:
3+
tags:
4+
- 'v*'
5+
6+
name: Upload Release Asset
7+
8+
jobs:
9+
release:
10+
name: Release
11+
runs-on: ubuntu-latest
12+
steps:
13+
- name: Checkout code
14+
uses: actions/checkout@v2
15+
- name: Build
16+
run: mvn clean install
17+
- name: Prepare Assets
18+
run: |
19+
mkdir github-miner
20+
mkdir github-miner/results
21+
mkdir github-miner/config
22+
cp README.md github-miner/README.md
23+
cp target/githubminer.jar github-miner/githubminer.jar
24+
cp bin/githubminer.bat github-miner/githubminer.bat
25+
cp bin/githubminer.sh github-miner/githubminer.sh
26+
cp github-miner.properties github-miner/config/github-miner.properties
27+
chmod +x github-miner/githubminer.sh
28+
- name: Create Archive
29+
run: zip -r github-miner.zip github-miner
30+
- name: Create Release
31+
id: create_release
32+
uses: actions/create-release@v1
33+
env:
34+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
35+
with:
36+
tag_name: ${{ github.ref }}
37+
release_name: ${{ github.ref }}
38+
draft: false
39+
prerelease: false
40+
- name: Upload Release Asset
41+
id: upload-release-asset
42+
uses: actions/upload-release-asset@v1
43+
env:
44+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
45+
with:
46+
upload_url: ${{ steps.create_release.outputs.upload_url }}
47+
asset_path: ./github-miner.zip
48+
asset_name: github-miner.zip
49+
asset_content_type: application/zip

‎README.md

+27-3
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,31 @@
11
# Github Miner
2-
This app is a Java library for using the Github REST API.
2+
GithubMiner is an open source tool that connects to a Github server and fetches basic information about Pull Requests and Code Review activities.
3+
4+
This app also contains a Kotlin library for using the Github REST API.
35

46
Visit us on [Github](https://github.com/dxworks/github-miner).
57

6-
## Features
7-
To be added...
8+
## Download
9+
Please download our [latest release](https://github.com/dxworks/github-miner/releases) from Github and unzip the folder.
10+
The contents of the folder are as follows:
11+
* `githubminer.jar` (executable jar file)
12+
* `githubminer.sh` (executable file for linux / macOS)
13+
* `githubminer.bat` (executable file for windows)
14+
* `config/github-miner.properties` (configuration folder)
15+
* `results` (a folder for GithubMiner to put result files in)
16+
17+
## Configure
18+
To configure GithubMiner, please open the config/github-miner.properties and add the configuration fields.
19+
20+
#### github.base.path
21+
the URL to the Github Enterprise servers, postfixed with /api/v3; an example would be
22+
https://github.my-organisation.com/api/v3. If omitted, the default value is the Github Cloud API url: https://api.github.com
23+
24+
#### github.tokens
25+
A comma separated list of [Personal Access Tokens](https://docs.github.com/en/free-pro-team@latest/github/authenticating-to-github/creating-a-personal-access-token), used for authentication. If the server you are connected to has Rate Limits activated (like Github Cloud does), Github Miner will perform faster if multiple tokens (from different users) are provided.
26+
27+
#### github.repos
28+
A comma separated list of repositories, in the for `owner/repo`, For example, for the Kafka and Spring Framework repository, the value would be: `apache/kafka,spring-projects/spring-framework`
29+
30+
## Run
31+
Run GithubMiner using the `githubminer.bat` or `githubminer.sh` script, with no parameters. When GithubMiner finishes it will generate a JSON file, placed in the “results” sub-folder, for each of the repositories given as parameters. The name of the files are ABC-prs.json, whereby ABC is the repository name.

‎github-miner.properties

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
#github.base.path=http://localhost:4004
2-
github.tokens=fcec1eda167ac289c082f05e2a43a45a0cab5a2d
3-
github.repos=cadeca/weasylearn-be,cadeca/weasylearn-fe, swimlane/ngx-datatable, facebook/react
2+
github.tokens=
3+
github.repos=

‎pom.xml

+2-24
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
<groupId>org.dxworks</groupId>
88
<artifactId>github-miner</artifactId>
9-
<version>1.0.3-SNAPSHOT</version>
9+
<version>1.1.0-SNAPSHOT</version>
1010

1111
<licenses>
1212
<license>
@@ -39,7 +39,6 @@
3939
<testSourceDirectory>${project.basedir}/src/test/kotlin</testSourceDirectory>
4040
<plugins>
4141
<plugin>
42-
<!-- For more, refer https://maven.apache.org/surefire/maven-surefire-plugin/ -->
4342
<groupId>org.apache.maven.plugins</groupId>
4443
<artifactId>maven-surefire-plugin</artifactId>
4544
<version>3.0.0-M3</version>
@@ -101,27 +100,6 @@
101100
</plugins>
102101
</build>
103102

104-
<profiles>
105-
<profile>
106-
<id>github-default</id>
107-
<activation>
108-
<activeByDefault>true</activeByDefault>
109-
</activation>
110-
<distributionManagement>
111-
<repository>
112-
<id>github</id>
113-
<name>GitHub dxworks Apache Maven Packages</name>
114-
<url>https://maven.pkg.github.com/dxworks/github-miner</url>
115-
</repository>
116-
<snapshotRepository>
117-
<id>github</id>
118-
<name>GitHub dxworks Apache Maven Packages</name>
119-
<url>https://maven.pkg.github.com/dxworks/github-miner</url>
120-
</snapshotRepository>
121-
</distributionManagement>
122-
</profile>
123-
</profiles>
124-
125103
<dependencies>
126104
<dependency>
127105
<groupId>org.jetbrains.kotlin</groupId>
@@ -162,7 +140,7 @@
162140
<dependency>
163141
<groupId>com.google.guava</groupId>
164142
<artifactId>guava</artifactId>
165-
<version>29.0-jre</version>
143+
<version>30.0-jre</version>
166144
</dependency>
167145
<dependency>
168146
<groupId>com.goterl.lazycode</groupId>

‎src/main/kotlin/org/dxworks/githubminer/Main.kt

+14-5
Original file line numberDiff line numberDiff line change
@@ -12,29 +12,38 @@ import org.dxworks.githubminer.config.RepoListField
1212
import org.dxworks.githubminer.constants.ANONYMOUS
1313
import org.dxworks.githubminer.constants.GITHUB_API_PATH
1414
import org.dxworks.utils.java.rest.client.utils.JsonMapper
15-
import java.io.File
15+
import java.nio.file.Files
16+
import java.nio.file.Paths
1617

1718
private const val GITHUB_REPOS = "github.repos"
1819
private const val GITHUB_TOKENS = "github.tokens"
1920
private const val GITHUB_BASE_PATH = "github.base.path"
2021

22+
private const val RESULTS_FOLDER = "results"
23+
2124
fun main(args: Array<String>) {
22-
val argumenthor = Argumenthor(ArgumenthorConfiguration(listOf(
25+
val argumenthor = Argumenthor(ArgumenthorConfiguration(
26+
listOf(
2327
StringField(GITHUB_BASE_PATH, GITHUB_API_PATH),
2428
RepoListField(GITHUB_REPOS, emptyList()),
2529
StringListField(GITHUB_TOKENS, listOf(ANONYMOUS))
26-
)).apply {
30+
)
31+
).apply {
2732
addSource(ArgsSource().also { it.argsList = args.toList() })
28-
addSource(PropertiesSource().also { it.path = "github-miner.properties" })
33+
addSource(PropertiesSource().also { it.path = "config/github-miner.properties" })
2934
addSource(EnvSource())
3035
})
3136

3237
val githubBasePath: String = argumenthor.getValue(GITHUB_BASE_PATH)!!
3338
val repos: List<Repo> = argumenthor.getValue(GITHUB_REPOS)!!
3439
val tokens: List<String> = argumenthor.getValue(GITHUB_TOKENS)!!
3540

41+
val resultsPath = Paths.get(RESULTS_FOLDER)
42+
if(!Files.exists(resultsPath))
43+
resultsPath.toFile().mkdirs()
44+
3645
repos.forEach { repo ->
3746
val export = GithubRepoExporter(repo.user, repo.repo, githubBasePath, tokens).export()
38-
JsonMapper().writeJSONtoFile(File("${repo.user}-${repo.repo}-prs.json"), export)
47+
JsonMapper().writeJSONtoFile(Paths.get(RESULTS_FOLDER, "${repo.user}-${repo.repo}-prs.json").toFile(), export)
3948
}
4049
}

0 commit comments

Comments
 (0)