https://github.com/oakvilledynamics/2024-robot
2024 FRC Source Code for Crescendo
https://github.com/oakvilledynamics/2024-robot
frc frc-crescendo frc-java frc-robot wpilib
Last synced: 3 months ago
JSON representation
2024 FRC Source Code for Crescendo
- Host: GitHub
- URL: https://github.com/oakvilledynamics/2024-robot
- Owner: OakvilleDynamics
- License: other
- Created: 2024-01-17T21:44:13.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-01-05T22:08:06.000Z (5 months ago)
- Last Synced: 2025-01-30T23:51:10.974Z (4 months ago)
- Topics: frc, frc-crescendo, frc-java, frc-robot, wpilib
- Language: Java
- Homepage:
- Size: 554 KB
- Stars: 2
- Watchers: 4
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Oakville Dynamics Cresendo 2024 Robot
The source code for our 2024 FRC Robot for Cresendo. Prepackaged with GitHub Actions for CI/CD, Qodana for static analysis, CodeQL for static analysis and security scanning, Spotless for code formatting, and Gradle Validation for validating the Gradle wrapper.
## Build Status
| Action | Status |
| ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| CI | [](https://github.com/OakvilleDynamics/2024-Robot/actions/workflows/ci.yml) |
| Qodana | [](https://github.com/OakvilleDynamics/2024-Robot/actions/workflows/qodana.yml) |
| CodeQL | [](https://github.com/OakvilleDynamics/2024-Robot/actions/workflows/codeql.yml) |
| Spotless | [](https://github.com/OakvilleDynamics/2024-Robot/actions/workflows/syntax-check.yml) |
| Gradle Validation | [](https://github.com/OakvilleDynamics/2024-Robot/actions/workflows/gradle-wrapper-validation.yml) |
## How to use
1. Clone repository
2. Open the project in your WPILib Visual Studio Code (VS Code) after cloning
3. Start hacking away!
## Features
- Preconfigured setup for GitHub Actions (helpful for [CI/CD](https://en.wikipedia.org/wiki/CI/CD))
- Build action for building the robot code (helpful for ensuring code compiles)
- [Qodana](https://www.jetbrains.com/qodana/) action for static analysis (helpful for finding bugs and code smells)
- [CodeQL](https://codeql.github.com/) action for static analysis and security scanning (helpful for finding bugs and security vulnerabilities)
- [Spotless](https://github.com/diffplug/spotless) enforcement action for code formatting (helpful for keeping code cleanly formatted after commits)
- [Gradle Validation](https://github.com/gradle/wrapper-validation-action/tree/v1/?tab=readme-ov-file#the-gradle-wrapper-problem-in-open-source) action for validating the Gradle wrapper (helpful for ensuring [supply chain](https://en.wikipedia.org/wiki/Supply_chain_attack) security)
- Preconfigured setup for [Command-Based Robot](https://docs.wpilib.org/en/stable/docs/software/commandbased/index.html) projects (helpful for getting started)
- [Dependabot](https://docs.github.com/en/code-security/dependabot) for dependency updates (helpful for keeping dependencies up to date)
- Preconfigured setup for [Spotless](https://github.com/diffplug/spotless) inside of Gradle (helpful for keeping code cleanly formatted during development)
## Requirements
- WPILib 2024.3.1
- Internet connection (for Gradle to download dependencies)