Skip to content

Commit 43db857

Browse files
committed
Update importer
1 parent 3bb38c6 commit 43db857

File tree

5 files changed

+24
-8
lines changed

5 files changed

+24
-8
lines changed
117 KB
Loading
121 KB
Loading
80.1 KB
Loading
Binary file not shown.

source/docs/software/vscode-overview/importing-last-years-robot-code.rst

Lines changed: 24 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,33 +6,49 @@ Due to changes in the project, it is necessary to update the build files for a p
66

77
To make it easy for teams to import previous years gradle projects into the current year's framework, WPILib includes a wizard for importing previous years projects into VS Code. This will generate the necessary gradle components and load the project into VS Code. In place upgrades are not supported.
88

9-
.. important:: The import process copies your project source files from the current directory to a new directory and completely regenerates the gradle files. Additionally, it updates the code for the package changes made in 2025. If you made non-standard updates to the ``build.gradle``, you will need to make those changes again. For this reason, in place upgrades are not supported. It is also necessary to import vendor libraries again, since last year's vendor libraries must be updated to be compatible with this year's projects.
9+
.. important:: The import process copies your project source files from the current directory to a new directory and completely regenerates the gradle files. Additionally, it updates the code for the package changes and reorganization made in 2027. If you made non-standard updates to the ``build.gradle``, you will need to make those changes again. For this reason, in place upgrades are not supported. It is also necessary to import vendor libraries again, since last year's vendor libraries must be updated to be compatible with this year's projects.
1010

1111
### Launching the Import Wizard
1212

1313
.. image:: images/importing-previous-project/ImportPopup.png
1414

1515
When you open a previous year's project, you will be prompted to import that project. Click :guilabel:`yes`.
1616

17-
Alternately, you can chose to import it from the menu. Press :kbd:`Ctrl+Shift+P` and type "WPILib" or click the WPILib icon to locate the WPILib commands. Begin typing "Import a WPILib 2020-2024 Gradle project" and select it from the dropdown as shown below.
17+
Alternately, you can chose to import it from the menu. Press :kbd:`Ctrl+Shift+P` and type "WPILib" or click the WPILib icon to locate the WPILib commands. Begin typing "Import a WPILib 2025 Gradle project" and select it from the dropdown as shown below.
1818

1919
.. image:: images/importing-previous-project/ImportGradleMenu.png
2020

21-
.. image:: images/importing-previous-project/VSCodeImport.png
21+
.. image:: images/importing-previous-project/VSCodeImport-source.png
22+
:alt: The Select Source Project:alt: The Select Source Project window of the WPILib Project Importer
2223

23-
You'll be presented with the WPILib Project Importer window. This is similar to the process of creating a new project and the window and the steps are shown below. This window contains the following elements:
24+
You'll be presented with the WPILib Project Importer window. This is similar to the process of creating a new project.
2425

25-
1. **Gradle Project**: Selects the project to be imported. Users should select the build.gradle file in the root directory of the gradle project.
26-
2. **Project Location**: This determines the folder in which the robot project will be located.
26+
1. **Gradle Project**: Selects the project to be imported. Users should select the build.gradle file in the root directory of the gradle project. If you started the importer by openeing a previous year's project, this will be pre-populated
27+
28+
After making the selections, click :guilabel:`Next`.
29+
30+
This will bring up the Configure Project window.
31+
32+
.. image:: images/importing-previous-project/VSCodeImport-source.png
33+
:alt: The Configure Project window of the WPILib Project Importer
34+
35+
2. **Base Folder**: This determines the folder in which the robot project will be located.
2736
3. **Project Name**: The name of the robot project. This also specifies the name that the project folder will be given if the Create New Folder box is checked. This must be a different directory from the original location.
2837
4. **Create a New Folder**: If this is checked, a new folder will be created to hold the project within the previously-specified folder. If it is *not* checked, the project will be located directly in the previously-specified folder. An error will be thrown if the folder is not empty and this is not checked.
2938
5. **Team Number**: The team number for the project, which will be used for package names within the project and to locate the robot when deploying code.
3039
6. **Enable Desktop Support**: If this is checked, simulation and unit test support is enabled. However, there are some cases where this will do some unexpected things. In addition, all vendor libraries need desktop support which not all libraries do.
31-
7. **Import Romi Project**: If this is checked, the project is imported using the Romi gradle template. This should only be checked for Romi projects.
40+
7. **Hardware Platform**: Choose where this project will be run, Systemcore, Romi, or XRP.
3241

3342
.. warning:: Creating projects on OneDrive is not supported as OneDrive's caching interferes with the build system. Some Windows installations put the Documents and Desktop folders on OneDrive by default.
3443

35-
Click :guilabel:`Import Project` to begin the upgrade.
44+
After making the selections, click :guilabel:`Next`.
45+
46+
This will bring up the Review & Import window.
47+
48+
.. image:: images/importing-previous-project/VSCodeImport-review.png
49+
:alt: The Review & Import window of the WPILib Project Importer
50+
51+
Double check all the settings and click :guilabel:`Import Project` to begin the upgrade.
3652

3753
The gradle project will be upgraded and copied into the new project directory. You can then either open the new project immediately using the pop-up below or open it later using the :kbd:`Ctrl+O` (or :kbd:`Command+O` for macOS) shortcut.
3854

0 commit comments

Comments
 (0)