forked from apache/ignite
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathDEVNOTES.txt
215 lines (125 loc) · 6.68 KB
/
DEVNOTES.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
Apache Ignite Maven Build Instructions
======================================
1) Optional: build Apache Ignite.NET as described at modules/platforms/dotnet/DEVNOTES.txt.
2) Compile and install:
mvn clean install -Pall-java,all-scala,licenses -DskipTests
or if you have built Apache Ignite.NET on the first step use following command:
(Note that 'doxygen' should be installed before running this command.)
mvn clean install -Pall-java,all-scala,licenses -DskipTests -DclientDocs
3) Javadoc generation (optional):
mvn initialize -Pjavadoc
4) Build Apache Ignite assembly:
mvn initialize -Prelease
Look for apache-ignite-<version>-bin.zip in ./target/bin directory.
5) Build Apache Ignite slim edition assembly:
mvn initialize -Prelease -Dignite.edition=apache-ignite-slim
Look for apache-ignite-slim-<version>-bin.zip in ./target/bin directory.
Apache Ignite with LGPL Maven Build Instructions
================================================
1) Optional: build Apache Ignite.NET as described at modules/platforms/dotnet/DEVNOTES.txt.
2) Compile and install:
mvn clean install -Pall-java,all-scala,licenses -DskipTests
or if you have built Apache Ignite.NET on the first step use following command:
(Note that 'doxygen' should be installed before running this command.)
mvn clean install -Pall-java,all-scala,licenses -DskipTests -DclientDocs
3) Javadoc generation with LGPL (optional):
mvn initialize -Pjavadoc,lgpl
4) Build Apache Ignite assembly with LGPL dependencies:
mvn initialize -Prelease,lgpl -Dignite.edition=apache-ignite-lgpl
Look for apache-ignite-lgpl-<version>-bin.zip in ./target/bin directory.
Ignite C++ Build Instructions
=============================
Instructions can be found at modules/platforms/cpp/DEVNOTES.txt.
Apache Ignite RPM Package Build Instructions
============================================
1) Build Apache Ignite binary archive (instructions above)
2) Run packaging script and follow messages if they required interaction
packaging/package.sh --rpm
Packages will be available in packaging/ directory
Apache Ignite DEB Package Build Instructions
============================================
1) Build Apache Ignite binary archive (instructions above)
2) Build Apache Ignite RPM package (also above)
3) Run packaging script and follow messages if they required interaction
packaging/package.sh --deb
Packages will be available in packaging/ directory
NOTE: to build both packages type at once, run
packaging/package.sh --rpm --deb
Install and Run Apache Ignite from packages
===========================================
1) Install package with YUM or APT respectively
yum localinstall -y apache-ignite-<version>.noarch.rpm
or
dpkg -i apache-ignite_<version>_all.deb
2) Start Apache Ignite service
systemctl start apache-ignite@<config name>
NOTE: <config name> - relative to /etc/apache-ignite configuration file name
Example:
systemctl start [email protected]
3) See logs in /var/log/apache-ignite or journalctl -xe
Ignite Release Instructions
===========================
1) Use your people.apache.org/keys/committer/<username>.asc key to generate KEYS file.
Download https://dist.apache.org/repos/dist/release/ignite/KEYS and append you key using commands:
gpg --list-sigs <keyname> >> KEYS
gpg --armor --export <keyname> >> KEYS
Upload modified KEYS file.
2) Specify gpg profile at settings.xml. It will be used to sign sources and artifacts.
<profile>
<id>gpg</id>
<properties>
<gpg.keyname>keyname</gpg.keyname>
<gpg.passphrase>passphrase</gpg.passphrase>
</properties>
</profile>
Ensure you have RELEASE (not SNAPSHOT) version at Ignite poms.
Maven release plugin release:prepare goal can be used to make release tag.
3) Deploy Ignite release candidate to maven repository and dev-svn, make tag:
3.1) Deploy Ignite to maven repository, prepares sources and binaries.
mvn deploy -Papache-release,gpg,all-java,all-scala,licenses,deploy-ignite-site -Dignite.edition=apache-ignite -DskipTests
3.2) Javadoc generation:
mvn initialize -Pjavadoc
3.3) Assembly Apache Ignite:
mvn initialize -Prelease
NOTE: Nexus staging (repository.apache.org) should be closed with appropriate comment contains release version and
release candidate number, for example "Apache Ignite 1.0.0-rc7", when mvn deploy finished.
3.5) Checkout https://dist.apache.org/repos/dist/dev/ignite svn. Create release candidate folder with name
equals to release version with "-rc*" ending, for example "1.0.0-rc7", at svn root.
Copy /target/site folder content to svn/ignite/<rc-version> folder and commit with appropriate comment.
3.6) Make appropriate git tag for release candidate, for example "ignite-X.Y.Z-rc1".
4) Start vote based on https://dist.apache.org/repos/dist/dev/ignite/<rc-version>.
5) Release nexus staging, move binaries and sources from https://dist.apache.org/repos/dist/dev/ignite/<rc-version>
to https://dist.apache.org/repos/dist/release/ignite/<version> when version accepted.
Use svn mv ^/dev/ignite/<rc-version> ^/release/ignite/<version> command for proper moving.
6) Make appropriate git tag for released version, for example "ignite-X.Y.Z".
7) Send an email to [email protected] contains release svn url.
JCache TCK compliance
======================
To test compliance with JCache TCK use:
mvn test -P-release,jcache-tck -pl :ignite-core -am
Ignite Mesos Maven Build Instructions
=====================================
cd ./modules/mesos
mvn clean package
Look for ignite-mesos-<version>.jar in ./target directory.
Ignite Yarn Maven Build Instructions
====================================
cd ./modules/yarn
mvn clean package
Look for ignite-yarn-<version>.jar in ./target directory.
Run tests
=========
To run tests locally use:
mvn clean test -U -Plgpl,examples,-clean-libs,-release -Dmaven.test.failure.ignore=true -DfailIfNoTests=false -Dtest=%TEST_PATTERN%
For example, %TEST_PATTERN% can be 'org.apache.ignite.testsuites.IgniteBasicTestSuite' or 'GridCacheLocalAtomicFullApiSelfTest#testGet'
Apache RAT Instructions
=======================
To check license headers use:
mvn clean validate -Pcheck-licenses
For more information (e.g. exclude list) see "check-licenses" profile in "parent/pom.xml".
Useful Release Commands
=======================
ZIP:
zip -r9 apache-ignite-X.X.X-src.zip apache-ignite-X.X.X-src
GPG:
gpg --armor --output apache-ignite-X.X.X-src.zip.asc --detach-sig apache-ignite-X.X.X-src.zip