aboutsummaryrefslogtreecommitdiff
path: root/buildScripts/website.ant.xml
blob: 517594754b830758e6e4484c1a8f506fd29e7cbd (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
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
<!--
  Copyright (C) 2020-2023 The Project Lombok Authors.
  
  Permission is hereby granted, free of charge, to any person obtaining a copy
  of this software and associated documentation files (the "Software"), to deal
  in the Software without restriction, including without limitation the rights
  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  copies of the Software, and to permit persons to whom the Software is
  furnished to do so, subject to the following conditions:
  
  The above copyright notice and this permission notice shall be included in
  all copies or substantial portions of the Software.
  
  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  THE SOFTWARE.
-->
<project name="lombok-website" basedir=".." default="website" xmlns:ivy="antlib:com.zwitserloot.ivyplusplus">
	<description>
This buildfile is part of projectlombok.org. It is responsible for building the website and all website-related aspects,
such as applying the templates to produce the website, converting the changelog into HTML, and creating javadoc.
	</description>
	
	<property name="web.root" value="https://projectlombok.org/" />
	<property name="SNIPPET_TAB_STOP" value="2" />
	
	<target name="-website.clean">
		<delete dir="build/website" quiet="true" />
	</target>
	
	<!-- Fetches the current (latest) lombok available from projectlombok.org, tracking this 'latest available version' in ant properties -->
	<target name="-website.fetch-version" depends="compile.support">
		<java classname="lombok.website.FetchCurrentVersion" outputproperty="lombok.version.live" failonerror="true">
			<classpath>
				<path refid="cp.buildtools" />
				<pathelement location="build/support" />
			</classpath>
			<arg value="${web.root}" />
			<arg value="base" />
		</java>
		<java classname="lombok.website.FetchCurrentVersion" outputproperty="lombok.fullversion.live" failonerror="true">
			<classpath>
				<path refid="cp.buildtools" />
				<pathelement location="build/support" />
			</classpath>
			<arg value="${web.root}" />
			<arg value="full" />
		</java>
	</target>
	
	<target name="website.print-live-version" depends="-website.fetch-version" description="Print the current version of lombok available from projectlombok.org">
		<echo>Live version: ${lombok.version.live}</echo>
		<echo>Live full versionstring : ${lombok.fullversion.live}</echo>
	</target>
	
	<target name="changelog.build" depends="version, deps, compile.support" description="Turns the current changelog (doc/changelog.markdown) into HTML">
		<mkdir dir="build/website" />
		<java classname="lombok.website.WebsiteMaker" failonerror="true">
			<classpath>
				<path refid="cp.buildtools" />
				<pathelement location="build/support" />
			</classpath> 
			<arg value="${web.root}" />
			<arg value="${lombok.version}" />
			<arg value="${lombok.fullversion}" />
			<arg value="changelog" />
		</java>
	</target>
	
	<macrodef name="website.make">
		<attribute name="version" />
		<attribute name="fullversion" />
		<attribute name="cmd" />
		<sequential>
			<mkdir dir="build/website" />
			<copy todir="build/website">
				<fileset dir="website/resources" />
				<fileset dir="." includes="LICENSE" />
			</copy>
			
			<java classname="lombok.website.WebsiteMaker" failonerror="true">
				<classpath>
					<path refid="cp.buildtools" />
					<pathelement location="build/support" />
				</classpath>
				<arg value="${web.root}" />
				<arg value="@{version}" />
				<arg value="@{fullversion}" />
				<arg value="@{cmd}" />
			</java>
		</sequential>
	</macrodef>
	
	<target name="website.release-build" depends="version, -website.clean, javadoc.build, compile.support">
		<website.make version="${lombok.version}" fullversion="${lombok.fullversion}" cmd="all-newrelease" />
	</target>
	
	<target name="website.build" depends="-website.fetch-version, -website.clean, compile.support" description="Builds the website based on current live version">
		<website.make version="${lombok.version.live}" fullversion="${lombok.fullversion.live}" cmd="all" />
	</target>
	
	<target name="website.open" depends="website.build, compile.support" description="Builds the website, then serves it locally, opening a browser.">
		<local name="dir.build.website" />
		<property name="dir.build.website" location="build/website" />
		<java classname="lombok.website.RunSite" failonerror="true">
			<classpath>
				<path refid="cp.buildtools" />
				<pathelement location="build/support" />
			</classpath>
			<arg value="${dir.build.website}" />
			<arg value="open" />
		</java>
	</target>
	
	<target name="website.print-all-versions" depends="compile.support">
		<java classname="lombok.website.WebsiteMaker" failonerror="true">
			<classpath>
				<path refid="cp.buildtools" />
				<pathelement location="build/support" />
			</classpath>
			<arg value="${web.root}" />
			<arg value="1" />
			<arg value="1" />
			<arg value="print-allversions" />
		</java>
	</target>
	
	<target name="-website.init-hostgit">
		<property name="loc.hostingGit" location="../website-cloudflare" />
		<fail>
			You need the website-cloudflare repo as a sibling to your lombok repo to publish the website.
			<condition>
				<not><available file="${loc.hostingGit}/.git" /></not>
			</condition>
		</fail>
	</target>
	
	<target name="-website.copyto-hostgit">
		<sync todir="${loc.hostingGit}/website">
			<fileset dir="build/website" />
		</sync>
	</target>
	
	<target name="-website.pull-hostgit" depends="deps, -website.init-hostgit">
		<exec executable="${exe.git}" failonerror="true" dir="${loc.hostingGit}">
			<arg value="pull" />
		</exec>
	</target>
	
	<target name="-website.commit-and-push-hostgit">
		<exec executable="${exe.git}" failonerror="true" dir="${loc.hostingGit}">
			<arg value="add" />
			<arg value="-A" />
		</exec>
		<exec executable="${exe.git}" failonerror="true" dir="${loc.hostingGit}">
			<arg value="commit" />
			<arg value="-m" />
			<arg value="website update" />
		</exec>
		<exec executable="${exe.git}" failonerror="true" dir="${loc.hostingGit}">
			<arg value="push" />
		</exec>
	</target>
	
	<target name="website.publish" depends="-website.pull-hostgit, website.build, -website.copyto-hostgit" description="Builds the website and copies it to the git repo serving as source for the cloudflare-hosted projectlombok.org site">
		<antcall target="-website.commit-and-push-hostgit" />
	</target>
	
	<target name="website.release-publish" depends="dist, -website.pull-hostgit, website.release-build, -website.copyto-hostgit" description="Builds the website and copies it to the git repo serving as source for the cloudflare-hosted projectlombok.org site">
		<sync todir="${loc.hostingGit}/api">
			<fileset dir="doc/api" />
		</sync>
		<echo file="${loc.hostingGit}/CURRENT_VERSION">${lombok.version}</echo>
		<copy file="dist/lombok-${lombok.version}.jar" todir="${loc.hostingGit}/releases" />
		<antcall target="-website.commit-and-push-hostgit" />
	</target>
	
	<target name="javadoc.build" description="Generates the javadoc" depends="version, compile" unless="skip.javadoc">
		<delete dir="build/api" quiet="true" />
		<delete dir="doc/api" quiet="true" />
		<mkdir dir="build/api" />
		<property name="javadoc.overview.html" location="build/javadoc.overview.html" />
		<echo file="${javadoc.overview.html}"><![CDATA[<html><body>
			Welcome to the lombok javadoc.&nbsp;If you're just looking to learn more about using lombok
			You probably want to look at <a href="https://projectlombok.org/features/all">the feature documentation</a>.&nbsp;Otherwise,
			check the <a href="lombok/package-summary.html">lombok</a> package.&nbsp;If you're trying to extend lombok or
			write your own plugins, the other packages are what you're looking for.</body></html>
		]]></echo>
		<tstamp>
			<format property="javadoc.year" pattern="yyyy" />
		</tstamp>
		<javadoc sourcepath="src/core" defaultexcludes="yes" destdir="build/api" windowtitle="Lombok" source="1.8" Overview="${javadoc.overview.html}">
			<package name="lombok" />
			<package name="lombok.experimental" />
			<package name="lombok.extern.*" />
			<classpath location="build/lombok-main" />
			<classpath location="build/lombok-utils" />
			<header><![CDATA[<a href='https://projectlombok.org/' target='_blank'>Lombok</a> - ]]>v${lombok.version}</header>
			<bottom><![CDATA[<i>Copyright &copy; 2009-${javadoc.year} The Project Lombok Authors, licensed under the <a href='http://www.opensource.org/licenses/mit-license.php' target='_blank'>MIT licence</a>.</i>]]></bottom>
		</javadoc>
		<!-- bugfix for boneheaded javadoc bug where ?is-external=true is inserted before an anchor ref, breaking the anchor ref.
		is-external=true doesn't actually do anything except mess with titles, so, we'll just get rid of it. -->
		<replaceregexp match="\?is-external=true#" replace="#" flags="gi">
			<fileset dir="build/api" includes="**/*.html" />
		</replaceregexp>
		<mkdir dir="doc/api" />
		<copy todir="doc/api">
			<fileset dir="build/api" includes="**/*.html" />
			<filterchain>
				<linecontainsregexp negate="true">
					<regexp pattern="(Generated by javadoc)|(.META NAME=.date.)|(meta name=.dc.created.)" />
				</linecontainsregexp>
			</filterchain>
		</copy>
		<copy todir="doc/api">
			<fileset dir="build/api" includes="**/*.css" />
			<filterchain>
				<linecontainsregexp negate="true">
					<regexp pattern="@import.*dejavu.css.*" />
				</linecontainsregexp>
			</filterchain>
		</copy>
		<copy todir="doc/api">
			<fileset dir="build/api">
				<exclude name="**/*.html" />
				<exclude name="**/*.css" />
			</fileset>
		</copy>
		<echo append="true" file="doc/api/module-search-index.js"></echo>
		<echo append="true" file="doc/api/tag-search-index.js"></echo>
	</target>
	
	<target name="latest-changes.build" depends="compile.support, version" description="Creates the latest changes HTML file from the markdown in doc/changelog">
		<mkdir dir="build/website" />
		<java classname="lombok.website.WebsiteMaker" failonerror="true">
			<classpath>
				<path refid="cp.buildtools" />
				<pathelement location="build/support" />
			</classpath>
			<arg value="${web.root}" />
			<arg value="${lombok.version}" />
			<arg value="${lombok.fullversion}" />
			<arg value="changelog-latest" />
			<arg value="website" />
			<arg value="build/latestchanges.html" />
		</java>
	</target>
	
	<target name="release.pack" depends="dist, website.release-build">
		<tar destfile="dist/website-release.tar.bz2" compression="bzip2">
			<tarfileset dir="dist" includes="lombok-${lombok.version}.jar" prefix="downloads/" />
			<tarfileset dir="dist" includes="lombok-${lombok.version}.jar" fullpath="downloads/lombok.jar" />
			<tarfileset dir="dist" includes="lombok-${lombok.version}.jar" fullpath="lombok-edge.jar" />
			<tarfileset dir="build/website" includes="all-versions.html,download.html,download-edge.html" />
		</tar>
	</target>
	
	<target name="-release.publish.site" depends="release.pack">
		<fail />
	</target>
	
	<target name="release.publish" depends="maven, -release.publish.site, website.publish, eclipsep2.publish, maven.publish" description="Deploys a new official lombok release everywhere: maven, website, p2 site" />
	
	<target name="edge.website" depends="compile.support, version, dist">
		<delete quiet="true" file="build/website/download-edge.html" />
		<mkdir dir="build/website-edge" />
		<java classname="lombok.website.WebsiteMaker" failonerror="true">
			<classpath>
				<path refid="cp.buildtools" />
				<pathelement location="build/support" />
			</classpath>
			<arg value="${web.root}" />
			<arg value="${lombok.version}" />
			<arg value="${lombok.fullversion}" />
			<arg value="download-edge" />
			<arg value="website" />
			<arg value="build/website-edge/download-edge.html" />
		</java>
	</target>
	
	<target name="-edge.website.tohost" depends="edge.website, -website.init-hostgit, -website.pull-hostgit">
		<copy file="build/website-edge/download-edge.html" todir="${loc.hostingsite}/website" />
	</target>
		
	<target name="-edge.website.publish" depends="-edge.website.tohost, -website.commit-and-push-hostgit" />
	
	<target name="edge.publish" depends="dist, -edge.website.publish, maven.edge" description="Builds an edge release, sends it to the projectlombok.org server and deploys it by updating the download-edge link">
		<copy file="dist/lombok-${lombok.version}.jar" tofile="build/edge-releases/lombok-edge.jar" />
		<java classname="lombok.publish.PublishToBucket" failonerror="true">
			<classpath>
				<path refid="cp.buildtools" />
				<pathelement location="build/support" />
			</classpath>
			<arg value="${gpg.keyrings}/s3_creds.txt" />
			<arg value="build/edge-releases" />
			<arg value="edge" />
			<arg value="true" />
		</java>
		<exec executable="/usr/bin/git" failonerror="true">
			<arg value="merge-base" />
			<arg value="--is-ancestor" />
			<arg value="edge" />
			<arg value="master" />
		</exec>
		<exec executable="/usr/bin/git">
			<arg value="branch" />
			<arg value="-f" />
			<arg value="edge" />
			<arg value="master" />
		</exec>
		<exec executable="/usr/bin/git">
			<arg value="push" />
			<arg value="origin" />
			<arg value="edge:refs/heads/edge" />
		</exec>
	</target>
</project>