Docker Compose Guide Update #31
Merged
Conversation
This file contains 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
added 4 commits
June 20, 2024 07:22
This commit adds dependencies and a Docker Compose file that is required to change the guide to use Docker compose support. In this commit, only the complete folder is considered.
Documented instructions for using Spring Boot Docker Compose support to run the guide. This is the preferred option for runnign the guide. Additional instructions for homebrew installation were removed. A section was added about running the application as a jar and as a container. Native compilation was excluded as it would require a custom hint because of how the guide is written. Native was excluded as it was not simple to implement and custom hints are beyond the scope of this guide.
The initial folder is modified so that it is a true representation of what will be downloaded from Spring Initializr. This includes adding the new Docker Compose dependency as well as a compose.yaml file.
This was referenced Jun 20, 2024
mp911de
reviewed
Jun 21, 2024
Buzzardo
suggested changes
Jun 25, 2024
Buzzardo
reviewed
Jun 26, 2024
| include::https://raw.githubusercontent.com/spring-guides/getting-started-macros/main/build_an_executable_jar_with_both.adoc[] | ||
| You can run the main method through your IDE. | ||
| Note that, if you have cloned the project from the solution repository, your IDE may look in the wrong place for the `compose.yaml` file. | ||
| You can configure your IDE to look in the correct place or you could use the command line to run the application. |
There was a problem hiding this comment.
Change could to can (so that the tense matches).
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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 PR rewrites a large portion of the guide to use Spring Boot Docker Compose Support. The pattern is similar to updates previously merged in MySQL.
Instructions on using Homebrew were removed in favor of a preference to use Spring Boot Docker compose support. This should allow for an easier getting started experience and not be specific to Mac users.
Additionally to adding Docker Compose, a section was added to run the application as a jar file and a Docker container. The Native section of the common file was excluded because this guide will require a custom hint to compile natively.
Also addresses issues #29 and #30.