Skip to content
This repository was archived by the owner on Dec 19, 2023. It is now read-only.

Commit 9228032

Browse files
fbenzfbenz
authored
1.0.14 Release (#254)
Incl. an upgrade of Spring REST Docs to 1.2.5
1 parent b553c5c commit 9228032

File tree

11 files changed

+422
-267
lines changed

11 files changed

+422
-267
lines changed

‎.travis.settings.xml

Lines changed: 138 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,138 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<settings xmlns="http://maven.apache.org/SETTINGS/1.0.0"
3+
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
4+
xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0 http://maven.apache.org/xsd/settings-1.0.0.xsd">
5+
<!-- https://github.com/travis-ci/travis-cookbooks/blob/master/cookbooks/travis_build_environment/files/default/ci_user/maven_user_settings.xml -->
6+
<profiles>
7+
<profile>
8+
<id>standard-with-extra-repos</id>
9+
<activation>
10+
<activeByDefault>true</activeByDefault>
11+
</activation>
12+
13+
<repositories>
14+
<repository>
15+
<id>central</id>
16+
<name>Central Repository</name>
17+
<url>http://repo1.maven.org/maven2</url>
18+
<releases>
19+
<enabled>true</enabled>
20+
<updatePolicy>always</updatePolicy>
21+
</releases>
22+
<snapshots>
23+
<enabled>false</enabled>
24+
<updatePolicy>always</updatePolicy>
25+
</snapshots>
26+
</repository>
27+
28+
<repository>
29+
<id>central2</id>
30+
<name>Central Repository 2</name>
31+
<url>http://repo1.maven.apache.org/maven2</url>
32+
<releases>
33+
<enabled>true</enabled>
34+
<updatePolicy>always</updatePolicy>
35+
</releases>
36+
<snapshots>
37+
<enabled>false</enabled>
38+
<updatePolicy>always</updatePolicy>
39+
</snapshots>
40+
</repository>
41+
42+
<repository>
43+
<id>sonatype</id>
44+
<name>OSS Sonatype repo (releases)</name>
45+
<releases>
46+
<enabled>true</enabled>
47+
<updatePolicy>always</updatePolicy>
48+
<checksumPolicy>warn</checksumPolicy>
49+
</releases>
50+
<snapshots>
51+
<enabled>false</enabled>
52+
<updatePolicy>never</updatePolicy>
53+
<checksumPolicy>fail</checksumPolicy>
54+
</snapshots>
55+
<url>https://oss.sonatype.org/content/repositories/releases/</url>
56+
</repository>
57+
58+
<repository>
59+
<id>sonatype-snapshots</id>
60+
<name>OSS Sonatype repo (snapshots)</name>
61+
<releases>
62+
<enabled>false</enabled>
63+
<updatePolicy>always</updatePolicy>
64+
<checksumPolicy>warn</checksumPolicy>
65+
</releases>
66+
<snapshots>
67+
<enabled>true</enabled>
68+
<updatePolicy>never</updatePolicy>
69+
<checksumPolicy>fail</checksumPolicy>
70+
</snapshots>
71+
<url>https://oss.sonatype.org/content/repositories/snapshots/</url>
72+
</repository>
73+
74+
<repository>
75+
<id>sonatype-apache</id>
76+
<name>Apache repo (releases)</name>
77+
<releases>
78+
<enabled>true</enabled>
79+
<updatePolicy>always</updatePolicy>
80+
<checksumPolicy>warn</checksumPolicy>
81+
</releases>
82+
<snapshots>
83+
<enabled>false</enabled>
84+
<updatePolicy>never</updatePolicy>
85+
<checksumPolicy>fail</checksumPolicy>
86+
</snapshots>
87+
<url>https://repository.apache.org/releases/</url>
88+
</repository>
89+
90+
<repository>
91+
<id>apache-snapshots</id>
92+
<name>ASF repo (snapshots)</name>
93+
<releases>
94+
<enabled>false</enabled>
95+
<updatePolicy>never</updatePolicy>
96+
<checksumPolicy>warn</checksumPolicy>
97+
</releases>
98+
<snapshots>
99+
<enabled>true</enabled>
100+
<updatePolicy>always</updatePolicy>
101+
<checksumPolicy>fail</checksumPolicy>
102+
</snapshots>
103+
<url>https://repository.apache.org/snapshots/</url>
104+
</repository>
105+
106+
</repositories>
107+
<pluginRepositories>
108+
<pluginRepository>
109+
<id>central</id>
110+
<!-- specify repo1 which supports HTTP -->
111+
<url>http://repo1.maven.org/maven2</url>
112+
<releases>
113+
<enabled>true</enabled>
114+
<updatePolicy>always</updatePolicy>
115+
</releases>
116+
<snapshots>
117+
<enabled>false</enabled>
118+
<updatePolicy>always</updatePolicy>
119+
</snapshots>
120+
</pluginRepository>
121+
122+
<pluginRepository>
123+
<id>central2</id>
124+
<!-- specify repo1 which supports HTTP -->
125+
<url>http://repo1.maven.apache.org/maven2</url>
126+
<releases>
127+
<enabled>true</enabled>
128+
<updatePolicy>always</updatePolicy>
129+
</releases>
130+
<snapshots>
131+
<enabled>false</enabled>
132+
<updatePolicy>always</updatePolicy>
133+
</snapshots>
134+
</pluginRepository>
135+
</pluginRepositories>
136+
</profile>
137+
</profiles>
138+
</settings>

‎.travis.yml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,9 @@ cache:
1313
- $HOME/.gradle/caches/
1414
- $HOME/.gradle/wrapper/
1515
before_install:
16-
- mvn install:install-file -Dfile=lib/spring-restdocs-core-1.2.4.RELEASE-test.jar
17-
-DgroupId=org.springframework.restdocs -DartifactId=spring-restdocs-core -Dversion=1.2.4.RELEASE
16+
- cp .travis.settings.xml $HOME/.m2/settings.xml
17+
- mvn install:install-file -Dfile=lib/spring-restdocs-core-1.2.5.RELEASE-test.jar
18+
-DgroupId=org.springframework.restdocs -DartifactId=spring-restdocs-core -Dversion=1.2.5.RELEASE
1819
-Dpackaging=jar -Dclassifier=test
1920
script:
2021
- mvn install -B -V

‎docs/index.html

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -425,7 +425,7 @@
425425
<h1>Spring Auto REST Docs</h1>
426426
<div class="details">
427427
<span id="author" class="author">Scalable Capital</span><br>
428-
<span id="revnumber">version 1.0.13</span>
428+
<span id="revnumber">version 1.0.14</span>
429429
</div>
430430
<div id="toc" class="toc2">
431431
<div id="toctitle">Table of Contents</div>
@@ -572,7 +572,7 @@ <h3 id="gettingstarted-requirements"><a class="link" href="#gettingstarted-requi
572572
<p>Java 7</p>
573573
</li>
574574
<li>
575-
<p>Spring REST Docs 1.2.3.RELEASE (see <a href="http://docs.spring.io/spring-restdocs/docs/1.2.3.RELEASE/reference/html5/">documentation</a>)</p>
575+
<p>Spring REST Docs 1.2.5.RELEASE (see <a href="http://docs.spring.io/spring-restdocs/docs/1.2.5.RELEASE/reference/html5/">documentation</a>)</p>
576576
</li>
577577
<li>
578578
<p>Jackson has to be used for creating and parsing JSON</p>
@@ -585,7 +585,7 @@ <h3 id="gettingstarted-usage"><a class="link" href="#gettingstarted-usage">Usage
585585
<div class="olist arabic">
586586
<ol class="arabic">
587587
<li>
588-
<p>Setup project for <a href="http://docs.spring.io/spring-restdocs/docs/1.2.3.RELEASE/reference/html5/#getting-started">Spring REST Docs</a></p>
588+
<p>Setup project for <a href="http://docs.spring.io/spring-restdocs/docs/1.2.5.RELEASE/reference/html5/#getting-started">Spring REST Docs</a></p>
589589
</li>
590590
<li>
591591
<p>Additional configuration for this extension:</p>
@@ -595,7 +595,7 @@ <h3 id="gettingstarted-usage"><a class="link" href="#gettingstarted-usage">Usage
595595
<pre class="highlightjs highlight"><code class="language-xml" data-lang="xml">&lt;dependency&gt;
596596
&lt;groupId&gt;capital.scalable&lt;/groupId&gt;
597597
&lt;artifactId&gt;spring-auto-restdocs-core&lt;/artifactId&gt;
598-
&lt;version&gt;1.0.13&lt;/version&gt;
598+
&lt;version&gt;1.0.14&lt;/version&gt;
599599
&lt;scope&gt;test&lt;/scope&gt; <i class="conum" data-value="1"></i><b>(1)</b>
600600
&lt;/dependency&gt;
601601

@@ -632,7 +632,7 @@ <h3 id="gettingstarted-usage"><a class="link" href="#gettingstarted-usage">Usage
632632
&lt;docletArtifact&gt;
633633
&lt;groupId&gt;capital.scalable&lt;/groupId&gt;
634634
&lt;artifactId&gt;spring-auto-restdocs-json-doclet&lt;/artifactId&gt;
635-
&lt;version&gt;1.0.13&lt;/version&gt;
635+
&lt;version&gt;1.0.14&lt;/version&gt;
636636
&lt;/docletArtifact&gt;
637637
&lt;destDir&gt;generated-javadoc-json&lt;/destDir&gt; <i class="conum" data-value="3"></i><b>(3)</b>
638638
&lt;reportOutputDirectory&gt;${project.build.directory}&lt;/reportOutputDirectory&gt; <i class="conum" data-value="3"></i><b>(3)</b>
@@ -677,8 +677,8 @@ <h3 id="gettingstarted-usage"><a class="link" href="#gettingstarted-usage">Usage
677677
}
678678

