You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+17-13Lines changed: 17 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -88,16 +88,19 @@ Note that `cf.ldif` contains **default credentials** and should only be used dur
88
88
89
89
### Verification
90
90
91
-
To check that the server is running correctly, visit [the default homepage](http://localhost:8080/).
91
+
To check that the server is running correctly, visit [the default homepage](http://localhost:8080/). For more
92
+
information on the api see the [swagger docs endpoint](http://localhost:8080/swagger-ui/index.html).
92
93
93
94
## Development
94
95
95
-
It's strongly encouraged to use a modern IDE such as [Intelij](https://www.jetbrains.com/idea/) and [Eclipse](https://eclipseide.org/).
96
+
It's strongly encouraged to use a modern IDE such as [Intelij](https://www.jetbrains.com/idea/)
97
+
and [Eclipse](https://eclipseide.org/).
96
98
97
99
* Prerequisites
98
100
99
-
* JDK 17
100
-
* Maven (via package manager or via the wrapper `./mvnw`) (version specified in [the wrapper properties](./.mvn/wrapper/maven-wrapper.properties))
101
+
* JDK 17
102
+
* Maven (via package manager or via the wrapper `./mvnw`) (version specified
103
+
in [the wrapper properties](./.mvn/wrapper/maven-wrapper.properties))
101
104
102
105
For the following commands `mvn` can be interchangeably used instead via `./mvnw`
103
106
@@ -127,7 +130,8 @@ See `src/test/java` and package
127
130
128
131
*`org.phoebus.channelfinder.docker`
129
132
130
-
Integration tests start docker containers for ChannelFinder and Elasticsearch and run http requests (GET, POST, PUT, DELETE) towards the application to test behavior (read, list, query, create, update, remove) and
133
+
Integration tests start docker containers for ChannelFinder and Elasticsearch and run http requests (GET, POST, PUT,
134
+
DELETE) towards the application to test behavior (read, list, query, create, update, remove) and
131
135
replies are received and checked if content is as expected.
132
136
133
137
There are tests for properties, tags and channels separately and in combination.
@@ -154,27 +158,27 @@ using the sonatype repositories.
154
158
Create a sonatype account and update the maven settings.xml file with your sonatype credentials
155
159
156
160
```xml
157
-
<servers>
158
-
<server>
159
-
<id>phoebus-releases</id>
160
-
<username>username</username>
161
-
<password>*******</password>
162
-
</server>
163
-
</servers>
161
+
<servers>
162
+
<server>
163
+
<id>phoebus-releases</id>
164
+
<username>username</username>
165
+
<password>*******</password>
166
+
</server>
167
+
</servers>
164
168
```
165
169
166
170
#### Prepare the release
167
171
168
172
```bash
169
173
mvn release:prepare
170
174
```
175
+
171
176
In this step will ensure there are no uncommitted changes, ensure the versions number are correct, tag the scm, etc..
0 commit comments