wpilibsuite/wpilib-docs

Document GradleRIO predeploy task for running commands before robot program deploy and start

Open

#1,150 opened on Jan 25, 2021

View on GitHub
 (4 comments) (0 reactions) (0 assignees)JavaScript (297 forks)auto 404
Component: WPILibJ/WPILibCHelp WantedType: New Article

Repository metrics

Stars
 (187 stars)
PR merge metrics
 (PR metrics pending)

Description

The following gradle-fu I learned from @ThadHouse is very useful for running commands as admin on the roboRIO before the robot program deploys and starts. We should document it. (Note that the robot program is deleted at this point.)

deploy {
    ...
    artifacts {
        frcNativeArtifact('frcCpp') {
            ...
            predeploy << {
                // Give RT capability
                it.execute('setcap cap_sys_nice+eip /home/lvuser/frcUserProgram')

                // Disable crond because it uses 50% CPU and there's no cronjobs to run
                it.execute('/etc/init.d/crond stop')

                // Disable NI web server because it leaks memory badly
                it.execute('/usr/local/natinst/etc/init.d/systemWebServer stop')

                // Compress old log files
                it.execute('find . -type f | grep \\.csv$ | xargs -d \\n gzip -q')
            }
        }

Contributor guide

Research direction
Review the existing documentation on GradleRIO deployment and add a section on the predeploy task to execute commands before the robot program deploys.
Tech stack
groovy
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90