-
Notifications
You must be signed in to change notification settings - Fork 10
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.
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
GH-21: Add release CI #122
Changes from 5 commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,134 @@ | ||
# Licensed to the Apache Software Foundation (ASF) under one | ||
# or more contributor license agreements. See the NOTICE file | ||
# distributed with this work for additional information | ||
# regarding copyright ownership. The ASF licenses this file | ||
# to you 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. | ||
|
||
name: RC | ||
on: | ||
push: | ||
branches: | ||
- '**' | ||
- '!dependabot/**' | ||
tags: | ||
- '*-rc*' | ||
pull_request: | ||
concurrency: | ||
group: ${{ github.repository }}-${{ github.head_ref || github.sha }}-${{ github.workflow }} | ||
cancel-in-progress: true | ||
permissions: | ||
contents: read | ||
jobs: | ||
archive: | ||
name: Archive | ||
runs-on: ubuntu-latest | ||
timeout-minutes: 5 | ||
steps: | ||
- name: Checkout | ||
uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7 | ||
with: | ||
submodules: recursive | ||
- name: Prepare for tag | ||
if: github.ref_type == 'tag' | ||
run: | | ||
version=${GITHUB_REF_NAME%-rc*} | ||
version=${version#v} | ||
rc=${GITHUB_REF_NAME#*-rc} | ||
echo "VERSION=${version}" >> ${GITHUB_ENV} | ||
echo "RC=${rc}" >> ${GITHUB_ENV} | ||
- name: Prepare for branch | ||
if: github.ref_type == 'branch' | ||
run: | | ||
version=$(grep -o '^const PkgVersion = ".*"' "arrow/doc.go" | | ||
sed \ | ||
-e 's/^const PkgVersion = "//' \ | ||
-e 's/"$//') | ||
rc=100 | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. why There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I just want to use RC that is never used for normal RCs. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. ah, gotcha. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. OK. I'll use it. |
||
echo "VERSION=${version}" >> ${GITHUB_ENV} | ||
echo "RC=${rc}" >> ${GITHUB_ENV} | ||
- name: Archive | ||
run: | | ||
id="apache-arrow-go-${VERSION}" | ||
tar_gz="${id}.tar.gz" | ||
echo "TAR_GZ=${tar_gz}" >> ${GITHUB_ENV} | ||
git archive HEAD --prefix "${id}/" --output "${tar_gz}" | ||
sha256sum "${tar_gz}" > "${tar_gz}.sha256" | ||
sha512sum "${tar_gz}" > "${tar_gz}.sha512" | ||
- name: Audit | ||
run: | | ||
dev/release/run_rat.sh "${TAR_GZ}" | ||
- uses: actions/upload-artifact@50769540e7f4bd5e21e526ee35c689e35e0d6874 # v4.4.0 | ||
with: | ||
name: archive | ||
path: | | ||
apache-arrow-go-* | ||
verify: | ||
name: Verify | ||
needs: | ||
- archive | ||
runs-on: ${{ matrix.os }} | ||
strategy: | ||
fail-fast: false | ||
matrix: | ||
os: | ||
- macos-latest | ||
- ubuntu-latest | ||
steps: | ||
- name: Checkout | ||
uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7 | ||
with: | ||
submodules: recursive | ||
- uses: actions/download-artifact@fa0a91b85d4f404e444e00e005971372dc801d16 # v4.1.8 | ||
with: | ||
name: archive | ||
- name: Verify | ||
run: | | ||
tar_gz=$(echo apache-arrow-go-*.tar.gz) | ||
version=${tar_gz#apache-arrow-go-} | ||
version=${version%.tar.gz} | ||
if [ "${GITHUB_REF_TYPE}" = "tag" ]; then | ||
rc="${GITHUB_REF_NAME#*-rc}" | ||
else | ||
rc=100 | ||
fi | ||
VERIFY_DEFAULT=0 dev/release/verify_rc.sh "${version}" "${rc}" | ||
raulcd marked this conversation as resolved.
Show resolved
Hide resolved
|
||
env: | ||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
upload: | ||
name: Upload | ||
if: github.ref_type == 'tag' | ||
needs: | ||
- verify | ||
runs-on: ubuntu-latest | ||
permissions: | ||
contents: write | ||
steps: | ||
- name: Checkout | ||
uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7 | ||
with: | ||
submodules: recursive | ||
- uses: actions/download-artifact@fa0a91b85d4f404e444e00e005971372dc801d16 # v4.1.8 | ||
with: | ||
name: archive | ||
- name: Upload | ||
run: | | ||
# TODO: Add support for release note | ||
gh release create ${GITHUB_REF_NAME} \ | ||
--prerelease \ | ||
--title "Apache Arrow Go ${GITHUB_REF_NAME}" \ | ||
--verify-tag \ | ||
apache-arrow-go-*.tar.gz \ | ||
apache-arrow-go-*.tar.gz.sha* | ||
env: | ||
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} |
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -34,7 +34,7 @@ To build with tinygo include the noasm build tag. | |
*/ | ||
package arrow | ||
|
||
const PkgVersion = "18.0.0-SNAPSHOT" | ||
const PkgVersion = "18.0.0" | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. this doesn't have to change for this PR, only when releasing, right? or do we want this to be There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
No.
No. My suggestions:
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. sounds good to me to update just before releasing |
||
|
||
//go:generate go run _tools/tmpl/main.go -i -data=numeric.tmpldata type_traits_numeric.gen.go.tmpl type_traits_numeric.gen_test.go.tmpl array/numeric.gen.go.tmpl array/numericbuilder.gen.go.tmpl array/bufferbuilder_numeric.gen.go.tmpl | ||
//go:generate go run _tools/tmpl/main.go -i -data=datatype_numeric.gen.go.tmpldata datatype_numeric.gen.go.tmpl tensor/numeric.gen.go.tmpl tensor/numeric.gen_test.go.tmpl | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,116 @@ | ||
<!--- | ||
Licensed to the Apache Software Foundation (ASF) under one | ||
or more contributor license agreements. See the NOTICE file | ||
distributed with this work for additional information | ||
regarding copyright ownership. The ASF licenses this file | ||
to you 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. | ||
--> | ||
|
||
# Release | ||
|
||
## Overview | ||
|
||
1. Test the revision to be released | ||
2. Increment version number in `arrow/doc.go` | ||
3. Prepare RC and vote (detailed later) | ||
4. Publish (detailed later) | ||
|
||
### Prepare RC and vote | ||
|
||
Run `dev/release/release_rc.sh` on a working copy of `[email protected]:apache/arrow-go` not your fork: | ||
|
||
```console | ||
$ git clone [email protected]:apache/arrow-go.git | ||
$ dev/release/release_rc.sh ${RC} | ||
raulcd marked this conversation as resolved.
Show resolved
Hide resolved
|
||
(Send a vote email to [email protected]. | ||
You can use a draft shown by release_rc.sh for the email.) | ||
``` | ||
|
||
Here is an example to release RC1: | ||
|
||
```console | ||
$ GH_TOKEN=${YOUR_GITHUB_TOKEN} dev/release/release_rc.sh 1 | ||
``` | ||
|
||
The argument of `release_rc.sh` is the RC number. If RC1 has a problem, we'll increment the RC number such as RC2, RC3 and so on. | ||
|
||
Requirements to run `release_rc.sh`: | ||
|
||
* You must be an Apache Arrow committer or PMC member | ||
* You must prepare your PGP key for signing | ||
|
||
If you don't have a PGP key, https://infra.apache.org/release-signing.html#generate may be helpful. | ||
|
||
Your PGP key must be registered to the followings: | ||
|
||
* https://dist.apache.org/repos/dist/dev/arrow/KEYS | ||
* https://dist.apache.org/repos/dist/release/arrow/KEYS | ||
|
||
See the header comment of them how to add a PGP key. | ||
|
||
Apache arrow committers can update them by Subversion client with their ASF account. e.g.: | ||
|
||
```console | ||
$ svn co https://dist.apache.org/repos/dist/dev/arrow | ||
$ cd arrow | ||
$ editor KEYS | ||
$ svn ci KEYS | ||
``` | ||
|
||
### Publish | ||
|
||
We need to do the followings to publish a new release: | ||
|
||
* Publish to apache.org | ||
|
||
Run `dev/release/release.sh` to publish to apache.org: | ||
|
||
```console | ||
$ GH_TOKEN=${YOUR_GITHUB_TOKEN} dev/release/release.sh ${VERSION} ${RC} | ||
``` | ||
|
||
Here is an example to release 18.0.0 RC1: | ||
|
||
```console | ||
$ GH_TOKEN=${YOUR_GITHUB_TOKEN} dev/release/release.sh 18.0.0 1 | ||
``` | ||
|
||
Add the release to ASF's report database via [Apache Committee Report Helper](https://reporter.apache.org/addrelease.html?arrow). | ||
|
||
### Verify | ||
|
||
We have a script to verify a RC. | ||
|
||
You must install the following commands to use the script: | ||
|
||
* `curl` | ||
* `gpg` | ||
* `shasum` or `sha256sum`/`sha512sum` | ||
* `tar` | ||
|
||
You don't need to install Go. If Go doesn't exist in system, the latest Go is automatically installed only for verification. | ||
|
||
To verify a RC, run the following command line: | ||
|
||
```console | ||
$ dev/release/verify_rc.sh ${VERSION} ${RC} | ||
``` | ||
|
||
Here is an example to verify the release 18.0.0 RC1: | ||
|
||
```console | ||
$ dev/release/verify_rc.sh 18.0.0 1 | ||
``` | ||
|
||
If the verification is successful, the message `RC looks good!` is shown. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
should this be
${{ github.ref_type }}
?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We can omit
${{ ... }}
: https://docs.github.com/en/actions/writing-workflows/workflow-syntax-for-github-actions#jobsjob_idif