Skip to content

Commit 778d66b

Browse files
authored
Merge branch 'main' into docs-upload-csv
2 parents dcb6f36 + a920b6d commit 778d66b

3 files changed

Lines changed: 58 additions & 2 deletions

File tree

Gemfile.lock

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ GEM
3030
em-websocket (0.5.3)
3131
eventmachine (>= 0.12.9)
3232
http_parser.rb (~> 0)
33-
erb (6.0.3)
33+
erb (6.0.4)
3434
ethon (0.16.0)
3535
ffi (>= 1.15.0)
3636
eventmachine (1.2.7)
@@ -222,7 +222,7 @@ GEM
222222
gemoji (>= 3, < 5)
223223
html-pipeline (~> 2.2)
224224
jekyll (>= 3.0, < 5.0)
225-
json (2.19.3)
225+
json (2.19.9)
226226
kramdown (2.4.0)
227227
rexml
228228
kramdown-parser-gfm (1.1.0)

_docs/developer/testing/cypress.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,8 @@ If you are on Linux, view [this page](https://docs.cypress.io/guides/getting-sta
2323

2424
If you are on WSL and run into an error, make sure you installed `node.js` on your desktop (Program Files) and not inside your local Submitty repository.
2525

26+
*Note: If you encounter issues launching Cypress, run* `npm update` *from the site directory.*
27+
2628
## Cypress Test Runner
2729

2830
You can open the test runner by navigating into `site/` and using the command:

_docs/developer/troubleshooting/installation_troubleshooting.md

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -289,3 +289,57 @@ Some things to check:
289289
rm -rf /Users/MY_HOME_DIRECTORY/.vagrant.d/
290290
rm -rf /Users/MY_HOME_DIRECTORY/.gem/specs/rubygems.org%443/quick/Marshal.4.8/vagrant-vbguest-0.31.0.gemspec
291291
```
292+
___
293+
294+
## Troubleshooting Pre-Packaged VM
295+
296+
Some issues with the pre-packaged VM can be fixed by installing a different version. Once you've installed a pre-packaged VM, it does not recieve version updates, so it can also be a good idea to update the pre-packaged version periodically. To see your current VM version, run `vagrant box list` and look at the output. You should see something like `SubmittyBot/ubuntu22-dev (virtualbox, 26.06.00.2606070357, (amd64))`. In this case, `26.06.00.2606070357` is the version number.
297+
298+
After running `vagrant box list`, you may see multiple versions of the VM. If you want to know what version the VM is using when you run `vagrant up`, follow these steps:
299+
300+
1. Run `vagrant up` and look at the output.
301+
2. You should see something like `==> ubuntu-22.04: Checking if box 'SubmittyBot/ubuntu22-dev' version '26.06.00.2606070357' is up to date...`.
302+
303+
In this case, `26.06.00.2606070357` is the version number.
304+
305+
If you have multiple versions of the VM, you can also run `vagrant box prune` to remove the old versions.
306+
307+
### Instructions for Updating the Pre-Packaged VM Version
308+
From your main Submitty repository, e.g. `<SOMETHING>/GIT_CHECKOUT/Submitty/`, run:
309+
310+
```
311+
vagrant box update
312+
```
313+
314+
This will download the newest version of the VM. It will take approximately 30 minutes to download.
315+
316+
### Instructions for Specifying the Pre-Packaged VM Version
317+
318+
These steps may be useful if you wish to roll your VM back or to upgrade to a version besides the newest available.
319+
320+
From your main Submitty repository, e.g. `<SOMETHING>/GIT_CHECKOUT/Submitty/`, run:
321+
322+
```
323+
vagrant destroy
324+
```
325+
326+
This will destroy your current VM and reset the Vagrant environment.
327+
328+
*Note: If you have more than one VM (perhaps by accident), you can see a list of VMs with the command* `vagrant global-status`. *VMs listed will be given a unique id. You can then run* `vagrant destroy 1a2b3c4d`. *Replace* `1a2b3c4d` *with the id of the VM you wish to destroy.*
329+
330+
Then, on Linux/MacOS, type:
331+
```
332+
PREBUILT_VERSION={version} vagrant up --provider=virtualbox
333+
```
334+
335+
or on Windows, type:
336+
```
337+
SET PREBUILT_VERSION={version}
338+
vagrant up --provider=virtualbox
339+
```
340+
341+
If you are importing a new version, it will take approximately 30 minutes to download.
342+
343+
*The version must be only the numbers, not including the* `v` *in front, for example* `26.06.00.2606070357` *not* `v26.06.00.2606070357`.
344+
345+
*Note: You can find pre-packaged Submitty VM versions on the [Hashicorp Vagrant Box Catalog](https://portal.cloud.hashicorp.com/vagrant/discover/SubmittyBot/ubuntu22-dev) by navigating to the 'Versions' tab in the sidebar. Make sure to follow the [Submitty installation instructions](/developer/getting_started/vm_install_using_vagrant) when setting up your development environment. A complete list of Vagrant commands can be found here: [Hashicorp Vagrant CLI Docs](https://developer.hashicorp.com/vagrant/docs/cli).*

0 commit comments

Comments
 (0)