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

Fix snapshot documentation links.

Browse Source 
Documentation links now contain the proper snapshot suffix.

Closes #91
This commit is contained in:
Mark Paluch
2024-07-22 15:49:49 +02:00
parent 8089c56d51
commit 5a64820cd4
3 changed files with 19 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
src/main/java/org/springframework/data/release/model/ArtifactVersion.java
View File

@@ -318,12 +318,17 @@ public class ArtifactVersion implements Comparable<ArtifactVersion> {
return modifierFormat ? SNAPSHOT_MODIFIER : SNAPSHOT_SUFFIX;
}
public String getMajorMinor() {
public String getMajorMinor(boolean includeSuffix) {
if (includeSuffix && isSnapshotVersion()) {
return String.format("%s.%s-SNAPSHOT", version.getMajor(), version.getMinor());
}
return String.format("%s.%s", version.getMajor(), version.getMinor());
}
public String getGeneration() {
return String.format("%s.x", getMajorMinor());
return String.format("%s.x", getMajorMinor(false));
}
@Override

2
src/main/java/org/springframework/data/release/model/DocumentationMetadata.java
View File

@@ -114,7 +114,7 @@ public class DocumentationMetadata {
}
String format = this.project.isCommercial() ? COMMERCIAL_ANTORA_BASE : ANTORA_BASE;
return String.format(format, getProjectName(project), version.getMajorMinor());
return String.format(format, getProjectName(project), this.version.getMajorMinor(true));
}
public String getVersionOrTrainName(Train train) {

11
src/test/java/org/springframework/data/release/model/DocumentationMetadataUnitTests.java
View File

@@ -48,6 +48,17 @@ class DocumentationMetadataUnitTests {
assertThat(metadata.getReferenceDocUrl()).isEqualTo("https://docs.spring.io/spring-data/mongodb/reference/3.1/");
}
@Test // gh-91
void shouldReportCorrectAntoraSnapshotDocumentationUrls() {
DocumentationMetadata metadata = DocumentationMetadata.of(DocumentationFormat.ANTORA,
SupportedProject.of(Projects.MONGO_DB, SupportStatus.OSS), ArtifactVersion.of("3.1.0-SNAPSHOT"), false);
assertThat(metadata.getApiDocUrl()).isEmpty();
assertThat(metadata.getReferenceDocUrl())
.isEqualTo("https://docs.spring.io/spring-data/mongodb/reference/3.1-SNAPSHOT/");
}
@Test // gh-197
void shouldReportCorrectCurrentDocumentationUrls() {