Skip to content

Commit d20fbb0

Browse files
authored
Swap out rebelib (#14)
2 parents f20d714 + 4af0883 commit d20fbb0

25 files changed

Lines changed: 1525 additions & 227 deletions

.github/workflows/build.yml

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,6 @@ jobs:
1111
steps:
1212
- name: Checkout repository
1313
uses: actions/checkout@v4
14-
with:
15-
submodules: 'recursive'
1614
- name: Grant execute permission
1715
run: chmod +x gradlew
1816
- name: Build robot code

.github/workflows/check-format.yml

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,6 @@ jobs:
1313
steps:
1414
- name: Checkout code
1515
uses: actions/checkout@v4
16-
with:
17-
submodules: 'recursive'
1816

1917
- name: Set up JDK
2018
uses: actions/setup-java@v4

.github/workflows/javadoc.yml

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,6 @@ jobs:
1414
steps:
1515
- name: Checkout repository
1616
uses: actions/checkout@v4
17-
with:
18-
submodules: 'recursive'
1917

2018
- name: Set up JDK
2119
uses: actions/setup-java@v4

.github/workflows/lint.yml

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,6 @@ jobs:
1616
steps:
1717
- name: Checkout code
1818
uses: actions/checkout@v4
19-
with:
20-
submodules: 'recursive'
2119

2220
- name: Set up JDK
2321
uses: actions/setup-java@v4

.github/workflows/submodule-check.yml

Lines changed: 0 additions & 21 deletions
This file was deleted.

.gitmodules

Lines changed: 0 additions & 3 deletions
This file was deleted.

README.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
Open git bash or your sh of choice and run the following commands:
1616

1717
```sh
18-
git clone --recurse-submodules --remote-submodules <the URL of this repository>.git
18+
git clone <the URL of this repository>.git
1919
cd <the name of the repository>
2020
./scripts/install-hooks.sh
2121
```
@@ -26,11 +26,9 @@ Then open the root directory of the repository in WPILib VSCode
2626

2727
All code changes should happen on a branch, and then a PR should be opened and reviewed by multiple senior members or leads before being merged. Commits should contain a single set of related changes, and commit names should be descriptive of their contents. Err on the side of granularity when committing, as it's easier to clean up later. Push whenever code is in a reasonable state and prior to leaving. Pull often, and keep up with changes on `main` and other branches. Reviews should be thorough, lest you tear your hair out debugging later (do *not* LGTM). No code should go into `main` that hasn't been simulated thoroughly and/or tested on a robot, and no incomplete or in-progress code should be merged. All code should be formatted on build, and should follow WPILib command-based programming best practices.
2828

29-
## RebeLib
29+
## Lib Directory
3030

31-
RebeLib exists within this project as a git submodule, managed by a set of scripts. To make changes to RebeLib, change into the `src/main/java/frc/RebeLib` directory and branch, commit, and push your changes. Once your RebeLib changes are pushed to a branch, you can commit and push to this project. A Github Action requires that RebeLib be set to the newest `main` before merging, so any PRs to RebeLib must be merged first. Once RebeLib is merged, pull it from this project and commit the new hash to make the Action pass so that you can merge.
32-
33-
Any code that is season-agnostic should live in RebeLib, and should be maintained.
31+
The `lib` directory (`rebellion-template/src/main/java/frc/lib`) contains reusable files and utilities. This should be copy-paste-able between robot projects (relying on nothing outside the `lib` directory) and should be self contained. These files can be moved, added, or removed as needed.
3432

3533
## Github Pages Javadoc
3634

scripts/check-submodule.sh

Lines changed: 0 additions & 60 deletions
This file was deleted.

scripts/hooks/pre-push

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
#!/bin/sh
22

3-
./scripts/update-submodule.sh src/main/java/frc/RebeLib
4-
53
./scripts/check-gradlew.sh
64
if [ $? -ne 0 ]; then
75
exit 1

scripts/install-hooks.sh

Lines changed: 0 additions & 38 deletions
This file was deleted.

0 commit comments

Comments
 (0)