Skip to content

Commit

Permalink
Make some documentation updates about creating a release
Browse files Browse the repository at this point in the history
  • Loading branch information
ewpratten committed Oct 6, 2020
1 parent 6b227d7 commit 9b5a6d9
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 32 deletions.
36 changes: 11 additions & 25 deletions docs/installation/Compiling-Lib5K-From-Source.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,9 @@
Compiling Lib5K from source is reasonably simple.

## Compiling for testing

Just like any gradle project, we can do a local build with

```sh
# Linux
./gradlew build
Expand All @@ -12,40 +14,24 @@ Just like any gradle project, we can do a local build with
.\gradlew.bat build
```

## Compiling a local copy of the documentation
If you are looking to view the JavaDoc locally, you can manually generate it with:
```sh
# Linux
./gradlew clean build document
### Compile errors

# Windows
.\gradlew.bat clean build document
```
There are a few possibilities for compile errors when building the project for the first time. See the [troubleshooting](/lib5k/technical/Troubleshooting) page for solutions.

Keep in mind, any code pushed to the `master` branch will automatically have its javadoc built in our CI pipeline by [`.github/workflows/docs.yml`](https://github.com/frc5024/lib5k/blob/master/.github/workflows/docs.yml), and will be published to [frc5024.github.io/lib5k](https://frc5024.github.io/lib5k).
## Compiling a local copy of the documentation

## Building a test release
If you are looking to view the JavaDoc locally, you can manually generate it with:

If you are making a change to Lib5K that is needed for a robot project, but you don't have time to make a proper release (or the build is of a test branch), you can build only the needed files with:
```sh
# Linux
./gradlew clean buildBeta
./gradlew clean :lib5k:build :lib5k:customJavadoc

# Windows
.\gradlew.bat clean buildBeta
.\gradlew.bat clean :lib5k:build :lib5k:customJavadoc
```

The library files will be exported to the `_release` folder.

## Building a full release

To build a proper release of Lib5K (only do this on the `master` branch), first update the version number in `build.gradle`, then run:
```sh
# Linux
./gradlew clean buildRelease
Keep in mind, any code pushed to the `master` branch will automatically have its javadoc built in our CI pipeline by [`.github/workflows/docs.yml`](https://github.com/frc5024/lib5k/blob/master/.github/workflows/docs.yml), and will be published to [frc5024.github.io/lib5k/javadoc](https://frc5024.github.io/lib5k/javadoc).

# Windows
.\gradlew.bat clean buildRelease
```
## Building a release for testing

The library files will be exported to the `_release` folder. Make a [new release](https://github.com/frc5024/lib5k/releases/new) on GitHub, and upload all generated files.
It is very common to manually build yourself a release of Lib5K for use in another project. This is generally caused by a quick fix being required, when you don't have time to make a full library release on GitHub. To build a "beta" release of Lib5K, make sure you are in the branch you are wanting to build, then go run the command listed in the [releasing a new version](/lib5k/installation/Creating-a-release) guide. Instead of uploading the files to GitHub, just copy them over to your other project.
13 changes: 7 additions & 6 deletions docs/installation/Creating-a-Lib5K-Project.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,13 @@
The process for creating a robot project that uses Lib5K is a little different from the normal process for setting up a WPILib project. This document is specifically written for 5024 members.

## The steps
1) Creating a base project
2) Downloading and configuring Lib5K as a Java library
3) Download all vendor configuration files
4) Setting up GitHub CI
5) Configuring the correct Java package
6) Ensuring everything works

1. Creating a base project
2. Downloading and configuring Lib5K as a Java library
3. Download all vendor configuration files
4. Setting up GitHub CI
5. Configuring the correct Java package
6. Ensuring everything works

## Creating a base project

Expand Down
2 changes: 1 addition & 1 deletion docs/technical/Troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ While Lib5K uses and imports third-party libraries, only the java bindings are a

## When building Lib5K, I get a ton of errors about NavX, TalonSRX, and SparkMax

These are caused by the way gradle is currently set up. We are waiting on an unpdate from WPILib, but for now, just run this command once:
These are caused by the way gradle is currently set up. We are waiting on an update from WPILib, but for now, just run this command once:

```sh
./gradlew bootstrap
Expand Down

0 comments on commit 9b5a6d9

Please sign in to comment.