Skip to content

Commit 15c2fac

Browse files
meonkeysgalovics
authored andcommitted
FINERACT-2424: post 1.14.0 release docs cleanup
* Go analog for step 15, automation was broken. * Fix two admonitions: I meant to use `NOTE`. `INFO` is not a valid admonition in asciidoc, so it just shows up as text.
1 parent d8b6649 commit 15c2fac

File tree

6 files changed

+25
-80
lines changed

6 files changed

+25
-80
lines changed

buildSrc/src/main/groovy/org/apache/fineract/gradle/FineractPlugin.groovy

Lines changed: 1 addition & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -432,36 +432,7 @@ class FineractPlugin implements Plugin<Project> {
432432
doFirst {
433433
log.warn("Release step 15: send email to announcement mailing list")
434434

435-
FineractPluginExtension.FineractPluginStep step = step(extension, "step15")
436-
437-
String version = project.properties?['fineract.release.version']
438-
439-
if(!version) {
440-
TextIO textIO = TextIoFactory.getTextIO()
441-
442-
version = textIO.newStringInputReader()
443-
.withPattern("\\d+.\\d+.\\d+")
444-
.read("Release Version");
445-
}
446-
447-
// TODO: input validation, see FINERACT-1610
448-
449-
FineractPluginExtension.FineractPluginJiraParams issues = jiraService.search(step.jira)
450-
451-
def versions = jiraService.getProjectVersions(step.jira.projectId)
452-
def filteredVersions = versions.findAll {
453-
log.warn(">>>> VERSION: ${it.id} - ${it.name} - ${it.description}")
454-
it.name == version
455-
}
456-
457-
this.context?.project?['fineract.release.version'] = version
458-
this.context?.project?['fineract.release.issues'] = issues.result
459-
this.context?.project?['fineract.release.projectId'] = step.jira.projectId
460-
this.context?.project?['fineract.release.versionId'] = filteredVersions[0]?.id
461-
462-
if(step.email) {
463-
emailService.send( processEmailParams(step.email, this.context) )
464-
}
435+
printInstructions(project, "step15")
465436
}
466437
}
467438
}

buildSrc/src/main/resources/email/release.step15.announce.message.ftl

Lines changed: 0 additions & 40 deletions
This file was deleted.

buildSrc/src/main/resources/email/release.step15.announce.subject.ftl renamed to buildSrc/src/main/resources/instructions/step15.txt.ftl

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,4 +18,12 @@
1818
under the License.
1919
2020
-->
21-
[ANNOUNCE] Apache Fineract ${project['fineract.release.version']} Release
21+
22+
23+
[INSTRUCTIONS:START]
24+
25+
Manually draft an email using your Apache ID.
26+
27+
See https://fineract.apache.org/docs/current/#_step_15_announcement_email
28+
29+
[INSTRUCTIONS:END]

fineract-doc/src/docs/en/chapters/release/process-step10.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,4 +12,4 @@ Initiate voting with https://release-test.apache.org[the ATR (ASF Trusted Releas
1212
./gradlew fineractReleaseStep10
1313
----
1414

15-
INFO: Use the ATR for this task.
15+
NOTE: Use the ATR for this task.

fineract-doc/src/docs/en/chapters/release/process-step11.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,4 +12,4 @@ Conclude voting with https://release-test.apache.org[the ATR (ASF Trusted Releas
1212
./gradlew fineractReleaseStep11
1313
----
1414

15-
INFO: Use the ATR for this task.
15+
NOTE: Use the ATR for this task.

fineract-doc/src/docs/en/chapters/release/process-step15.adoc

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,19 +2,25 @@
22

33
== Description
44

5-
Send an email to `[email protected]` (sender address must be `@apache.org`):
5+
Manually draft an email using your Apache ID. This works best if you use plain text since the Apache announcements list rejects HTML. Use `format=flowed` for readability, following instructions at https://useplaintext.email. Follow a https://lists.apache.org/thread/0xrtf2tgbcgczx1w6rlt9lxqvx68bfg3[recent example], substituting:
66

7-
[source,text]
8-
----
9-
include::{rootdir}/buildSrc/src/main/resources/email/release.step15.announce.subject.ftl[lines=21..]
7+
****
8+
* [ ] version number in subject
9+
* [ ] version number in intro paragraph
10+
* [ ] number of issues addressed (get this number from the release page on confluence -- the github release page includes unresolved issues since issues can span multiple PRs)
11+
* [ ] version number in release page link
12+
* [ ] version number (aka git tag) in link to "Contributors, changelog, and pull requests" (github release page)
13+
* [ ] use your own email signature, or omit the email signature altogether
14+
****
1015

11-
include::{rootdir}/buildSrc/src/main/resources/email/release.step15.announce.message.ftl[lines=21..]
12-
----
16+
Send the email to [email protected] and [email protected].
1317

1418
== Gradle Task
1519

1620
.Command
1721
[source,bash,subs="attributes+,+macros"]
1822
----
19-
./gradlew fineractReleaseStep15 -Pfineract.release.version={revnumber}
23+
./gradlew fineractReleaseStep15
2024
----
25+
26+
NOTE: Do this task manually.

0 commit comments

Comments
 (0)