Skip to content
This repository was archived by the owner on Jan 14, 2025. It is now read-only.

Commit 777f981

Browse files
committed
OGM-1594 Update documentation
1 parent 92f9c84 commit 777f981

File tree

4 files changed

+16
-27
lines changed

4 files changed

+16
-27
lines changed

README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -54,15 +54,15 @@ The code is available on GitHub at <https://github.com/hibernate/hibernate-ogm>.
5454

5555
To run the full project build including tests for all backends, documentation etc. execute:
5656

57-
mvn clean install -s settings-example.xml
57+
mvn clean install
5858

5959
Note that for running the test suite against separately installed MongoDB or Neo4j servers their host name must be specified via an environment variable.
6060
See the sections below for the details.
6161

6262
To speed things up, there are several options for skipping parts of the build.
6363
To run the minimum project build without integration tests, documentation and distribution execute:
6464

65-
mvn clean install -DskipITs -DskipDocs -DskipDistro -s settings-example.xml
65+
mvn clean install -DskipITs -DskipDocs -DskipDistro
6666

6767
The following sections describe these options in more detail.
6868

@@ -77,29 +77,29 @@ Make sure that annotation processing is enabled in your project settings (see "P
7777

7878
You can skip integration tests by specifying the `skipITs` property:
7979

80-
mvn clean install -DskipITs -s settings-example.xml
80+
mvn clean install -DskipITs
8181

8282
### Documentation
8383

8484
The documentation is built by default as part of the project build. You can skip it by specifying the `skipDocs` property:
8585

86-
mvn clean install -DskipDocs -s settings-example.xml
86+
mvn clean install -DskipDocs
8787

8888
If you just want to build the documentation, run it from the _documentation/manual_ subdirectory.
8989

9090
By default, the following command only builds the HTML version of the documentation:
9191

92-
mvn clean install -f documentation/manual/pom.xml -s settings-example.xml
92+
mvn clean install -f documentation/manual/pom.xml
9393

9494
If you also wish to generate the PDF version of the documentation, you need to use the `documentation-pdf` profile:
9595

96-
mvn clean install -f documentation/manual/pom.xml -s settings-example.xml -Pdocumentation-pdf
96+
mvn clean install -f documentation/manual/pom.xml -Pdocumentation-pdf
9797

9898
### Distribution
9999

100100
The distribution bundle is built by default as part of the project build. You can skip it by specifying the `skipDistro` property:
101101

102-
mvn clean install -DskipDistro -s settings-example.xml
102+
mvn clean install -DskipDistro
103103

104104
### Integration tests
105105

@@ -119,11 +119,11 @@ distribution, extracts it, starts a _mongod_ process and shuts it down after tes
119119
If required, you can configure the port to which the MongoDB instance binds to (by default 27018)
120120
and the target directory for the extracted binary (defaults to _${project.build.directory}/embeddedMongoDb/extracted_) like this:
121121

122-
mvn clean install -s settings-example.xml -DembeddedMongoDbTempDir=<my-temp-dir> -DembeddedMongoDbPort=<my-port>
122+
mvn clean install -DembeddedMongoDbTempDir=<my-temp-dir> -DembeddedMongoDbPort=<my-port>
123123

124124
To work with a separately installed MongoDB instance instead, specify the property `-DuseExternalMongoDb`:
125125

126-
mvn clean install -s settings-example.xml -DuseExternalMongoDb
126+
mvn clean install -DuseExternalMongoDb
127127

128128
This assumes MongoDB to be installed on `localhost`, using the default port and no authentication.
129129
If you work with different settings, configure the required properties in hibernate.properties (for the tests in _mongodb_)
@@ -134,7 +134,7 @@ prior to running the tests:
134134
export MONGODB_PORT=1234
135135
export MONGODB_USERNAME=someUsername
136136
export MONGODB_PASSWORD=someP@ssw0rd
137-
mvn clean install -s settings-example.xml -DuseExternalMongoDb
137+
mvn clean install -DuseExternalMongoDb
138138

139139
### Neo4j
140140

@@ -144,11 +144,11 @@ embedded Neo4j configuration is used.
144144
Hibernate OGM can connect to a Neo4j server remotely via the Bolt protocol or via HTTP.
145145
These tests are not executed by default, you can run them using the following commands:
146146

147-
mvn clean install -s settings-example.xml -Pneo4j-http
147+
mvn clean install -Pneo4j-http
148148

149149
or
150150

151-
mvn clean install -s settings-example.xml -Pneo4j-bolt
151+
mvn clean install -Pneo4j-bolt
152152

153153
This assumes Neo4j to be installed on `localhost`, using the default port and no authentication.
154154
If you work with different settings, configure the required properties in hibernate.properties

documentation/manual/src/main/asciidoc/modules/how-to-contribute.asciidoc

Lines changed: 2 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -63,25 +63,14 @@ Run maven
6363
[source, bash]
6464
----
6565
#build project
66-
mvn clean install -s settings-example.xml
66+
mvn clean install
6767
----
6868

69-
[NOTE]
70-
====
71-
Note that Hibernate OGM uses artifacts from the Maven repository hosted by JBoss.
72-
Make sure to either use the [code]`-s settings-example.xml` option
73-
or adjust your [filename]`$$~/.m2/settings.xml$$`
74-
according to the descriptions available
75-
http://community.jboss.org/wiki/MavenGettingStarted-Users[on this jboss.org wiki page].
76-
77-
These settings are required for development of Hibernate OGM but should not be needed to use it.
78-
====
79-
8069
To skip building the documentation, set the `skipDocs` property to true:
8170

8271
[source, bash]
8372
----
84-
mvn clean install -DskipDocs=true -s settings-example.xml
73+
mvn clean install -DskipDocs=true
8574
----
8675

8776
[TIP]

how-to-release.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ Verify:
3030
4. tests and artifacts:
3131

3232
```
33-
mvn clean install -s settings-example.xml
33+
mvn clean install
3434
```
3535

3636
5. the distribution package as built by Maven (_distribution/target/hibernate-ogm-[version]-dist_).

src/main/release-scripts/update-version.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,5 +12,5 @@ else
1212
fi
1313

1414
pushd $WORKSPACE
15-
mvn clean versions:set -s settings-example.xml -DnewVersion=$NEW_VERSION -DgenerateBackupPoms=false -f bom/pom.xml
15+
mvn clean versions:set -DnewVersion=$NEW_VERSION -DgenerateBackupPoms=false -f bom/pom.xml
1616
popd

0 commit comments

Comments
 (0)