Skip to content

Commit 31b4c44

Browse files
lidavidmlidavidm
authored
chore(dev/release): fix announce@ mail to comply with ASF policy (apache#3981)
Closes apache#3926.
1 parent 5407d4a commit 31b4c44

File tree

4 files changed

+58
-72
lines changed

4 files changed

+58
-72
lines changed

dev/release/post-10-remove-old-artifacts.sh renamed to dev/release/post-09-remove-old-artifacts.sh

File renamed without changes.

dev/release/post-09-announce.sh renamed to dev/release/post-10-announce.sh

Lines changed: 18 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -16,32 +16,36 @@
1616
# KIND, either express or implied. See the License for the
1717
# specific language governing permissions and limitations
1818
# under the License.
19-
#
19+
20+
# https://apache.org/legal/release-policy#publication
21+
# Don't link to GitHub, etc.
2022
set -ue
2123

2224
SOURCE_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
2325
source "${SOURCE_DIR}/utils-common.sh"
2426
source "${SOURCE_DIR}/utils-prepare.sh"
2527

2628
main() {
27-
2829
set_resolved_issues "${RELEASE}"
2930

31+
read -p "Enter the URL of the announcement blog post..." BLOG_URL
32+
3033
cat <<EOF
3134
To: announce@apache.org
3235
CC: dev@arrow.apache.org
3336
Subject: [ANNOUNCE] Apache Arrow ADBC ${RELEASE} Released
3437
35-
The Apache Arrow community is pleased to announce the a new release of
36-
the Apache Arrow ADBC libraries. It includes ${RESOLVED_ISSUES} resolved GitHub issues
37-
([1]). Individual components are versioned separately: some packages
38-
are on version ${VERSION_NATIVE} and others are now version ${VERSION_JAVA}, with the
39-
release as a whole on version '${RELEASE}'.
38+
The Apache Arrow PMC is pleased to announce release ${RELEASE} of the
39+
Apache Arrow ADBC subproject. Individual components are versioned
40+
separately: some packages are on version ${VERSION_NATIVE} and others
41+
are on version ${VERSION_JAVA}.
4042
41-
The release is available now from [2] and [3].
43+
Release artifacts can be downloaded from:
44+
https://arrow.apache.org/adbc/current/driver/installation.html
4245
46+
This release contains ${RESOLVED_ISSUES} bug fixes and improvements.
4347
Release notes are available at:
44-
https://github.com/apache/arrow-adbc/blob/apache-arrow-adbc-${RELEASE}/CHANGELOG.md
48+
${BLOG_URL}
4549
4650
What is Apache Arrow?
4751
---------------------
@@ -59,19 +63,16 @@ What is Apache Arrow ADBC?
5963
ADBC is a database access abstraction for Arrow-based applications. It
6064
provides a cross-language API for working with databases while using
6165
Arrow data, providing an alternative to APIs like JDBC and ODBC for
62-
analytical applications. For more, see [4].
66+
analytical applications. For more, see [1].
6367
64-
Please report any feedback to the mailing lists ([5], [6]).
68+
Please report any feedback to the mailing lists ([2], [3]).
6569
6670
Regards,
6771
The Apache Arrow Community
6872
69-
[1]: https://github.com/apache/arrow-adbc/issues?q=is%3Aissue+milestone%3A%22ADBC+Libraries+${RELEASE}%22+is%3Aclosed
70-
[2]: https://arrow.apache.org/adbc/current/driver/installation.html
71-
[3]: https://packages.apache.org/ui/native/arrow
72-
[4]: https://arrow.apache.org/blog/2023/01/05/introducing-arrow-adbc/
73-
[5]: https://lists.apache.org/list.html?user@arrow.apache.org
74-
[6]: https://lists.apache.org/list.html?dev@arrow.apache.org
73+
[1]: https://arrow.apache.org/blog/2023/01/05/introducing-arrow-adbc/
74+
[2]: https://lists.apache.org/list.html?user@arrow.apache.org
75+
[3]: https://lists.apache.org/list.html?dev@arrow.apache.org
7576
EOF
7677

7778
}

‎docs/source/development/releasing.rst‎

Lines changed: 20 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -420,22 +420,6 @@ Be sure to go through on the following checklist:
420420

421421
A conda-forge or feedstock maintainer can review and merge.
422422

423-
.. dropdown:: Announce the new release
424-
:class-title: sd-fs-5
425-
:class-container: sd-shadow-md
426-
427-
Write a release announcement and send to announce@apache.org and
428-
dev@arrow.apache.org.
429-
430-
The announcement to announce@apache.org must be sent from your apache.org
431-
e-mail address to be accepted.
432-
433-
Template:
434-
435-
.. code-block:: Bash
436-
437-
dev/release/post-09-announce.sh
438-
439423
.. dropdown:: Remove old artifacts
440424
:class-title: sd-fs-5
441425
:class-container: sd-shadow-md
@@ -444,7 +428,7 @@ Be sure to go through on the following checklist:
444428

445429
.. code-block:: Bash
446430
447-
dev/release/post-10-remove-old-artifacts.sh
431+
dev/release/post-09-remove-old-artifacts.sh
448432
449433
.. dropdown:: Bump versions
450434
:class-title: sd-fs-5
@@ -470,4 +454,23 @@ Be sure to go through on the following checklist:
470454
# dev/release/post-12-website.sh ../arrow-site
471455
dev/release/post-12-website.sh <arrow-site-dir>
472456
457+
.. dropdown:: Announce the new release
458+
:class-title: sd-fs-5
459+
:class-container: sd-shadow-md
460+
461+
Write a release announcement and send to announce@apache.org and
462+
dev@arrow.apache.org. The script below will generate an announcement. It
463+
requires you to provide the URL of the blog post above, so this cannot be
464+
sent until the blog post is published. Also, it expects to be run from the
465+
*release branch* and not ``main``.
466+
467+
The announcement to announce@apache.org must be sent from your apache.org
468+
e-mail address to be accepted.
469+
470+
Template:
471+
472+
.. code-block:: Bash
473+
474+
dev/release/post-10-announce.sh
475+
473476
.. _nightly-website.yml: https://github.com/apache/arrow-adbc/actions/workflows/nightly-website.yml

‎docs/source/driver/installation.rst‎

Lines changed: 20 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,19 @@
1919
Installation
2020
============
2121

22+
.. We can't link to things like conda-forge or crates.io because we
23+
technically do not vote on those packages as part of the release; they are
24+
created post-release. (Python wheels are voted on, though.) If we want to
25+
fix this, we would have to do something like provide prereleases on these
26+
platforms that we promote post-vote.
27+
28+
The main Arrow project links to unofficial releases with a disclaimer, but
29+
as far as I can tell, this isn't actually allowed. Given our announce
30+
emails are getting rejected, let's not risk it.
31+
32+
https://apache.org/legal/release-policy#publication
33+
> Your project's download page can only link to release artifacts that your PMC has approved.
34+
2235
.. note::
2336

2437
See individual driver pages in the sidebar for specific installation instructions.
@@ -28,7 +41,7 @@ Source
2841

2942
Download the latest source release: |source_download| (|source_checksum|, |source_signature|)
3043

31-
To verify a release, please see the `instructions`_ page and the project's `KEYS`_ file.
44+
When downloading, please check the SHA512 checksum, and verify the OpenPGP-compatible signature against the project's `KEYS`_ file. Both the checksum and signature are provided above. See the `instructions`_ page for more details.
3245

3346
Compilation instructions can be found in `CONTRIBUTING.md`_.
3447

@@ -39,18 +52,14 @@ Compilation instructions can be found in `CONTRIBUTING.md`_.
3952
C/C++
4053
=====
4154

42-
Install the appropriate driver package. You can use conda-forge_, ``apt`` or ``dnf``.
43-
44-
conda-forge:
45-
46-
- ``mamba install libadbc-driver-flightsql``
47-
- ``mamba install libadbc-driver-postgresql``
48-
- ``mamba install libadbc-driver-sqlite``
55+
Install the appropriate driver package. Packages for ``apt`` and ``dnf`` are provided as part of official releases.
4956

5057
You can use ``apt`` on the following platforms:
5158

52-
- Debian GNU/Linux bookworm
53-
- Ubuntu 22.04
59+
- Debian GNU/Linux 12 ("bookworm")
60+
- Debian GNU/Linux 13 ("trixie")
61+
- Ubuntu 22.04 LTS ("jammy")
62+
- Ubuntu 24.04 LTS ("noble")
5463

5564
Prepare the Apache Arrow APT repository:
5665

@@ -109,16 +118,6 @@ Then they can be used via CMake, e.g.:
109118
110119
target_link_libraries(myapp PRIVATE AdbcDriverPostgreSQL::adbc_driver_postgresql_shared)
111120
112-
.. _conda-forge: https://conda-forge.org/
113-
114-
Go
115-
==
116-
117-
Add a dependency on the driver package, for example:
118-
119-
- ``go get -u github.com/apache/arrow-adbc/go/adbc@latest``
120-
- ``go get -u github.com/apache/arrow-adbc/go/adbc/driver/flightsql@latest``
121-
122121
Java
123122
====
124123

@@ -141,15 +140,8 @@ For example, from PyPI:
141140
- ``pip install adbc-driver-snowflake``
142141
- ``pip install adbc-driver-sqlite``
143142

144-
From conda-forge_:
145-
146-
- ``mamba install adbc-driver-flightsql``
147-
- ``mamba install adbc-driver-postgresql``
148-
- ``mamba install adbc-driver-snowflake``
149-
- ``mamba install adbc-driver-sqlite``
150-
151143
R
152-
=
144+
===
153145

154146
Install the appropriate driver package from CRAN:
155147

@@ -171,13 +163,3 @@ Ruby
171163

172164
Install the appropriate driver package for C/C++. You can use it from
173165
Ruby.
174-
175-
Rust
176-
====
177-
178-
Add a dependency on ``adbc_core`` and any driver packages
179-
(e.g. ``adbc_datafusion``):
180-
181-
.. code-block:: shell
182-
183-
cargo add adbc_core adbc_datafusion

0 commit comments

Comments
 (0)