Fixing Issue #14173 – Update grails Command Documentation for Grails 7 #14809
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
updated with clarifications for Grails 7 and marked with // NEW: comments
clarify Forge CLI usage for --java-version commands - Updated documentation examples to explicitly use `grails -t forge` for create-app and related commands - Replaced shell prompt (`grails>`) with terminal syntax (`grails -t forge`) where appropriate - Added notes clarifying that `create-app` and similar scaffolding commands belong to grails-forge-cli - Updated --help output blocks to reflect Forge CLI behavior
Reviewed 23 documentation files and updated 19 of them, with comments, related to the `create-app` command as part of Issue apache#14173. Key changes: - Added `-t forge` flag to all instances of the `grails create-app`, `create-plugin`, and similar commands to reflect Grails 7 CLI usage. - Inserted version-specific NOTE blocks where appropriate to distinguish behavior between Grails 6 (and lower) and 7. - Retained legacy command examples where relevant for backward compatibility and historical context.
jdaugherty reviewed Jun 13, 2025
Contributor
jdaugherty left a comment
jdaugherty left a comment There was a problem hiding this comment.
Let's remove the redundant comments to get started? After that, I can take another pass at this review.
fix: updated comment formatting per review
Contributor
| @irllyliketoast Thanks for taking this on! 👍 |
Contributor Author
I can review that again momentarily. Thank you for the clarification! |
jdaugherty reviewed Jun 13, 2025
grails-doc/src/en/guide/gettingStarted/usingInteractiveMode.adoc Outdated Show resolved Hide resolved
docs: clarify usage of Shell CLI vs Forge CLI in create-app and related commands - Updated multiple documentation files to reflect changes introduced in Grails 7, which now supports both the grails-shell-cli and grails-forge-cli in parallel. - Clarified that 'grails create-app' defaults to the Shell CLI, and that 'grails -t forge create-app' is only required for Forge-specific flags like --jdk. - Removed or reworded incorrect assumptions that Forge CLI is always required. - Added or updated relevant notes, examples, and flag descriptions to match actual CLI behavior. - Ensured interactive mode is correctly attributed to the Shell CLI only. - Preserved original file structure and formatting throughout. - Deletion of grails-doc/src/en/guide/REST/angularProfile.adoc due to removal of the angular profile in Grails 7 as per the instruction of James Daugherty.
we now guide users to the rest-profile instead
jamesfredley approved these changes Jun 18, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit. This suggestion is invalid because no changes were made to the code. Suggestions cannot be applied while the pull request is closed. Suggestions cannot be applied while viewing a subset of changes. Only one suggestion per line can be applied in a batch. Add this suggestion to a batch that can be applied as a single commit. Applying suggestions on deleted lines is not supported. You must change the existing code in this line in order to create a valid suggestion. Outdated suggestions cannot be applied. This suggestion has been applied or marked resolved. Suggestions cannot be applied from pending reviews. Suggestions cannot be applied on multi-line comments. Suggestions cannot be applied while the pull request is queued to merge. Suggestion cannot be applied right now. Please check back later.
This pull request addresses Issue #14173, which aims to clarify usage of
grailsCLI commands now that both CLI shells—grails-shell-cliandgrails-forge-cli—are shipped together in Grails 7. The goal was to identify all relevantcreate-appand--java-versionmentions and specify when-t forgeis required for Grails Forge commands.grails -t forgewhere Forge-specific commands are shown.- grails create-app: default shell (grails-shell-cli)
- grails -t forge create-app: for Forge-specific options (e.g.,
--java-version)-t forgewhere Forge command flags were present or implied