Skip to content

Commit befa732

Browse files
Merge pull request #20 from oracle/topic_github_sync1
bug fixes and review incorporated for spring io integration
2 parents 0c0854e + fef9ac9 commit befa732

File tree

60 files changed

+1119
-1150
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

60 files changed

+1119
-1150
lines changed

Makefile

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,19 +3,23 @@
33
# Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl/
44
# ----------------------------------------------------------------------------
55

6-
.PHONY: format build docs
6+
.PHONY: clean build docs
7+
8+
mvncmd=mvnd
9+
10+
ifeq (, $(shell which ${mvncmd}))
11+
mvncmd=mvn
12+
endif
713

8-
format:
9-
mvnd spotless:apply
1014

1115
build:
12-
mvnd verify -DskipTests
16+
${mvncmd} verify -DskipTests
1317

1418
clean:
15-
mvnd clean
19+
${mvncmd} clean
1620

1721
docs:
18-
mvnd verify -Pasciidocs -DskipTests=true
22+
${mvncmd} verify -Pasciidocs -DskipTests=true
1923

2024
javadocs:
21-
mvnd clean package javadoc:aggregate -DskipTests=true -e
25+
${mvncmd} clean package javadoc:aggregate -DskipTests=true -e

README.md

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
## Introduction
1212
Spring Cloud for OCI, eases the integration with OCI services with the help of OCI Java SDK internally. It offers a convenient way to interact with OCI-provided services using well-known Spring idioms and APIs, such as the messaging or storage API. Developers can build their applications around the hosted services without having to care about infrastructure or maintenance. Spring Cloud for OCI contains auto-configuration support for OCI-managed services.
1313

14-
All Spring Cloud for OCI artifacts are made available through Maven Central. Developers can bootstrap their application with Spring Initializr and add the OCI Support dependency. With Spring Cloud for OCI, the developers only need to add some annotations and a small number of configurations to connect Spring Cloud applications to the OCI services.
14+
All Spring Cloud for OCI artifacts are made available through Maven Central. With Spring Cloud for OCI, the developers only need to add some annotations and a small number of configurations to connect Spring Cloud applications to the OCI services.
1515

1616
## Spring Cloud OCI documentation
1717

@@ -35,7 +35,6 @@ This project has dependency and transitive dependencies on Spring Projects. The
3535
You may checkout samples for the each service supported by Spring Cloud OCI below.
3636

3737
* [OCI Storage Sample](./spring-cloud-oci-samples/spring-cloud-oci-storage-sample/)
38-
* [OCI Email Service Sample](./spring-cloud-oci-samples/spring-cloud-oci-email-sample/)
3938
* [OCI Notification Service Sample](./spring-cloud-oci-samples/spring-cloud-oci-notification-sample/)
4039
* [OCI Logging Service Sample](./spring-cloud-oci-samples/spring-cloud-oci-logging-sample/)
4140

@@ -73,11 +72,6 @@ Clean:
7372
make clean
7473
```
7574

76-
Format code:
77-
```
78-
make format
79-
```
80-
8175
## Documentation
8276

8377
Java docs can be generated with below command

docs/pom.xml

Lines changed: 0 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -118,35 +118,4 @@ Licensed under the Universal Permissive License v 1.0 as shown at https://oss.or
118118
</build>
119119
</profile>
120120
</profiles>
121-
<build>
122-
<plugins>
123-
<plugin>
124-
<groupId>com.diffplug.spotless</groupId>
125-
<artifactId>spotless-maven-plugin</artifactId>
126-
<executions>
127-
<execution>
128-
<phase>validate</phase>
129-
<configuration>
130-
<skip>${disable.checks}</skip>
131-
</configuration>
132-
<goals>
133-
<goal>apply</goal>
134-
<goal>check</goal>
135-
</goals>
136-
</execution>
137-
</executions>
138-
</plugin>
139-
</plugins>
140-
</build>
141-
<dependencyManagement>
142-
<dependencies>
143-
<dependency>
144-
<groupId>com.oracle.cloud.spring</groupId>
145-
<artifactId>spring-cloud-oci-dependencies</artifactId>
146-
<version>${project.version}</version>
147-
<type>pom</type>
148-
<scope>import</scope>
149-
</dependency>
150-
</dependencies>
151-
</dependencyManagement>
152121
</project>

docs/src/main/asciidoc/core.adoc

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,3 @@ A compartment is a logical container, to organize and control access to the Orac
8484
----
8585
spring.cloud.oci.compartment.static = <COMPARTMENT_OCID>
8686
----
87-
88-
=== Spring Initializr
89-
90-
This starter is available from https://start.spring.io/[Spring Initializr] through the `OCI Support` entry.

docs/src/main/asciidoc/email.adoc

Lines changed: 0 additions & 89 deletions
This file was deleted.

docs/src/main/asciidoc/getting-started.adoc

Lines changed: 0 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -44,16 +44,6 @@ A summary of these artifacts are provided below.
4444

4545
|===
4646

47-
==== Spring Initializr
48-
49-
https://start.spring.io/[Spring Initializr] is a tool which generates the scaffolding code for a new Spring Boot project.
50-
It handles the work of generating the Maven or Gradle build file so you do not have to manually add the dependencies yourself.
51-
52-
Spring Initializr offers below modules from Spring Cloud OCI that you can use to generate your project.
53-
54-
- *OCI Support*: The OCI Support module contains auto-configuration support for every Spring Cloud OCI integration.
55-
Most of the autoconfiguration code is only enabled if the required dependency is added to your project.
56-
- *OCI Storage*: OCI Storage integrations work out of the box.
5747

5848
=== Learning Spring Cloud OCI
5949

@@ -77,9 +67,6 @@ The table below highlights several samples of the most commonly used integration
7767
| Cloud Logging
7868
| https://github.com/oracle/spring-cloud-oci/tree/main/spring-cloud-oci-samples/spring-cloud-oci-logging-sample[spring-cloud-oci-logging-sample]
7969

80-
| Cloud Email
81-
| https://github.com/oracle/spring-cloud-oci/tree/main/spring-cloud-oci-samples/spring-cloud-oci-email-sample[spring-cloud-oci-email-sample]
82-
8370
|===
8471

8572
Each sample application demonstrates how to use Spring Cloud OCI libraries in context and how to setup the dependencies for the project.

docs/src/main/asciidoc/index.adoc

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,6 @@ include::core.adoc[]
2222

2323
include::storage.adoc[]
2424

25-
include::email.adoc[]
26-
2725
include::notifications.adoc[]
2826

2927
include::logging.adoc[]

docs/src/main/asciidoc/logging.adoc

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,6 @@ dependencies {
2626
}
2727
----
2828

29-
This starter is also available from https://start.spring.io/[Spring Initializr] through the `OCI Logging` entry.
30-
3129
=== Using Cloud Logging
3230

3331
The starter automatically configures and registers a `Logging` bean in the Spring application context.

docs/src/main/asciidoc/notifications.adoc

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,6 @@ dependencies {
2626
}
2727
----
2828

29-
This starter is also available from https://start.spring.io/[Spring Initializr] through the `OCI Notifications` entry.
30-
3129
=== Using Cloud Notifications
3230

3331
The starter automatically configures and registers a `Notification` bean in the Spring application context.

docs/src/main/asciidoc/storage.adoc

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,6 @@ dependencies {
2626
}
2727
----
2828

29-
This starter is also available from https://start.spring.io/[Spring Initializr] through the `OCI Storage` entry.
30-
3129
=== Using Cloud Storage
3230

3331
The starter automatically configures and registers a `Storage` bean in the Spring application context.

0 commit comments

Comments
 (0)