Skip to content

PHOENIX-7956: Add release and vote tooling #12

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
palashc wants to merge 1 commit into from
Closed

PHOENIX-7956: Add release and vote tooling #12

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
229 changes: 229 additions & 0 deletions LICENSE
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,229 @@
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/

TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

1. Definitions.

"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.

"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.

"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.

"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.

"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.

"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.

"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).

"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.

"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."

"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.

2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.

3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.

4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:

(a) You must give any other recipients of the Work or Derivative
Works a copy of this License; and

(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and

(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work, excluding
those notices that do not pertain to any part of the Derivative
Works; and

(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one of
the following places: within a NOTICE text file distributed as
part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and do
not modify the License. You may add Your own attribution notices
within Derivative Works that You distribute, alongside or as an
addendum to the NOTICE text from the Work, provided that such
additional attribution notices cannot be construed as modifying
the License.

You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.

5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.

6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.

7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.

8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.

9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.

END OF TERMS AND CONDITIONS

APPENDIX: How to apply the Apache License to your work.

To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.

Copyright [yyyy] [name of copyright owner]

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.


=======================================================================
APACHE PHOENIX ADAPTERS SUBCOMPONENTS
=======================================================================

The Apache Phoenix Adapters SOURCE distribution contains only Apache-licensed
first-party source code and requires no additional third-party license notices.

The Apache Phoenix Adapters BINARY distribution (the -bin.tar.gz produced by the
phoenix-ddb-assembly module) bundles third-party dependencies under their own
licenses. Notable non-Apache-2.0 bundled components include:

* ANTLR 4 Runtime (org.antlr:antlr4-runtime) -- BSD 3-Clause License
https://www.antlr.org/license.html

All other bundled runtime dependencies (Apache Phoenix, Apache HBase, Apache
Hadoop, Apache ZooKeeper, Apache Log4j 2, AWS SDK for Java, Eclipse Jetty's
Apache-2.0-licensed artifacts, etc.) are distributed under the Apache License,
Version 2.0.

NOTE TO THE RELEASE MANAGER: before calling a release vote, complete a full
LICENSE/NOTICE audit of every artifact packaged into the binary tarball
(mvn dependency:tree on phoenix-ddb-assembly) and expand the list above with the
exact license text/pointer for every non-Apache-2.0 component (e.g. Jetty's EPL
dual-licensed pieces, CDDL components, BSD/MIT components). See
https://www.apache.org/legal/resolved.html and
https://infra.apache.org/licensing-howto.html
15 changes: 15 additions & 0 deletions NOTICE
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
Apache Phoenix Adapters
Copyright 2024-2026 The Apache Software Foundation

This product includes software developed at
The Apache Software Foundation (http://www.apache.org/).

-----------------------------------------------------------------------------
NOTE TO THE RELEASE MANAGER
-----------------------------------------------------------------------------
The binary distribution bundles third-party dependencies that ship their own
NOTICE files. Before calling a release vote, aggregate the required attribution
notices from every bundled dependency's NOTICE (Apache Phoenix, Apache HBase,
Apache Hadoop, Apache ZooKeeper, Apache Log4j 2, AWS SDK for Java, etc.) into
this file, per https://infra.apache.org/licensing-howto.html#mod-notice .
Only content actually required by a bundled dependency's own NOTICE belongs here.
5 changes: 5 additions & 0 deletions coverage-report/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,11 @@
<name>Phoenix Adapters - Coverage Report</name>
<description>Module dedicated to generating aggregated code coverage reports</description>

<properties>
<!-- Internal reporting aggregator; not a published release artifact. -->
<maven.deploy.skip>true</maven.deploy.skip>
</properties>

<dependencies>
<!-- Dependencies on modules we want to include in coverage -->
<dependency>
Expand Down
95 changes: 95 additions & 0 deletions dev/create-release/README.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,95 @@
Entrance script is _do-release-docker.sh_. Requires a local docker;
for example, on macOS, Docker for Desktop installed and running.

These scripts are adapted from the Apache Phoenix dev/create-release scripts
(which themselves came from HBase and originally Spark). They produce Apache
Phoenix Adapters release candidates.

For usage, pass '-h':

$ ./do-release-docker.sh -h

./do-release-docker.sh accepts the following options

-d [path] required. working directory. output will be written to "output" in here.
-f "force" -- actually publish this release. Unless you specify '-f', it will
default to dry run mode, which checks and does local builds, but does not upload anything.
-t [tag] tag for the phoenix-adapters-rm docker image to use for building (default: "latest").
-j [path] path to local JDK installation to use building. By default the script will
use openjdk8 installed in the docker image.
-p [project] project to build; defaults to the PROJECT env var (phoenix-adapters).
-r [repo] git repo to use for remote git operations. defaults to ASF gitbox for the project.
-s [step] runs a single step of the process; valid steps are: tag|publish-dist|publish-release.
If none specified, runs tag, then publish-dist, and then publish-release.
'publish-snapshot' is also an allowed, less used, option.
-h display usage information
-x debug. do less clean up. (env file, gpg forwarding on mac)

For example, use the following command to do a full dry run build:

./do-release-docker.sh -d /tmp/phoenix-adapters-build

To run a build w/o invoking docker (not recommended!), use _do-release.sh_.

Both scripts will query interactively for needed parameters and passphrases.
For explanation of the parameters, execute:
$ release-build.sh --help

Notes specific to phoenix-adapters:
* The binary distribution tarball is produced by the "phoenix-ddb-assembly" module rather than
the conventional "${PROJECT}-assembly" name. This is handled via the ASSEMBLY_MODULE environment
variable, which do-release-docker.sh and do-release.sh default to "phoenix-ddb-assembly".
* phoenix-adapters shares the PHOENIX JIRA project. By convention its "Fix Version" values are
prefixed with "adapters-" (e.g. "adapters-1.0.0"). release-build.sh uses this to generate
CHANGES.md and RELEASENOTES.md via Apache Yetus releasedocmaker.
* Release tarballs are staged under https://dist.apache.org/repos/dist/dev/phoenix/ and the RM's
signing key must be present in https://dist.apache.org/repos/dist/release/phoenix/KEYS .

Before starting the RC build, run a reconciliation of what is in
JIRA with what is in the commit log. Make sure they align and that
anomalies are explained up in JIRA.

See http://hbase.apache.org/book.html#maven.release
(Even though the above documentation is for HBase, we use the same process for Phoenix
and its sub-projects.)

Regardless of where your release build will run (locally, locally in docker, on a remote machine,
etc) you will need a local gpg-agent with access to your secret keys. A quick way to tell gpg
to clear out state and start a gpg-agent is via the following command phrase:

$ gpgconf --kill all && gpg-connect-agent /bye

Before starting an RC build, make sure your local gpg-agent has configs
to properly handle your credentials, especially if you want to avoid
typing the passphrase to your secret key.

e.g. if you are going to run and step away, best to increase the TTL
on caching the unlocked secret via ~/.gnupg/gpg-agent.conf
# in seconds, e.g. a day
default-cache-ttl 86400
max-cache-ttl 86400

In the current version, passphrase entry doesn't work at all, at least for Linux Docker builds.
Increasing the TTL only works if you unlock the key before starting the release script by running
gpg separately before the script.
A better way to handle passphrases without changing the TTLs is to preset the passphrase,
which avoids using pinentry mechanism completely, and will be reset on logout.

# Find the "gpg-preset-passphrase" program. It is not on the PATH by default.
$ find / -name gpg-preset-passphrase
# Make sure you have the "allow-preset-passphrase" line in your $HOME/.gnupg/gpg-agent.conf
# Restart gpg
$ gpgconf --kill all && gpg-connect-agent /bye
# List your keys with key grip
$ gpg --with-keygrip --list-secret-keys
# Preset the passphrase for your signing key
# </full/path/to/>/gpg-preset-passphrase -P <the passphrase> -c <the keygrip>
# Check that the passphrase is successfully preset. There should be a '1' at the fourth position
# after the keygrip for your key in the output for the signing key
$ gpg-connect-agent 'keyinfo --list' /bye
# Run the release script (see above)
# Restart the gpg agent again to make sure it forgets the preset passphrase
$ gpgconf --kill all && gpg-connect-agent /bye

Note that according to https://www.apache.org/legal/release-policy.html#owned-controlled-hardware
building an Apache release must be done on hardware owned and controlled by the committer.
1 change: 1 addition & 0 deletions dev/create-release/cache-apache-project-artifact.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
../cache-apache-project-artifact.sh
Loading
Loading