← Back to issue list

fix(docs): Update Spring Boot tutorial

View original Github issue

Metadata

Project
rockcraft
Number
#1139
Type
pull request
State
merged
Author
erinecon
Labels
Created
Updated
Closed

Current evaluation

Merged docs update fixing Spring Boot tutorial rock packing failures. Adjusts project path, removes manual directory steps, and increases VM RAM to 2GB to prevent freezing. Approved and merged despite expected persistent CI failures.

Suggested action:

No scores available.

Issue body

We received user feedback that the Spring Boot tutorial currently doesn’t work. Currently, the tutorial asks you to create the rock under `spring-boot-hello-world` but the packing fails because Rockcraft can’t find the project files. The current tutorial needs the user to create and pack the rock under `spring-boot-hello-world/maven-app` instead. This PR aligns the Spring Boot tutorial with its corresponding Charmcraft tutorial during the app creation stage, by setting the `path` to be `spring-boot-hello-world`. Since the directory creation is now handled by devpack-for-spring, this PR also removes the instructions to manually create the directory. Another piece of user feedback we received was that the VM freezes during the rock packing stage. Through testing, we determined that the minimum viable VM for this tutorial requires 2 GB of RAM. This PR updates `docs/reuse/tutorial/setup_edge.rst` so that the VM is created with 2 GB of RAM, acknowledging that this change will also affect some other tutorials in the project. --- - [X] I've followed the [contribution guidelines](https://github.com/canonical/rockcraft/blob/main/CONTRIBUTING.md). - [X] I've signed the [CLA](http://www.ubuntu.com/legal/contributors/). - [X] I've successfully run `make lint && make test`. - [X] I've added or updated any relevant documentation.

Evaluation history

Date Model Scores Action Summary
qwen/qwen3.6-35b-a3b Merged docs update fixing Spring Boot tutorial rock packing failures. Adjusts project path, removes manual directory steps, and increases VM RAM to 2GB to prevent freezing. Approved and merged despite expected persistent CI failures.
qwen3.6-35b-a3b-mtp-q6 Merged docs updates fixing Spring Boot tutorial packing failures and VM freezing. Adjusts path to spring-boot-hello-world, removes manual directory creation, and sets VM RAM to 2GB. Force-merged by Tiago despite expected CI failures.
qwen3.6-35b-a3b-mtp-q6 Merged via force-merge after maintainer confirmed expected CI failures. Updated the Spring Boot tutorial to fix packing failures by adjusting the project path, removing manual directory steps, and increasing VM RAM to 2GB to prevent freezing.

Update history

No update history recorded yet.

Related issues

Issue Project State Summary Similarity
#1025 docs: fix 'spring boot framework' rockcraft merged Merged a documentation update fixing a title spelling error and hiding page headings from the TOC. Approved by two reviewers with passing CI checks. The change modified two lines in one file.
74%