679679
dependencies {
680-
testCompile group: 'capital.scalable', name: 'spring-auto-restdocs-core', version: '1.0.13' <i class="conum" data-value="1"></i><b>(1)</b>
681-
jsondoclet group: 'capital.scalable', name: 'spring-auto-restdocs-json-doclet', version: '1.0.13'
680+
testCompile group: 'capital.scalable', name: 'spring-auto-restdocs-core', version: '1.0.14' <i class="conum" data-value="1"></i><b>(1)</b>
681+
jsondoclet group: 'capital.scalable', name: 'spring-auto-restdocs-json-doclet', version: '1.0.14'
682682
}
683683

684684
task jsonDoclet(type: Javadoc, dependsOn: compileJava) {
@@ -1476,10 +1476,10 @@ <h3 id="snippets-custom"><a class="link" href="#snippets-custom">Custom snippet<
14761476
<h3 id="snippets-customization"><a class="link" href="#snippets-customization">Snippet customization</a></h3>
14771477
<div class="paragraph">
14781478
<p>Provide your own template in <code>org/springframework/restdocs/templates/asciidoctor</code> (or <code>markdown</code>) package of your resources.
1479-
You can override <a href="https://github.com/spring-projects/spring-restdocs/tree/v1.2.3.RELEASE/spring-restdocs-core/src/main/resources/org/springframework/restdocs/templates">REST Docs templates</a>
1479+
You can override <a href="https://github.com/spring-projects/spring-restdocs/tree/v1.2.5.RELEASE/spring-restdocs-core/src/main/resources/org/springframework/restdocs/templates">REST Docs templates</a>
14801480
and <a href="https://github.com/ScaCap/spring-auto-restdocs/tree/master/spring-auto-restdocs-core/src/main/resources/org/springframework/restdocs/templates">Auto REST Docs templates</a>.
14811481
Important is to omit <code>default-</code> part from the template name so that the resolution algorithm will prefer this custom template.
1482-
See also <a href="http://docs.spring.io/spring-restdocs/docs/1.2.3.RELEASE/reference/html5/#documenting-your-api-customizing-snippets">original documentation</a> for additional details.</p>
1482+
See also <a href="http://docs.spring.io/spring-restdocs/docs/1.2.5.RELEASE/reference/html5/#documenting-your-api-customizing-snippets">original documentation</a> for additional details.</p>
14831483
</div>
14841484
</div>
14851485
</div>
@@ -1559,7 +1559,7 @@ <h3 id="constraints-custom"><a class="link" href="#constraints-custom">Custom co
15591559
Each description is a property where the key is the full class name of the annotation suffixed with <code>.description</code>.
15601560
The value is the description and can contain placeholders for annotation methods,
15611561
e.g. <code>${value}</code> to get the content of <code>value()</code>.
1562-
For more details, see original documentation of <a href="http://docs.spring.io/spring-restdocs/docs/1.2.3.RELEASE/reference/html5/#documenting-your-api-constraints-describing">here</a>.</p>
1562+
For more details, see original documentation of <a href="http://docs.spring.io/spring-restdocs/docs/1.2.5.RELEASE/reference/html5/#documenting-your-api-constraints-describing">here</a>.</p>
15631563
</div>
15641564
<div class="paragraph">
15651565
<p>Example for the constraint annotation <code>myproject.constraints.OneOf</code>:</p>
@@ -1789,9 +1789,9 @@ <h4 id="contributing-installing-testjar"><a class="link" href="#contributing-ins
17891789
<div class="listingblock">
17901790
<div class="title">Bash</div>
17911791
<div class="content">
1792-
<pre class="highlightjs highlight"><code class="language-bash" data-lang="bash">mvn install:install-file -Dfile=lib/spring-restdocs-core-1.2.3.RELEASE-test.jar \
1792+
<pre class="highlightjs highlight"><code class="language-bash" data-lang="bash">mvn install:install-file -Dfile=lib/spring-restdocs-core-1.2.5.RELEASE-test.jar \
17931793
-DgroupId=org.springframework.restdocs -DartifactId=spring-restdocs-core \
1794-
-Dversion=1.2.3.RELEASE -Dpackaging=test-jar -Dclassifier=test</code></pre>
1794+
-Dversion=1.2.5.RELEASE -Dpackaging=test-jar -Dclassifier=test</code></pre>
17951795
</div>
17961796
</div>
17971797
</div>
@@ -1802,7 +1802,7 @@ <h4 id="contributing-building-testjar"><a class="link" href="#contributing-build
18021802
but if you ever want to upgrade the version of Spring REST Docs in this project this step has to be done.</p>
18031803
</div>
18041804
<div class="paragraph">
1805-
<p>We use version 1.2.3.RELEASE of Spring REST Docs in this example.</p>
1805+
<p>We use version 1.2.5.RELEASE of Spring REST Docs in this example.</p>
18061806
</div>
18071807
<div class="paragraph">
18081808
<p>You find the currently required version in <code>pom.xml</code>:</p>
@@ -1813,7 +1813,7 @@ <h4 id="contributing-building-testjar"><a class="link" href="#contributing-build
18131813
<pre class="highlightjs highlight"><code class="language-xml" data-lang="xml">&lt;dependency&gt;
18141814
&lt;groupId&gt;org.springframework.restdocs&lt;/groupId&gt;
18151815
&lt;artifactId&gt;spring-restdocs-core&lt;/artifactId&gt;
1816-
&lt;version&gt;1.2.3.RELEASE&lt;/version&gt;
1816+
&lt;version&gt;1.2.5.RELEASE&lt;/version&gt;
18171817
&lt;classifier&gt;test&lt;/classifier&gt;
18181818
&lt;scope&gt;test&lt;/scope&gt;
18191819
&lt;/dependency&gt;</code></pre>
@@ -1828,13 +1828,13 @@ <h4 id="contributing-building-testjar"><a class="link" href="#contributing-build
18281828
<pre class="highlightjs highlight"><code class="language-bash" data-lang="bash">git clone git@github.com:spring-projects/spring-restdocs.git
18291829
cd spring-restdocs
18301830
git fetch --tags
1831-
git checkout tags/v1.2.3.RELEASE
1831+
git checkout tags/v1.2.5.RELEASE
18321832
./gradlew build</code></pre>
18331833
</div>
18341834
</div>
18351835
<div class="paragraph">
18361836
<p>Afterwards the test JAR is located at
1837-
<code>spring-restdocs/spring-restdocs-core/build/libs/spring-restdocs-core-1.2.3.RELEASE-test.jar</code>
1837+
<code>spring-restdocs/spring-restdocs-core/build/libs/spring-restdocs-core-1.2.5.RELEASE-test.jar</code>
18381838
and has to be installed with the Maven command shown in the section above.</p>
18391839
</div>
18401840
</div>
@@ -1853,8 +1853,8 @@ <h4 id="contributing-building-build"><a class="link" href="#contributing-buildin
18531853
</div>
18541854
<div id="footer">
18551855
<div id="footer-text">
1856-
Version 1.0.13<br>
1857-
Last updated 2018-03-29 11:46:29 CEST
1856+
Version 1.0.14<br>
1857+
Last updated 2018-08-21 17:44:22 CEST
18581858
</div>
18591859
</div>
18601860
<link rel="stylesheet" href="highlight/styles/github.min.css">

‎lib/spring-restdocs-core-1.2.4.RELEASE-test.jar renamed to ‎lib/spring-restdocs-core-1.2.5.RELEASE-test.jar

205 KB
Binary file not shown.

‎pom.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
<groupId>capital.scalable</groupId>
77
<artifactId>spring-auto-restdocs-parent</artifactId>
8-
<version>1.0.14-SNAPSHOT</version>
8+
<version>1.0.14</version>
99
<packaging>pom</packaging>
1010

1111
<name>Spring Auto REST Docs Parent POM</name>
@@ -56,7 +56,7 @@
5656
<java.version>1.7</java.version>
5757
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
5858
<snippetsDirectory>${project.build.directory}/generated-snippets</snippetsDirectory>
59-
<spring-restdocs.version>1.2.4.RELEASE</spring-restdocs.version>
59+
<spring-restdocs.version>1.2.5.RELEASE</spring-restdocs.version>
6060
</properties>
6161

6262
<build>

‎spring-auto-restdocs-core/pom.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
<parent>
88
<groupId>capital.scalable</groupId>
99
<artifactId>spring-auto-restdocs-parent</artifactId>
10-
<version>1.0.14-SNAPSHOT</version>
10+
<version>1.0.14</version>
1111
<relativePath>..</relativePath>
1212
</parent>
1313

‎spring-auto-restdocs-docs/pom.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
<parent>
77
<groupId>capital.scalable</groupId>
88
<artifactId>spring-auto-restdocs-parent</artifactId>
9-
<version>1.0.14-SNAPSHOT</version>
9+
<version>1.0.14</version>
1010
<relativePath>..</relativePath>
1111
</parent>
1212

@@ -18,7 +18,7 @@
1818

1919
<properties>
2020
<docs.dir>${project.basedir}/../docs</docs.dir>
21-
<latestRelease>1.0.13</latestRelease> <!-- change this when releasing 1.0.14-SNAPSHOT -->
21+
<latestRelease>1.0.14</latestRelease> <!-- change this when releasing 1.0.15-SNAPSHOT -->
2222
</properties>
2323

2424
<build>

‎spring-auto-restdocs-example/build.gradle

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,16 @@
11
buildscript {
22
ext {
3-
springBootVersion = "1.5.9.RELEASE"
4-
springAutoRestDocsVersion = "1.0.14-SNAPSHOT"
5-
springRestDocsVersion = "1.2.4.RELEASE"
3+
springBootVersion = "1.5.17.RELEASE"
4+
springAutoRestDocsVersion = "1.0.14"
5+
springRestDocsVersion = "1.2.5.RELEASE"
66
}
77
repositories {
8-
jcenter()
9-
mavenCentral()
8+
jcenter {
9+
url "http://jcenter.bintray.com/"
10+
}
11+
maven {
12+
url "http://repo1.maven.org/maven2"
13+
}
1014
}
1115
dependencies {
1216
classpath "org.springframework.boot:spring-boot-gradle-plugin:${springBootVersion}"

0 commit comments

Comments
 (0)