Skip to content

Commit bf68024

Browse files
committed
Tidy up post-release instructions
Announce, GitHub release, and doc publishing.
1 parent b030000 commit bf68024

1 file changed

Lines changed: 62 additions & 4 deletions

File tree

‎java-sdk/README.md‎

Lines changed: 62 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -467,7 +467,7 @@ Reply with a `[RESULT][VOTE]` tally, then:
467467

468468
Keep the RC tag for traceability.
469469

470-
4. **Publish** a GitHub release. Attach the **voted, signed** source artifacts.
470+
4. Publish a **GitHub release**. Attach the **voted, signed** source artifacts.
471471
From the directory holding the three signed files (e.g. `dist/release`):
472472

473473
```bash
@@ -482,10 +482,68 @@ Reply with a `[RESULT][VOTE]` tally, then:
482482
apache-airflow-java-sdk-<VERSION>-src.tar.gz.sha512
483483
```
484484

485-
Drop the `--prerelease` flag is this is not a prerelease.
485+
Drop the `--prerelease` flag if this is not a prerelease.
486+
487+
5. **Announce.** Wait ~1 hour after promoting so Maven Central has synced, then
488+
send a plain-text `[ANNOUNCE]` email to `users@airflow.apache.org` (cc
489+
`dev@airflow.apache.org`) using the "Announce email template" below, and
490+
record the release (version + date) in the ASF Committee Report Helper:
491+
<https://reporter.apache.org/addrelease.html?airflow>.
492+
493+
6. Publish the **API docs.** Trigger the *Publish Docs to S3* workflow in
494+
`apache/airflow` for the release tag:
495+
496+
```bash
497+
gh workflow run "Publish Docs to S3" --repo apache/airflow --ref main \
498+
-f ref=java-sdk/<VERSION> \
499+
-f include-docs=java-sdk \
500+
-f destination=live
501+
```
502+
503+
Optionally use `destination=staging` first to check, then `live`. It may be
504+
possible to `auto` instead, which resolves to `live` for a release tag.
505+
506+
Confirm that `https://airflow.apache.org/docs/java-sdk/stable/` resolves
507+
(allow time for cache invalidation) and `/docs/java-sdk/` redirects to it.
508+
509+
### Announce email template
510+
511+
Send to `users@airflow.apache.org`, cc `dev@airflow.apache.org`.
512+
513+
```text
514+
Subject: [ANNOUNCE] Apache Airflow Java SDK <VERSION> Released
515+
516+
Dear Airflow community,
517+
518+
I'm happy to announce that Apache Airflow Java SDK <VERSION> was just released.
519+
520+
The signed source release can be downloaded from:
521+
https://downloads.apache.org/airflow/java-sdk/<VERSION>/
522+
523+
We also published the convenience binaries to Maven Central, under group id
524+
org.apache.airflow. Import airflow-sdk-bom:<VERSION> to keep the module versions
525+
aligned.
526+
527+
The API documentation is available at:
528+
https://airflow.apache.org/docs/java-sdk/<VERSION>/
529+
530+
<Optional: one or two lines on notable changes; omit for the first release.>
531+
532+
Thanks to everyone who contributed to and tested this release.
533+
534+
Cheers,
535+
<your name>
536+
```
537+
538+
Pre-send checklist:
539+
540+
* The Maven Central sync has completed (the BOM resolves for a fresh consumer)
541+
and the docs URL above resolves.
542+
* Fill or delete the optional changes line.
543+
* Run `grep '<' email.txt` on the rendered email and confirm **no output** --
544+
any match means a placeholder (`<VERSION>`, `<your name>`, ...) was left
545+
unfilled.
486546

487-
5. Update the download page and wait ~1 hour after promoting so Central has
488-
synced. Send the `[ANNOUNCE]` email.
489547

490548
### If the vote fails
491549

0 commit comments

Comments
 (0)