Add polaris-version artifact
#591
Conversation
Utility artifact that provides static resources containing the version and NOTICE + LICENSE* files, which can be directly served by Quarkus as static web resources, for example `http://127.0.0.1:19120/apache-polaris/NOTICE.txt`. Utility class that provides above mentioned resources programmatically, plus information for release-builds like the Git tag, Git commit ID, build system. Fixes apache#557
snazy
requested review from
jbonofre,
ashvina,
RussellSpitzer,
vvcephei,
takidau,
jackye1995,
flyrain,
eric-maynard,
collado-mike,
ebyhr and
adutra
as code owners
| val versionProperties by | ||
| tasks.registering(Sync::class) { | ||
| destinationDir = project.layout.buildDirectory.dir("version").get().asFile | ||
| from(project.layout.files("src/main/version")) |
There was a problem hiding this comment.
It probably doesn't matter much, but isn't src/main/resources a more common name?
There was a problem hiding this comment.
Sure, usually. But this should limit the replacement to that particular file - hence the separate folder.
| try (InputStream in = resourceUrl.openConnection().getInputStream()) { | ||
| return new String(in.readAllBytes(), UTF_8); | ||
| } catch (IOException e) { | ||
| throw new RuntimeException("Failed to load resource " + fullResource + " resource", e); |
There was a problem hiding this comment.
nit: word "resource" is repeated.
| static { | ||
| loadManifest("MANIFEST.MF"); | ||
| } | ||
|
|
||
| static void loadManifest(String manifestFile) { |
There was a problem hiding this comment.
Using a HashMap is probably safe here but the below variant makes it clear that the map is read-only:
| static { | |
| loadManifest("MANIFEST.MF"); | |
| } | |
| static void loadManifest(String manifestFile) { | |
| static { | |
| BUILD_INFO = Map.of(loadManifest("MANIFEST.MF")); | |
| } | |
| static Map<String, String> loadManifest(String manifestFile) { |
There was a problem hiding this comment.
Sure, but that would break the fake-manifest test
| * information} is available, when Polaris has been built with the Gradle {@code -Prelease} | ||
| * project property.. | ||
| * | ||
| * <p>Example value: {@code 1.0.0-incubating-SNAPSHOT} |
There was a problem hiding this comment.
Hmm is this example accurate? A release build wouldn't have the -SNAPSHOT suffix.
There was a problem hiding this comment.
It could, if SNAPSHOT releases are published. Anyway, added more examples.
| * build-time Git information} is available, when Polaris has been built with the Gradle {@code | ||
| * -Prelease} project property. | ||
| * | ||
| * <p>Example value: {@code 21.0.5} |
Utility artifact that provides static resources containing the version and NOTICE + LICENSE* files, which can be directly served by Quarkus as static web resources, for example
http://127.0.0.1:19120/apache-polaris/NOTICE.txt.Utility class that provides above mentioned resources programmatically, plus information for release-builds like the Git tag, Git commit ID, build system.
Fixes #557