Spring/spring-boot
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Fix property description of spring.docker.compose.file

Browse Source 
Also fixes the casing of 'Docker Compose' so that it's now spelled
consistently.
This commit is contained in:
Moritz Halbritter
2024-08-12 13:52:14 +02:00
parent 5141045f6f
commit 6031d04837
28 changed files with 48 additions and 48 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
spring-boot-project/spring-boot-docker-compose/src/main/java/org/springframework/boot/docker/compose/core/DockerCli.java
View File

@@ -56,8 +56,8 @@ class DockerCli {
/**
* Create a new {@link DockerCli} instance.
* @param workingDirectory the working directory or {@code null}
* @param composeFile the docker compose file to use
* @param activeProfiles the docker compose profiles to activate
* @param composeFile the Docker Compose file to use
* @param activeProfiles the Docker Compose profiles to activate
*/
DockerCli(File workingDirectory, DockerComposeFile composeFile, Set<String> activeProfiles) {
this.processRunner = new ProcessRunner(workingDirectory);
@@ -112,7 +112,7 @@ class DockerCli {
/**
* Return the {@link DockerComposeFile} being used by this CLI instance.
* @return the docker compose file
* @return the Docker Compose file
*/
DockerComposeFile getDockerComposeFile() {
return this.composeFile;
@@ -156,7 +156,7 @@ class DockerCli {
DockerCliComposeVersionResponse response = DockerJson.deserialize(
processRunner.run("docker", "compose", "version", "--format", "json"),
DockerCliComposeVersionResponse.class);
logger.trace(LogMessage.format("Using docker compose %s", response.version()));
logger.trace(LogMessage.format("Using Docker Compose %s", response.version()));
return List.of("docker", "compose");
}
catch (ProcessExitException ex) {

4
spring-boot-project/spring-boot-docker-compose/src/main/java/org/springframework/boot/docker/compose/core/DockerCliComposeVersionResponse.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2012-2023 the original author or authors.
* Copyright 2012-2024 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -19,7 +19,7 @@ package org.springframework.boot.docker.compose.core;
/**
* Response from {@code docker compose version}.
*
* @param version docker compose version
* @param version the Docker Compose version
* @author Moritz Halbritter
* @author Andy Wilkinson
* @author Phillip Webb

2
spring-boot-project/spring-boot-docker-compose/src/main/java/org/springframework/boot/docker/compose/core/DockerCompose.java
View File

@@ -118,7 +118,7 @@ public interface DockerCompose {
/**
* Factory method used to create a {@link DockerCompose} instance.
* @param file the docker compose file
* @param file the Docker Compose file
* @param hostname the hostname used for services or {@code null} if the hostname
* should be deduced
* @param activeProfiles a set of the profiles that should be activated

14
spring-boot-project/spring-boot-docker-compose/src/main/java/org/springframework/boot/docker/compose/core/DockerComposeFile.java
View File

@@ -29,7 +29,7 @@ import java.util.stream.Collectors;
import org.springframework.util.Assert;
/**
* A reference to a docker compose file (usually named {@code compose.yaml}).
* A reference to a Docker Compose file (usually named {@code compose.yaml}).
*
* @author Moritz Halbritter
* @author Andy Wilkinson
@@ -61,8 +61,8 @@ public final class DockerComposeFile {
}
/**
* Returns the source docker compose files.
* @return the source docker compose files
* Returns the source Docker Compose files.
* @return the source Docker Compose files
* @since 3.4.0
*/
public List<File> getFiles() {
@@ -95,7 +95,7 @@ public final class DockerComposeFile {
}
/**
* Find the docker compose file by searching in the given working directory. Files are
* Find the Docker Compose file by searching in the given working directory. Files are
* considered in the same order that {@code docker compose} uses, namely:
* <ul>
* <li>{@code compose.yaml}</li>
@@ -105,7 +105,7 @@ public final class DockerComposeFile {
* </ul>
* @param workingDirectory the working directory to search or {@code null} to use the
* current directory
* @return the located file or {@code null} if no docker compose file can be found
* @return the located file or {@code null} if no Docker Compose file can be found
*/
public static DockerComposeFile find(File workingDirectory) {
File base = (workingDirectory != null) ? workingDirectory : new File(".");
@@ -126,7 +126,7 @@ public final class DockerComposeFile {
/**
* Create a new {@link DockerComposeFile} for the given {@link File}.
* @param file the source file
* @return the docker compose file
* @return the Docker Compose file
*/
public static DockerComposeFile of(File file) {
Assert.notNull(file, "File must not be null");
@@ -138,7 +138,7 @@ public final class DockerComposeFile {
/**
* Creates a new {@link DockerComposeFile} for the given {@link File files}.
* @param files the source files
* @return the docker compose file
* @return the Docker Compose file
* @since 3.4.0
*/
public static DockerComposeFile of(Collection<? extends File> files) {

6
spring-boot-project/spring-boot-docker-compose/src/main/java/org/springframework/boot/docker/compose/core/DockerComposeOrigin.java
View File

@@ -19,10 +19,10 @@ package org.springframework.boot.docker.compose.core;
import org.springframework.boot.origin.Origin;
/**
* An origin which points to a service defined in docker compose.
* An origin which points to a service defined in Docker Compose.
*
* @param composeFile docker compose file
* @param serviceName name of the docker compose service
* @param composeFile the Docker Compose file
* @param serviceName name of the Docker Compose service
* @author Moritz Halbritter
* @author Andy Wilkinson
* @since 3.1.0

4
spring-boot-project/spring-boot-docker-compose/src/main/java/org/springframework/boot/docker/compose/core/RunningService.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2012-2023 the original author or authors.
* Copyright 2012-2024 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -19,7 +19,7 @@ package org.springframework.boot.docker.compose.core;
import java.util.Map;
/**
* Provides details of a running docker compose service.
* Provides details of a running Docker Compose service.
*
* @author Moritz Halbritter
* @author Andy Wilkinson

2
spring-boot-project/spring-boot-docker-compose/src/main/java/org/springframework/boot/docker/compose/core/package-info.java
View File

@@ -15,6 +15,6 @@
*/
/**
* Core interfaces and classes for working with docker compose.
* Core interfaces and classes for working with Docker Compose.
*/
package org.springframework.boot.docker.compose.core;

2
spring-boot-project/spring-boot-docker-compose/src/main/java/org/springframework/boot/docker/compose/lifecycle/DockerComposeLifecycleManager.java
View File

@@ -42,7 +42,7 @@ import org.springframework.util.Assert;
import org.springframework.util.CollectionUtils;
/**
* Manages the lifecycle for docker compose services.
* Manages the lifecycle for Docker Compose services.
*
* @author Moritz Halbritter
* @author Andy Wilkinson

8
spring-boot-project/spring-boot-docker-compose/src/main/java/org/springframework/boot/docker/compose/lifecycle/DockerComposeProperties.java
View File

@@ -42,12 +42,12 @@ public class DockerComposeProperties {
static final String NAME = "spring.docker.compose";
/**
* Whether docker compose support is enabled.
* Whether Docker Compose support is enabled.
*/
private boolean enabled = true;
/**
* Path to a specific docker compose configuration file.
* Paths to the Docker Compose configuration files.
*/
private final List<File> file = new ArrayList<>();
@@ -138,7 +138,7 @@ public class DockerComposeProperties {
public static class Start {
/**
* Command used to start docker compose.
* Command used to start Docker Compose.
*/
private StartCommand command = StartCommand.UP;
@@ -230,7 +230,7 @@ public class DockerComposeProperties {
public static class Stop {
/**
* Command used to stop docker compose.
* Command used to stop Docker Compose.
*/
private StopCommand command = StopCommand.STOP;

4
spring-boot-project/spring-boot-docker-compose/src/main/java/org/springframework/boot/docker/compose/lifecycle/DockerComposeServicesReadyEvent.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2012-2023 the original author or authors.
* Copyright 2012-2024 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -48,7 +48,7 @@ public class DockerComposeServicesReadyEvent extends ApplicationEvent {
}
/**
* Return the relevant docker compose services that are running.
* Return the relevant Docker Compose services that are running.
* @return the running services
*/
public List<RunningService> getRunningServices() {

8
spring-boot-project/spring-boot-docker-compose/src/main/java/org/springframework/boot/docker/compose/service/connection/DockerComposeConnectionSource.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2012-2023 the original author or authors.
* Copyright 2012-2024 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -20,7 +20,7 @@ import org.springframework.boot.docker.compose.core.RunningService;
/**
* Passed to {@link DockerComposeConnectionDetailsFactory} to provide details of the
* {@link RunningService running docker compose service}.
* {@link RunningService running Docker Compose service}.
*
* @author Moritz Halbritter
* @author Andy Wilkinson
@@ -34,14 +34,14 @@ public final class DockerComposeConnectionSource {
/**
* Create a new {@link DockerComposeConnectionSource} instance.
* @param runningService the running docker compose service
* @param runningService the running Docker Compose service
*/
DockerComposeConnectionSource(RunningService runningService) {
this.runningService = runningService;
}
/**
* Return the running docker compose service.
* Return the running Docker Compose service.
* @return the running service
*/
public RunningService getRunningService() {

2
spring-boot-project/spring-boot-docker-compose/src/main/java/org/springframework/boot/docker/compose/service/connection/activemq/package-info.java
View File

@@ -15,6 +15,6 @@
*/
/**
* Auto-configuration for docker compose ActiveMQ service connections.
* Auto-configuration for Docker Compose ActiveMQ service connections.
*/
package org.springframework.boot.docker.compose.service.connection.activemq;

2
spring-boot-project/spring-boot-docker-compose/src/main/java/org/springframework/boot/docker/compose/service/connection/cassandra/package-info.java
View File

@@ -15,6 +15,6 @@
*/
/**
* Auto-configuration for docker compose Cassandra service connections.
* Auto-configuration for Docker Compose Cassandra service connections.
*/
package org.springframework.boot.docker.compose.service.connection.cassandra;

2
spring-boot-project/spring-boot-docker-compose/src/main/java/org/springframework/boot/docker/compose/service/connection/elasticsearch/package-info.java
View File

@@ -15,6 +15,6 @@
*/
/**
* Auto-configuration for docker compose Elasticsearch service connections.
* Auto-configuration for Docker Compose Elasticsearch service connections.
*/
package org.springframework.boot.docker.compose.service.connection.elasticsearch;

2
spring-boot-project/spring-boot-docker-compose/src/main/java/org/springframework/boot/docker/compose/service/connection/flyway/package-info.java
View File

@@ -15,6 +15,6 @@
*/
/**
* Auto-configuration for docker compose Flyway service connections.
* Auto-configuration for Docker Compose Flyway service connections.
*/
package org.springframework.boot.docker.compose.service.connection.flyway;

2
spring-boot-project/spring-boot-docker-compose/src/main/java/org/springframework/boot/docker/compose/service/connection/liquibase/package-info.java
View File

@@ -15,6 +15,6 @@
*/
/**
* Auto-configuration for docker compose Liquibase service connections.
* Auto-configuration for Docker Compose Liquibase service connections.
*/
package org.springframework.boot.docker.compose.service.connection.liquibase;

2
spring-boot-project/spring-boot-docker-compose/src/main/java/org/springframework/boot/docker/compose/service/connection/mariadb/package-info.java
View File

@@ -15,6 +15,6 @@
*/
/**
* Auto-configuration for docker compose MariaDB service connections.
* Auto-configuration for Docker Compose MariaDB service connections.
*/
package org.springframework.boot.docker.compose.service.connection.mariadb;

2
spring-boot-project/spring-boot-docker-compose/src/main/java/org/springframework/boot/docker/compose/service/connection/mongo/package-info.java
View File

@@ -15,6 +15,6 @@
*/
/**
* Auto-configuration for docker compose MongoDB service connections.
* Auto-configuration for Docker Compose MongoDB service connections.
*/
package org.springframework.boot.docker.compose.service.connection.mongo;

2
spring-boot-project/spring-boot-docker-compose/src/main/java/org/springframework/boot/docker/compose/service/connection/mysql/package-info.java
View File

@@ -15,6 +15,6 @@
*/
/**
* Auto-configuration for docker compose MySQL service connections.
* Auto-configuration for Docker Compose MySQL service connections.
*/
package org.springframework.boot.docker.compose.service.connection.mysql;

2
spring-boot-project/spring-boot-docker-compose/src/main/java/org/springframework/boot/docker/compose/service/connection/neo4j/package-info.java
View File

@@ -15,6 +15,6 @@
*/
/**
* Auto-configuration for docker compose Neo4j service connections.
* Auto-configuration for Docker Compose Neo4j service connections.
*/
package org.springframework.boot.docker.compose.service.connection.neo4j;

2
spring-boot-project/spring-boot-docker-compose/src/main/java/org/springframework/boot/docker/compose/service/connection/oracle/package-info.java
View File

@@ -15,6 +15,6 @@
*/
/**
* Auto-configuration for docker compose MySQL service connections.
* Auto-configuration for Docker Compose MySQL service connections.
*/
package org.springframework.boot.docker.compose.service.connection.oracle;

2
spring-boot-project/spring-boot-docker-compose/src/main/java/org/springframework/boot/docker/compose/service/connection/otlp/package-info.java
View File

@@ -15,6 +15,6 @@
*/
/**
* Support for docker compose OpenTelemetry service connections.
* Support for Docker Compose OpenTelemetry service connections.
*/
package org.springframework.boot.docker.compose.service.connection.otlp;

2
spring-boot-project/spring-boot-docker-compose/src/main/java/org/springframework/boot/docker/compose/service/connection/postgres/package-info.java
View File

@@ -15,6 +15,6 @@
*/
/**
* Auto-configuration for docker compose Postgres service connections.
* Auto-configuration for Docker Compose Postgres service connections.
*/
package org.springframework.boot.docker.compose.service.connection.postgres;

2
spring-boot-project/spring-boot-docker-compose/src/main/java/org/springframework/boot/docker/compose/service/connection/pulsar/package-info.java
View File

@@ -15,6 +15,6 @@
*/
/**
* Auto-configuration for docker compose Pulsar service connections.
* Auto-configuration for Docker Compose Pulsar service connections.
*/
package org.springframework.boot.docker.compose.service.connection.pulsar;

2
spring-boot-project/spring-boot-docker-compose/src/main/java/org/springframework/boot/docker/compose/service/connection/rabbit/package-info.java
View File

@@ -15,6 +15,6 @@
*/
/**
* Auto-configuration for docker compose RabbitMQ service connections.
* Auto-configuration for Docker Compose RabbitMQ service connections.
*/
package org.springframework.boot.docker.compose.service.connection.rabbit;

2
spring-boot-project/spring-boot-docker-compose/src/main/java/org/springframework/boot/docker/compose/service/connection/redis/package-info.java
View File

@@ -15,6 +15,6 @@
*/
/**
* Auto-configuration for docker compose Redis service connections.
* Auto-configuration for Docker Compose Redis service connections.
*/
package org.springframework.boot.docker.compose.service.connection.redis;

2
spring-boot-project/spring-boot-docker-compose/src/main/java/org/springframework/boot/docker/compose/service/connection/sqlserver/package-info.java
View File

@@ -15,6 +15,6 @@
*/
/**
* Auto-configuration for docker compose MS SQL Server service connections.
* Auto-configuration for Docker Compose MS SQL Server service connections.
*/
package org.springframework.boot.docker.compose.service.connection.sqlserver;

2
spring-boot-project/spring-boot-docker-compose/src/main/java/org/springframework/boot/docker/compose/service/connection/zipkin/package-info.java
View File

@@ -15,6 +15,6 @@
*/
/**
* Auto-configuration for docker compose Zipkin service connections.
* Auto-configuration for Docker Compose Zipkin service connections.
*/
package org.springframework.boot.docker.compose.service.connection.zipkin;