Skip to content

Commit 0c4dcca

Browse files
jmewesKieun
authored andcommitted
Drop usage of TravisCI (ePages-de#236)
ePages-deGH-235 (cherry picked from commit 0b5d511)
1 parent 5612a2a commit 0c4dcca

File tree

4 files changed

+12
-49
lines changed

4 files changed

+12
-49
lines changed

.gitignore

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,7 @@
11
*.gpg
2-
32
.gradle/
43
.*
54
!.gitignore
6-
!.travis.yml
7-
!.circleci
85
.settings/
96
build/
107
out/

.travis.yml

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

README.md

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,7 @@
22

33
[![oss lifecycle](https://img.shields.io/badge/oss_lifecycle-maintenance-yellow.svg)](https://github.com/ePages-de/restdocs-api-spec/issues/204)
44
![](https://img.shields.io/github/license/ePages-de/restdocs-openapi.svg)
5-
[![Build Status](https://travis-ci.com/ePages-de/restdocs-api-spec.svg?branch=master)](https://travis-ci.com/ePages-de/restdocs-api-spec)
65
[![Maven Central](https://img.shields.io/maven-central/v/com.epages/restdocs-api-spec)](https://search.maven.org/artifact/com.epages/restdocs-api-spec)
7-
[![Coverage Status](https://coveralls.io/repos/github/ePages-de/restdocs-api-spec/badge.svg?branch=master)](https://coveralls.io/github/ePages-de/restdocs-api-spec?branch=master)
86
[![Gitter](https://img.shields.io/gitter/room/nwjs/nw.js.svg)](https://gitter.im/restdocs-api-spec/Lobby)
97

108
This is an extension that adds API specifications as an output format to [Spring REST Docs](https://projects.spring.io/spring-restdocs/).
@@ -41,6 +39,7 @@ This is why we came up with this project.
4139

4240
- [Motivation](#motivation)
4341
- [Getting started](#getting-started)
42+
- [Version compatibility](#version-compatibility)
4443
- [Project structure](#project-structure)
4544
- [Build configuration](#build-configuration)
4645
- [Gradle](#gradle)
@@ -67,6 +66,15 @@ This is why we came up with this project.
6766

6867
## Getting started
6968

69+
### Version compatibility
70+
71+
Spring Boot and Spring REST Docs 3.0.0 introduced [breaking chances to how request parameters are documented: `RequestParameterSnippet` was split into `QueryParameterSnippet` and `FormParameterSnippet`.](https://github.com/spring-projects/spring-restdocs/issues/832)
72+
73+
|Spring Boot version | restdocs-api-spec version|
74+
|---|---|
75+
|3.x|0.17.1 or later|
76+
|2.x|0.16.4|
77+
7078
### Project structure
7179

7280
The project consists of the following main components:
@@ -591,7 +599,7 @@ This section of the README is targeted at project maintainers.
591599

592600
### Publish project
593601

594-
The project is published with the help of [TravisCI](./.travis.yml).
602+
~~The project is published with the help of [TravisCI](./.travis.yml).~~
595603
It's version number is determined by the Git tags (see [allegro/axion-release-plugin](https://axion-release-plugin.readthedocs.io)).
596604
The Java dependencies are published to Sonatype with the help of the [gradle-nexus/publish-plugin](https://github.com/gradle-nexus/publish-plugin) and the Maven Publish Plugin.
597605
The Gradle plugin is published to the [Gradle plugin portal](https://plugins.gradle.org/plugin/com.epages.restdocs-api-spec) with the help of the ['plugin-publish' plugin](https://plugins.gradle.org/plugin/com.gradle.plugin-publish) (see [docs.gradle.org](https://docs.gradle.org/current/userguide/publishing_gradle_plugins.html)).
@@ -600,7 +608,7 @@ Given that the `master` branch on the upstream repository is in the state from w
600608
601609
1. [Create release via the GitHub UI](https://github.com/ePages-de/restdocs-api-spec/releases/new) <br>
602610
Use the intended version number as "Tag version", e.g. "0.16.0".
603-
This will automatically trigger a Travis build which publishes the JAR files for this release to Sonatype.
611+
~~This will automatically trigger a Travis build which publishes the JAR files for this release to Sonatype.~~
604612
2. Login to Sonatype and navigate to the [staging repositories](https://oss.sonatype.org/#stagingRepositories)
605613
3. Close the staging repository <br>
606614
Select the generated staging repository and close it.

secret-keys.gpg.enc

-4.83 KB
Binary file not shown.

0 commit comments

Comments
 (0)