Skip to content

Commit ec78674

Browse files
authored
Add Dependabot (#42)
* Update README instructions This commit addresses several minor issues that exist in the README: - A different intro section was used that did not specify the need for Maven or Gradle, since the wrappers are being used. - The instructions on building a jar had the wrong artifact listed. Since building a jar is not required here and the testing instructions are a bit long, the jar section was removed. - Removed instructions about SpringBootApplication annotation, since this is not mentioned in the guide. - Removed links at the bottom of the page that result in a 404. - The project id was not set and the links were not rendering correctly. * Configure dependabot for project updates
1 parent f7bf5bb commit ec78674

File tree

4 files changed

+49
-14
lines changed

4 files changed

+49
-14
lines changed

.github/dependabot.yml

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
version: 2
2+
updates:
3+
4+
- package-ecosystem: "maven"
5+
directories:
6+
- "/initial"
7+
- "/complete"
8+
ignore:
9+
- dependency-name: "*"
10+
update-types: ["version-update:semver-patch"]
11+
schedule:
12+
interval: "monthly"
13+
target-branch: "main"
14+
groups:
15+
guide-dependencies-maven:
16+
patterns:
17+
- "*"
18+
19+
- package-ecosystem: "gradle"
20+
directories:
21+
- "/initial"
22+
- "/complete"
23+
ignore:
24+
- dependency-name: "*"
25+
update-types: ["version-update:semver-patch"]
26+
schedule:
27+
interval: "monthly"
28+
target-branch: "main"
29+
groups:
30+
guide-dependencies-gradle:
31+
patterns:
32+
- "*"

README.adoc

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@
33
:toc:
44
:icons: font
55
:source-highlighter: prettify
6+
:project_id: gs-accessing-data-rest
7+
:java_version: 17
68

79
This guide walks you through the process of creating an application that accesses
810
relational JPA data through a link:/guides/gs/rest-hateoas[hypermedia-based]
@@ -21,11 +23,7 @@ Neo4j], link:/guides/gs/accessing-gemfire-data-rest[Spring Data Gemfire], and
2123
link:/guides/gs/accessing-mongodb-data-rest[Spring Data MongoDB] as backend data stores,
2224
but those are not part of this guide.
2325

24-
== What You Need
25-
26-
include::https://raw.githubusercontent.com/spring-guides/getting-started-macros/main/prereq_editor_jdk_buildtools.adoc[]
27-
28-
include::https://raw.githubusercontent.com/spring-guides/getting-started-macros/main/how_to_complete_this_guide.adoc[]
26+
include::https://raw.githubusercontent.com/spring-guides/getting-started-macros/main/guide_introduction.adoc[]
2927

3028
[[scratch]]
3129
== Starting with Spring Initializr
@@ -89,8 +87,6 @@ value of `/persons`.
8987
Here you have also defined a custom query to retrieve a list of `Person` objects based on
9088
the `lastName`. You can see how to invoke it later in this guide.
9189

92-
include::https://raw.githubusercontent.com/spring-guides/getting-started-macros/main/spring-boot-application-new-path.adoc[]
93-
9490
Spring Boot automatically spins up Spring Data JPA to create a concrete implementation of
9591
the `PersonRepository` and configure it to talk to a back end in-memory database by using
9692
JPA.
@@ -101,11 +97,18 @@ components link up to the Spring Data JPA backend. When you use Spring Boot, thi
10197
autoconfigured. If you want to investigate how that works, by looking at the
10298
`RepositoryRestMvcConfiguration` in Spring Data REST.
10399

104-
include::https://raw.githubusercontent.com/spring-guides/getting-started-macros/main/build_an_executable_jar_subhead.adoc[]
100+
== Running the Application
105101

106-
include::https://raw.githubusercontent.com/spring-guides/getting-started-macros/main/build_an_executable_jar_with_both.adoc[]
102+
You can now run the application by executing the main method in `AccessingDataRestApplication`.
103+
You can run the program from your IDE, or by executing the following Gradle command in the project root directory:
104+
```
105+
./gradlew bootRun
106+
```
107107

108-
Logging output is displayed. The service should be up and running within a few seconds.
108+
Alternatively, you could use Maven to run the application using the command:
109+
```
110+
./mvnw spring-boot:run
111+
```
109112

110113
== Test the Application
111114

@@ -394,8 +397,6 @@ The following guides may also be helpful:
394397
* https://spring.io/guides/gs/accessing-data-mysql/[Accessing data with MySQL]
395398
* https://spring.io/guides/gs/accessing-neo4j-data-rest/[Accessing Neo4j Data with REST]
396399
* https://spring.io/guides/gs/consuming-rest/[Consuming a RESTful Web Service]
397-
* https://spring.io/guides/gs/consuming-rest-angularjs/[Consuming a RESTful Web Service with AngularJS]
398-
* https://spring.io/guides/gs/consuming-rest-jquery/[Consuming a RESTful Web Service with jQuery]
399400
* https://spring.io/guides/gs/securing-web/[Securing a Web Application]
400401
* https://spring.io/guides/tutorials/rest/[Building REST services with Spring]
401402
* https://spring.io/guides/gs/spring-boot/[Building an Application with Spring Boot]

complete/build.gradle

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
11
plugins {
22
id 'org.springframework.boot' version '3.3.0'
3-
id 'io.spring.dependency-management' version '1.1.5'
43
id 'java'
54
}
65

6+
apply plugin: 'io.spring.dependency-management'
7+
78
group = 'com.example'
89
version = '0.0.1-SNAPSHOT'
910
sourceCompatibility = '17'

initial/build.gradle

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
11
plugins {
22
id 'org.springframework.boot' version '3.3.0'
3-
id 'io.spring.dependency-management' version '1.1.5'
43
id 'java'
54
}
65

6+
apply plugin: 'io.spring.dependency-management'
7+
78
group = 'com.example'
89
version = '0.0.1-SNAPSHOT'
910
sourceCompatibility = '17'

0 commit comments

Comments
 (0)