forked from elastic/elasticsearch
-
Notifications
You must be signed in to change notification settings - Fork 0
/
ReleaseToolsPlugin.java
111 lines (90 loc) · 4.97 KB
/
ReleaseToolsPlugin.java
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
/*
* Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
* or more contributor license agreements. Licensed under the Elastic License
* 2.0 and the Server Side Public License, v 1; you may not use this file except
* in compliance with, at your election, the Elastic License 2.0 or the Server
* Side Public License, v 1.
*/
package org.elasticsearch.gradle.internal.release;
import org.elasticsearch.gradle.Version;
import org.elasticsearch.gradle.VersionProperties;
import org.elasticsearch.gradle.internal.conventions.precommit.PrecommitTaskPlugin;
import org.elasticsearch.gradle.internal.precommit.ValidateYamlAgainstSchemaTask;
import org.gradle.api.Plugin;
import org.gradle.api.Project;
import org.gradle.api.file.Directory;
import org.gradle.api.file.FileTree;
import org.gradle.api.file.ProjectLayout;
import org.gradle.api.provider.Provider;
import org.gradle.api.tasks.TaskProvider;
import org.gradle.api.tasks.util.PatternSet;
import java.io.File;
import javax.inject.Inject;
/**
* This plugin defines tasks related to releasing Elasticsearch.
*/
public class ReleaseToolsPlugin implements Plugin<Project> {
private static final String RESOURCES = "build-tools-internal/src/main/resources/";
private final ProjectLayout projectLayout;
@Inject
public ReleaseToolsPlugin(ProjectLayout projectLayout) {
this.projectLayout = projectLayout;
}
@Override
public void apply(Project project) {
project.getPluginManager().apply(PrecommitTaskPlugin.class);
final Directory projectDirectory = projectLayout.getProjectDirectory();
final Version version = VersionProperties.getElasticsearchVersion();
final FileTree yamlFiles = projectDirectory.dir("docs/changelog")
.getAsFileTree()
.matching(new PatternSet().include("**/*.yml", "**/*.yaml"));
final Provider<ValidateYamlAgainstSchemaTask> validateChangelogsAgainstYamlTask = project.getTasks()
.register("validateChangelogsAgainstSchema", ValidateYamlAgainstSchemaTask.class, task -> {
task.setGroup("Documentation");
task.setDescription("Validate that the changelog YAML files comply with the changelog schema");
task.setInputFiles(yamlFiles);
task.setJsonSchema(new File(project.getRootDir(), RESOURCES + "changelog-schema.json"));
task.setReport(new File(project.getBuildDir(), "reports/validateYaml.txt"));
});
final TaskProvider<ValidateChangelogEntryTask> validateChangelogsTask = project.getTasks()
.register("validateChangelogs", ValidateChangelogEntryTask.class, task -> {
task.setGroup("Documentation");
task.setDescription("Validate that all changelog YAML files are well-formed");
task.setChangelogs(yamlFiles);
task.dependsOn(validateChangelogsAgainstYamlTask);
});
project.getTasks().register("generateReleaseNotes", GenerateReleaseNotesTask.class).configure(task -> {
task.setGroup("Documentation");
task.setDescription("Generates release notes from changelog files held in this checkout");
task.setChangelogs(yamlFiles);
task.setReleaseNotesIndexTemplate(projectDirectory.file(RESOURCES + "templates/release-notes-index.asciidoc"));
task.setReleaseNotesIndexFile(projectDirectory.file("docs/reference/release-notes.asciidoc"));
task.setReleaseNotesTemplate(projectDirectory.file(RESOURCES + "templates/release-notes.asciidoc"));
task.setReleaseNotesFile(
projectDirectory.file(
String.format(
"docs/reference/release-notes/%d.%d.%d.asciidoc",
version.getMajor(),
version.getMinor(),
version.getRevision()
)
)
);
task.setReleaseHighlightsTemplate(projectDirectory.file(RESOURCES + "templates/release-highlights.asciidoc"));
task.setReleaseHighlightsFile(projectDirectory.file("docs/reference/release-notes/highlights.asciidoc"));
task.setBreakingChangesTemplate(projectDirectory.file(RESOURCES + "templates/breaking-changes.asciidoc"));
task.setBreakingChangesMigrationFile(
projectDirectory.file(
String.format("docs/reference/migration/migrate_%d_%d.asciidoc", version.getMajor(), version.getMinor())
)
);
task.dependsOn(validateChangelogsTask);
});
project.getTasks().register("pruneChangelogs", PruneChangelogsTask.class).configure(task -> {
task.setGroup("Documentation");
task.setDescription("Removes changelog files that have been used in a previous release");
task.setChangelogs(yamlFiles);
});
project.getTasks().named("precommit").configure(task -> task.dependsOn(validateChangelogsTask));
}
}