aboutsummaryrefslogtreecommitdiffstats
path: root/build/build.xml
blob: 063f1017fb52349c533375b9db1f6ba8f43c61ae (plain)
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
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
<?xml version="1.0" encoding="UTF-8"?>

<project name="phpBB" description="The phpBB forum software" default="all" basedir="../">
	<!-- a few settings for the build -->
	<property name="newversion" value="3.1.0-dev" />
	<property name="prevversion" value="3.0.12" />
	<property name="olderversions" value="3.0.2, 3.0.3, 3.0.4, 3.0.5, 3.0.6, 3.0.7, 3.0.7-PL1, 3.0.8, 3.0.9, 3.0.10, 3.0.11" />
	<!-- no configuration should be needed beyond this point -->

	<property name="oldversions" value="${olderversions}, ${prevversion}" />
	<property name="versions" value="${oldversions}, ${newversion}" />

	<!-- These are the main targets which you will probably want to use -->
	<target name="all" depends="clean,prepare,composer,test,docs,package" />
	<target name="build" depends="clean,prepare,composer,test,docs" />

	<target name="prepare">
		<mkdir dir="build/logs" />
		<mkdir dir="build/api" />
		<mkdir dir="build/codebrowser" />
		<mkdir dir="build/coverage" />
		<mkdir dir="build/cpd" />
		<mkdir dir="build/dependencies" />
		<mkdir dir="build/new_version" />
		<mkdir dir="build/new_version/files" />
		<mkdir dir="build/new_version/patches" />
		<mkdir dir="build/new_version/release_files" />
		<mkdir dir="build/new_version/update" />
		<mkdir dir="build/old_versions" />
		<mkdir dir="build/save" />
	</target>

	<target name="clean">
		<delete dir="build/logs" />
		<delete dir="build/api" />
		<delete dir="build/codebrowser" />
		<delete dir="build/coverage" />
		<delete dir="build/cpd" />
		<delete dir="build/dependencies" />
		<delete dir="build/new_version" />
		<delete dir="build/old_versions" />
		<delete dir="build/save" />
	</target>

	<!--
		This target basically just runs composer in the phpBB tree to ensure
		all dependencies are loaded. Additional development dependencies are
		loaded because testing framework may depend on them.
	-->
	<target name="composer">
		<exec dir="phpBB"
			command="php ../composer.phar install --dev"
			checkreturn="true"
			passthru="true" />
	</target>

	<target name="test" depends="clean,prepare,composer">
		<exec dir="."
			command="phpBB/vendor/bin/phpunit
			--log-junit build/logs/phpunit.xml
			--coverage-clover build/logs/clover.xml
			--coverage-html build/coverage"
			passthru="true" />
	</target>

	<target name="test-slow" depends="clean,prepare,composer">
		<exec dir="."
			command="phpBB/vendor/bin/phpunit
			--log-junit build/logs/phpunit.xml
			--configuration phpunit.xml.all
			--group slow
			--coverage-clover build/logs/clover-slow.xml
			--coverage-html build/coverage-slow"
			passthru="true" />
	</target>

	<target name="docs">
		<!-- only works if you setup phpdoctor:
                     git clone https://github.com/peej/phpdoctor.git
                     and then create an executable phpdoctor in your path containing
                     #!/bin/sh
                     php -f /path/to/phpdoctor/phpdoc.php $@
                -->
		<exec dir="build"
			command="phpdoctor phpdoc-phpbb.ini"
			passthru="true" />
	</target>

	<target name="old-version-diffs">
		<foreach list="${oldversions}" param="version" target="old-version-diff" />
	</target>

	<!-- This target retrieves an old version from the git tag release-${version}
	     and creates a diff between that release and the new one -->
	<target name="old-version-diff">
		<echo msg="Retrieving version ${version}" />
		<mkdir dir="build/old_versions/release-${version}" />

		<phingcall target="export">
			<property name="revision" value="release-${version}" />
			<property name="dir" value="build/old_versions/release-${version}" />
		</phingcall>

		<phingcall target="clean-diff-dir">
			<property name="dir" value="build/old_versions/release-${version}" />
		</phingcall>

		<exec dir="build/old_versions" command="diff -crNEBwd release-${version} release-${newversion} >
			../new_version/patches/phpBB-${version}_to_${newversion}.patch" escape="false" />
	</target>

	<target name="prepare-new-version">
		<!-- select the currently checked out commit (HEAD) for packaging -->
		<mkdir dir="build/new_version/phpBB3" />
		<phingcall target="export">
			<property name="revision" value="HEAD" />
			<property name="dir" value="build/new_version/phpBB3" />
		</phingcall>

		<!-- copy into directory for diffs -->
		<exec dir="build" command="cp -rp new_version/phpBB3 old_versions/release-${newversion}" />
		<!-- and clean up -->
		<phingcall target="clean-diff-dir">
			<property name="dir" value="build/old_versions/release-${newversion}" />
		</phingcall>

		<!-- create an empty config.php file (not for diffs) -->
		<touch file="build/new_version/phpBB3/config.php" />

	</target>

	<target name="package" depends="clean,prepare,prepare-new-version,old-version-diffs">
		<exec dir="build" command="php -f package.php '${versions}' > logs/package.log" escape="false" />
		<exec dir="build" command="php -f build_diff.php '${prevversion}' '${newversion}' > logs/build_diff.log" escape="false" />

		<exec dir="build" escape="false"
			command="diff -crNEBwd old_versions/release-${prevversion}/language new_version/phpBB3/language >
				save/save_${prevversion}_to_${newversion}/language/phpbb-${prevversion}_to_${newversion}_language.patch" />
		<exec dir="build" escape="false"
			command="diff -crNEBwd old_versions/release-${prevversion}/styles/prosilver new_version/phpBB3/styles/prosilver >
				save/save_${prevversion}_to_${newversion}/prosilver/phpbb-${prevversion}_to_${newversion}_prosilver.patch" />
		<exec dir="build" escape="false"
			command="diff -crNEBwd old_versions/release-${prevversion}/styles/subsilver2 new_version/phpBB3/styles/subsilver2 >
				save/save_${prevversion}_to_${newversion}/subsilver2/phpbb-${prevversion}_to_${newversion}_subsilver2.patch" />

		<exec dir="build" escape="false"
			command="git shortlog --summary --numbered release-${prevversion}...HEAD >
				save/save_${prevversion}_to_${newversion}/phpbb-${prevversion}_to_${newversion}_git_shortlog.txt" />
		<exec dir="build" escape="false"
			command="git diff --stat release-${prevversion}...HEAD >
				save/save_${prevversion}_to_${newversion}/phpbb-${prevversion}_to_${newversion}_git_diffstat.txt" />

		<phingcall target="checksum-dir">
			<property name="dir" value="build/new_version/release_files" />
		</phingcall>
	</target>

	<target name="checksum-dir">
		<foreach param="filename" absparam="absfilename" target="checksum-file">
			<fileset dir="${dir}">
				<type type="file" />
			</fileset>
		</foreach>
	</target>

	<target name="checksum-file">
		<echo msg="Creating checksum file for ${absfilename}" />
		<php function="dirname" returnProperty="dir"><param value="${absfilename}"/></php>
		<exec dir="${dir}" command="sha256sum ${filename} > ${filename}.sha256" />
	</target>

	<target name="announcement" depends="prepare">
		<echo msg="Writing download links and checksums for email announcement to save/announcement_email_${newversion}.txt" />
		<exec dir="build" escape="false"
			command="php -f build_announcement.php email '${newversion}' 'new_version/release_files' sha256 >
				save/announcement_email_${newversion}.txt"  />

		<echo msg="Writing download links and checksums for bbcode announcement to save/announcement_bbcode_${newversion}.txt" />
		<exec dir="build" escape="false"
			command="php -f build_announcement.php bbcode '${newversion}' 'new_version/release_files' sha256 >
				save/announcement_bbcode_${newversion}.txt"  />
	</target>

	<target name="changelog" depends="prepare">
		<exec dir="build" escape="false"
			command="php -f build_changelog.php '${newversion}' >
				save/changelog_${newversion}.html"  />
	</target>

	<!--
		This target can be called using phingcall to retrieve a clean
		checkout of a commit from git. It will only export the phpBB directory.
		The properties revision and dir are required.
		This target will remove directories that are not needed in distribution
		and set correct permissions.
	-->
	<target name="export">
		<exec dir="phpBB"
			command="git archive ${revision} | tar -xf - -C ../${dir}"
			checkreturn="true" />

		<!-- Install composer dependencies, if there are any. -->
		<exec dir="${dir}"
			command='php -r "\$j = json_decode(file_get_contents(\"composer.json\")); echo isset(\$j->require);"'
			checkreturn="true"
			outputProperty='composer-has-dependencies' />
		<if>
			<equals arg1="${composer-has-dependencies}" arg2="1" trim="true" />
			<then>
				<!-- We have non-dev composer dependencies -->
				<exec dir="."
					command="git ls-tree ${revision} composer.phar"
					checkreturn="true"
					outputProperty='composer-ls-tree-output' />
				<if>
					<equals arg1="${composer-ls-tree-output}" arg2="" trim="true" />
					<then>
						<fail message="There are composer dependencies, but composer.phar is missing." />
					</then>
					<else>
						<!-- Export the phar, install dependencies, delete phar. -->
						<exec dir="."
							command="git archive ${revision} composer.phar | tar -xf - -C ${dir}"
							checkreturn="true" />
						<exec dir="${dir}"
							command="php composer.phar install"
							checkreturn="true"
							passthru="true" />
						<delete file="${dir}/composer.phar" />
					</else>
				</if>
			</then>
			<else>
				<!-- We do not have composer dependencies, do not ship composer files -->
				<delete file="${dir}/composer.json" />
				<delete file="${dir}/composer.lock" />
			</else>
		</if>

		<delete file="${dir}/config.php" />
		<delete dir="${dir}/develop" />
		<delete dir="${dir}/install/data" />

		<echo msg="Setting permissions for checkout of ${revision} in ${dir}" />
		<!-- set permissions of all files to 644, directories to 755 -->
		<exec dir="${dir}" command="find . -type f|xargs chmod 644" escape="false" />
		<exec dir="${dir}" command="find . -type d|xargs chmod 755" escape="false" />
		<!-- set permissions of some directories to 777 -->
		<chmod mode="0777" file="${dir}/cache" />
		<chmod mode="0777" file="${dir}/store" />
		<chmod mode="0777" file="${dir}/files" />
		<chmod mode="0777" file="${dir}/images/avatars/upload" />
	</target>

	<target name="clean-diff-dir">
		<delete dir="${dir}/cache" />
		<delete dir="${dir}/docs" />
		<delete dir="${dir}/files" />
		<delete dir="${dir}/install" />
		<delete dir="${dir}/store" />
		<delete dir="${dir}/vendor" />
	</target>

</project>