Smart Dashboard Version Display

FacePalmGamer · February 9, 2019, 4:40pm

Hi, my team is working on our robot code and one of my mentors asked if there was a way to put a version number of the code or of the last build date straight onto the dashboard. This would allow users to see what version of the code we were on. We are using git with VS Code to push and pull code, and we wanted to know if there was a way to pull a date or version number from anywhere in the code to store in a variable that we won’t have to change manually. My mentors suggested looking in files like the build.gradle to see if it left a date log for the last build time but I didn’t see anything. Any suggestions?

andrewda · February 9, 2019, 5:42pm

This feature has helped solve so many issues for our team over the past two years, and is relatively easy to implement! Here’s a few Gradle functions from one of our 2018 robots that retrieve the git hash, git branch, build time and list of files changes since the last commit.

github.com

SouthEugeneRoboticsTeam/BunnyBots-2018/blob/master/build.gradle#L97-L133


def getGitHash = { ->
def stdout = new ByteArrayOutputStream()
exec {
    commandLine "git", "rev-parse", "HEAD"
    standardOutput = stdout
}
return stdout.toString().trim()
}


def getGitBranch = { ->
def stdout = new ByteArrayOutputStream()
exec {
    commandLine "git", "rev-parse", "--abbrev-ref", "HEAD"
    standardOutput = stdout
}
return stdout.toString().trim()
}


def getGitFilesChanged = { ->
def stdout = new ByteArrayOutputStream()

This file has been truncated. show original

These functions work by running various git commands and recording their output. Then, these values are saved to resource files in src/main/resources/ and then read from our robot code and posted to the NetworkTables:

github.com

SouthEugeneRoboticsTeam/BunnyBots-2018/blob/master/src/main/java/org/sert2521/bunnybots/util/Telemetry.kt#L51-L80


fun logBuildInfo() {
println("\n-------------------- BUILD INFO --------------------")


"branch.txt".asResource {
    println("Branch: $it")
    GlobalTelemetry.put("Branch", it)
}


"commit.txt".asResource {
    println("Commit: $it")
    GlobalTelemetry.put("Commit", it)
}


"changes.txt".asResource {
    println("Changes: [$it]")
    GlobalTelemetry.put("Changes", it)
}


"buildtime.txt".asResource {
    println("Build Time: $it")

This file has been truncated. show original